You are viewing documentation about an older version (1.27.0). View latest version

Catalog¶

Catalog module for Snowpark.

Catalog

Catalog.databaseExists(database)

Check if the given database exists.

Catalog.database_exists(database)

Check if the given database exists.

Catalog.dropDatabase(database)

Drop the given database.

Catalog.dropSchema(schema, *[, database])

Drop the given schema in the given database.

Catalog.dropTable(table, *[, database, schema])

Drop the given table in the given database and schema.

Catalog.dropView(view, *[, database, schema])

Drop the given view in the given database and schema.

Catalog.drop_database(database)

Drop the given database.

Catalog.drop_schema(schema, *[, database])

Drop the given schema in the given database.

Catalog.drop_table(table, *[, database, schema])

Drop the given table in the given database and schema.

Catalog.drop_view(view, *[, database, schema])

Drop the given view in the given database and schema.

Catalog.getCurrentDatabase()

Get the current database.

Catalog.getCurrentSchema()

Get the current schema.

Catalog.getDatabase(database)

Name of the database to get

Catalog.getProcedure(procedure_name, ...[, ...])

Get the procedure by name and argument types in given database and schema.

Catalog.getSchema(schema, *[, database])

Name of the schema to get.

Catalog.getTable(table_name, *[, database, ...])

Get the table by name in given database and schema.

Catalog.getUserDefinedFunction(udf_name, ...)

Get the user defined function by name and argument types in given database and schema.

Catalog.getView(view_name, *[, database, schema])

Get the view by name in given database and schema.

Catalog.get_current_database()

Get the current database.

Catalog.get_current_schema()

Get the current schema.

Catalog.get_database(database)

Name of the database to get

Catalog.get_procedure(procedure_name, ...[, ...])

Get the procedure by name and argument types in given database and schema.

Catalog.get_schema(schema, *[, database])

Name of the schema to get.

Catalog.get_table(table_name, *[, database, ...])

Get the table by name in given database and schema.

Catalog.get_user_defined_function(udf_name, ...)

Get the user defined function by name and argument types in given database and schema.

Catalog.get_view(view_name, *[, database, ...])

Get the view by name in given database and schema.

Catalog.listColumns(table_name, *[, ...])

List columns in the given table.

Catalog.listDatabases(*[, pattern, like])

List databases in the current session.

Catalog.listProcedures(*[, database, ...])

List of procedures in the given database and schema.

Catalog.listSchemas(*[, database, pattern, like])

List schemas in the current session.

Catalog.listTables(*[, database, schema, ...])

List tables in the current session.

Catalog.listUserDefinedFunctions(*[, ...])

List of user defined functions in the given database and schema.

Catalog.listViews(*[, database, schema, ...])

List views in the current session.

Catalog.list_columns(table_name, *[, ...])

List columns in the given table.

Catalog.list_databases(*[, pattern, like])

List databases in the current session.

Catalog.list_procedures(*[, database, ...])

List of procedures in the given database and schema.

Catalog.list_schemas(*[, database, pattern, ...])

List schemas in the current session.

Catalog.list_tables(*[, database, schema, ...])

List tables in the current session.

Catalog.list_user_defined_functions(*[, ...])

List of user defined functions in the given database and schema.

Catalog.list_views(*[, database, schema, ...])

List views in the current session.

Catalog.procedureExists(procedure[, ...])

Check if the given procedure exists in the given database and schema.

Catalog.procedure_exists(procedure[, ...])

Check if the given procedure exists in the given database and schema.

Catalog.schemaExists(schema, *[, database])

Check if the given schema exists in the given database.

Catalog.schema_exists(schema, *[, database])

Check if the given schema exists in the given database.

Catalog.setCurrentDatabase(database)

Set the current default database for the session.

Catalog.setCurrentSchema(schema)

Set the current default schema for the session.

Catalog.set_current_database(database)

Set the current default database for the session.

Catalog.set_current_schema(schema)

Set the current default schema for the session.

Catalog.tableExists(table, *[, database, schema])

Check if the given table exists in the given database and schema.

Catalog.table_exists(table, *[, database, ...])

Check if the given table exists in the given database and schema.

Catalog.userDefinedFunctionExists(udf[, ...])

Check if the given user defined function exists in the given database and schema.

Catalog.user_defined_function_exists(udf[, ...])

Check if the given user defined function exists in the given database and schema.

Catalog.viewExists(view, *[, database, schema])

Check if the given view exists in the given database and schema.

Catalog.view_exists(view, *[, database, schema])

Check if the given view exists in the given database and schema.