SNOW-1794369 Catalog API

CHANGELOG.md

@@ -7,6 +7,7 @@
 #### New Features
 
 - Added support for property `version` and class method `get_active_session` for `Session` class.
+- Added `Catalog` class to manage snowflake objects. It can be accessed via `Session.catalog`.
 - Added new methods and variables to enhance data type handling and JSON serialization/deserialization:
   - To `DataType`, its derived classes, and `StructField`:
     - `type_name`: Returns the type name of the data.

docs/source/snowpark/catalog.rst

@@ -0,0 +1,69 @@
+=============
+Catalog
+=============
+Catalog module for Snowpark.
+
+.. currentmodule:: snowflake.snowpark.catalog
+
+.. rubric:: Catalog
+
+.. autosummary::
+    :toctree: api/
+
+    Catalog.databaseExists
+    Catalog.database_exists
+    Catalog.dropDatabase
+    Catalog.dropSchema
+    Catalog.dropTable
+    Catalog.dropView
+    Catalog.drop_database
+    Catalog.drop_schema
+    Catalog.drop_table
+    Catalog.drop_view
+    Catalog.getCurrentDatabase
+    Catalog.getCurrentSchema
+    Catalog.getProcedure
+    Catalog.getTable
+    Catalog.getUserDefinedFunction
+    Catalog.getView
+    Catalog.get_current_database
+    Catalog.get_current_schema
+    Catalog.get_procedure
+    Catalog.get_table
+    Catalog.get_user_defined_function
+    Catalog.get_view
+    Catalog.listColumns
+    Catalog.listDatabases
+    Catalog.listProcedures
+    Catalog.listSchemas
+    Catalog.listTables
+    Catalog.listUserDefinedFunctions
+    Catalog.listViews
+    Catalog.list_columns
+    Catalog.list_databases
+    Catalog.list_procedures
+    Catalog.list_schemas
+    Catalog.list_tables
+    Catalog.list_user_defined_functions
+    Catalog.list_views
+    Catalog.procedureExists
+    Catalog.procedure_exists
+    Catalog.schemaExists
+    Catalog.schema_exists
+    Catalog.setCurrentDatabase
+    Catalog.setCurrentSchema
+    Catalog.set_current_database
+    Catalog.set_current_schema
+    Catalog.tableExists
+    Catalog.table_exists
+    Catalog.userDefinedFunctionExists
+    Catalog.user_defined_function_exists
+    Catalog.viewExists
+    Catalog.view_exists
+    .. Catalog.functionExists
+    .. Catalog.function_exists
+    .. Catalog.getFunction
+    .. Catalog.get_function
+    .. Catalog.listFunctions
+    .. Catalog.list_functions
+

docs/source/snowpark/index.rst

@@ -9,9 +9,9 @@ Snowpark APIs
    column
    types
    row
-   functions 
-   window 
-   grouping 
+   functions
+   window
+   grouping
    table_function
    table
    async_job
@@ -21,6 +21,7 @@ Snowpark APIs
    udtf
    observability
    files
+   catalog
    lineage
    context
    exceptions

docs/source/snowpark/session.rst

@@ -38,6 +38,7 @@ Snowpark Session
       Session.append_query_tag
       Session.call
       Session.cancel_all
+      Session.catalog
       Session.clear_imports
       Session.clear_packages
       Session.close

recipe/meta.yaml

@@ -43,6 +43,7 @@ requirements:
     # Snowpark IR
     - protobuf >=3.20,<6
     - tzlocal
+    - snowflake >=1.0.0,<2
 
 test:
   imports:

setup.py

@@ -29,6 +29,7 @@
     # `protoc` < 3.20 is not able to generate protobuf code compatible with protobuf >= 3.20.
     "protobuf>=3.20, <6",  # Snowpark IR
     "tzlocal",  # Snowpark IR
+    "snowflake>=1.0.0, <2",  # Catalog
 ]
 REQUIRED_PYTHON_VERSION = ">=3.8, <3.12"