catalog_integrations

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

Overview

Name	catalog_integrations
Type	Resource
Id	snowflake.integrations.catalog_integrations

Fields

The following fields are returned by SELECT queries:

get

successful

Name	Datatype	Description
name	string	Name of the catalog integration. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
catalog	object	Type of catalog and its parameters.
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. (ICEBERG)
type	string	Type of the integration. Always CATALOG.

list

Catalog integration

Name	Datatype	Description
name	string	Name of the catalog integration. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
catalog	object	Type of catalog and its parameters.
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. (ICEBERG)
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
get	select	name, endpoint		Fetch a catalog integration.
list	select	endpoint	like	List catalog integrations.
create	insert	endpoint, name, catalog, table_format, enabled	createMode	Create a catalog integration.
delete	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 identifier (orgname-accountname) (default: orgname-accountname)
name	string	Identifier (i.e. name) for the resource.
createMode	string	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	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	Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

SELECT examples

get

Fetch a catalog integration.

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

list

List catalog integrations.

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

INSERT examples

create

Create a catalog integration.

INSERT INTO snowflake.integrations.catalog_integrations (
name,
catalog,
table_format,
enabled,
comment,
endpoint,
createMode
)
SELECT 
'{{ name }}' /* required */,
'{{ catalog }}' /* required */,
'{{ table_format }}' /* required */,
{{ enabled }} /* required */,
'{{ comment }}',
'{{ endpoint }}',
'{{ createMode }}'
RETURNING
status
;

Manifest

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

Delete a catalog integration.

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