ALTER CATALOG INTEGRATION¶

Modifies the properties of an existing catalog integration.

See also:: CREATE CATALOG INTEGRATION , DESCRIBE CATALOG INTEGRATION, DROP CATALOG INTEGRATION , SHOW CATALOG INTEGRATIONS

Syntax¶

ALTER CATALOG INTEGRATION [ IF EXISTS ] <name> SET
  [ REST_AUTHENTICATION = (
      restAuthenticationParams
    ) ]
  [ DEFAULT_STORAGE_CONFIG = (
      USE_PRIVATELINK_ENDPOINT = { TRUE | FALSE }
    ) ]
  [ REFRESH_INTERVAL_SECONDS = <value> ]
  [ COMMENT = '<string_literal>' ]

Specify at least one property to change. The restAuthenticationParams are as follows, depending on your authentication method:

OAuth

restAuthenticationParams (for OAuth) ::=

  OAUTH_CLIENT_SECRET = '<oauth_client_secret>'

Bearer token

restAuthenticationParams (for Bearer token) ::=

  BEARER_TOKEN = '<bearer_token>'

Parameters¶

name

Specifies the identifier for the catalog integration to alter.

If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

For more information, see Identifier requirements.

SET ...

Sets one or more properties of the catalog integration:

DEFAULT_STORAGE_CONFIG = ( USE_PRIVATELINK_ENDPOINT = { TRUE | FALSE } )

Specifies whether Snowflake uses private connectivity to access table storage with catalog-vended credentials. Set USE_PRIVATELINK_ENDPOINT = TRUE to enable private storage access, or FALSE to use public connectivity. The catalog integration must use ACCESS_DELEGATION_MODE = VENDED_CREDENTIALS.

This setting is independent of the connection to the catalog API. For cloud requirements and endpoint setup, see Configure private connectivity to storage for catalog-vended credentials.

REFRESH_INTERVAL_SECONDS = value

Specifies the number of seconds that Snowflake waits between attempts to poll the external Iceberg catalog for metadata updates for automated refresh.

For Delta-based tables, specifies the number of seconds that Snowflake waits between attempts to poll your external cloud storage for new metadata.

Values: 30 to 86400, inclusive

Default: 30 seconds

COMMENT = 'string_literal'

String (literal) that specifies a comment for the integration.

Default: No value

REST authentication parameters (restAuthenticationParams)¶

OAuth

OAUTH_CLIENT_SECRET = oauth_client_secret
Your OAuth2 client secret.

Bearer token

BEARER_TOKEN = bearer_token
The bearer token for your identity provider. You can alternatively specify a personal access token (PAT).

Access control requirements¶

A role used to execute this operation must have the following privileges at a minimum:

Privilege	Object	Notes
OWNERSHIP	Integration (catalog)	OWNERSHIP is a special privilege on an object that is automatically granted to the role that created the object, but can also be transferred using the GRANT OWNERSHIP command to a different role by the owning role (or any role with the MANAGE GRANTS privilege).

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Usage notes¶

Regarding metadata:

Attention

Customers should ensure that no personal data (other than for a User object), sensitive data, export-controlled data, or other regulated data is entered as metadata when using the Snowflake service. For more information, see Metadata fields in Snowflake.

Examples¶

The following example updates the refresh interval for automated refresh to 30 seconds:

ALTER CATALOG INTEGRATION myCatalogIntegration SET REFRESH_INTERVAL_SECONDS = 30;

The following example enables private connectivity to table storage for a catalog integration that uses vended credentials:

ALTER CATALOG INTEGRATION horizon_catalog_int
  SET DEFAULT_STORAGE_CONFIG = (USE_PRIVATELINK_ENDPOINT = TRUE);