catalog_integrations

Creates, updates, deletes, gets or lists a catalog_integrations resource.

Overview

Name	catalog_integrations
Type	Resource
Id	snowflake.catalog_integration.catalog_integrations

Fields

Name	Datatype	Description
name	string	Name of the catalog integration.
catalog	object
category	string	Category of the integration. Always CATALOG.
comment	string	Comment.
created_on	string	Date and time when the catalog integration was created.
enabled	boolean	whether this catalog integration is available to use for Iceberg tables.
table_format	string	Table format of the catalog.
type	string	Type of the integration. Always CATALOG.

Methods

Name	Accessible by	Required Params	Optional Params	Description
fetch_catalog_integration	SELECT	name, endpoint	-	Fetch a catalog integration.
list_catalog_integrations	SELECT	endpoint	like	List catalog integrations.
create_catalog_integration	INSERT	data__catalog, data__enabled, data__name, data__table_format, endpoint	createMode	Create a catalog integration.
delete_catalog_integration	DELETE	name, endpoint	ifExists	Delete a catalog integration.

Optional Parameter Details

Name	Description	Type	Default
createMode	Query parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.	string	errorIfExists
ifExists	Query parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn't exist.	boolean	false
like	Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.	string	-

SELECT examples

List catalog integrations.

SELECT
name,
catalog,
category,
comment,
created_on,
enabled,
table_format,
type
FROM snowflake.catalog_integration.catalog_integrations
WHERE endpoint = '{{ endpoint }}';

INSERT example

Use the following StackQL query and manifest file to create a new catalog_integrations resource.

Required Properties

/*+ create */
INSERT INTO snowflake.catalog_integration.catalog_integrations (
data__name,
data__catalog,
data__table_format,
data__enabled,
data__comment,
endpoint
)
SELECT 
'{{ name }}',
'{{ catalog }}',
'{{ table_format }}',
'{{ enabled }}',
'{{ comment }}',
'{{ endpoint }}'
;

All Properties

/*+ create */
INSERT INTO snowflake.catalog_integration.catalog_integrations (
data__name,
data__catalog,
data__table_format,
data__enabled,
endpoint
)
SELECT 
'{{ name }}',
'{{ catalog }}',
'{{ table_format }}',
'{{ enabled }}',
'{{ endpoint }}'
;

Manifest

- name: catalog_integrations
  props:
    - name: data__catalog
      value: string
    - name: data__enabled
      value: string
    - name: data__name
      value: string
    - name: data__table_format
      value: string
    - name: endpoint
      value: string
    - name: name
      value: string
    - name: catalog
      props:
        - name: catalog_source
          value: string
    - name: table_format
      value: string
    - name: enabled
      value: boolean
    - name: comment
      value: string

DELETE example

Deletes the specified catalog_integrations resource.

/*+ delete */
DELETE FROM snowflake.catalog_integration.catalog_integrations
WHERE name = '{{ name }}'
AND endpoint = '{{ endpoint }}';