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

The following fields are returned by SELECT queries:

list_catalog_integrations

Catalog integration

Name	Datatype	Description
name	string	Name of the catalog integration. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
catalog	object
category	string	Category of the integration. Always CATALOG.
comment	string	Comment.
created_on	string (date-time)	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.

fetch_catalog_integration

Catalog integration

Name	Datatype	Description
name	string	Name of the catalog integration. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
catalog	object
category	string	Category of the integration. Always CATALOG.
comment	string	Comment.
created_on	string (date-time)	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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_catalog_integrations	select	endpoint	like	List catalog integrations.
fetch_catalog_integration	select	name, endpoint		Fetch a catalog integration.
create_catalog_integration	insert	endpoint	createMode	Create a catalog integration.
delete_catalog_integration	delete	name, endpoint	ifExists	Delete a catalog integration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	Organization and Account Name (default: orgid-acctid)
name	string	Identifier (i.e. name) for the resource.
createMode	string	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.
ifExists	boolean	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.
like	string	Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

SELECT examples

list_catalog_integrations

List catalog integrations.

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

fetch_catalog_integration

Fetch a catalog integration.

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

INSERT examples

create_catalog_integration

Create a catalog integration.

INSERT INTO snowflake.catalog_integration.catalog_integrations (
data__name,
data__catalog,
data__table_format,
data__enabled,
data__comment,
endpoint,
createMode
)
SELECT 
'{{ name }}' --required,
'{{ catalog }}' --required,
'{{ table_format }}' --required,
{{ enabled }} --required,
'{{ comment }}',
'{{ endpoint }}',
'{{ createMode }}'
;

Manifest

# Description fields are for documentation purposes
- name: catalog_integrations
  props:
    - name: endpoint
      value: string
      description: Required parameter for the catalog_integrations resource.
    - name: name
      value: string
      description: >
        Name of the catalog integration.
        
    - name: catalog
      value: object
    - name: table_format
      value: string
      description: >
        Table format of the catalog.
        
      valid_values: ['ICEBERG']
    - name: enabled
      value: boolean
      description: >
        whether this catalog integration is available to use for Iceberg tables. 
        
    - name: comment
      value: string
      description: >
        Comment.
        
    - name: createMode
      value: string
      description: 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.

DELETE examples

delete_catalog_integration

Delete a catalog integration.

DELETE FROM snowflake.catalog_integration.catalog_integrations
WHERE name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND ifExists = '{{ ifExists }}';