Categories:

System functions (System Control)

SYSTEM$SET_CATALOG_INTEGRATION¶

Replaces the catalog integration associated with an externally managed Apache Iceberg™ table.

Use this function to update a table to work with an Iceberg REST catalog integration, which supports a wider range of Iceberg features, such as write support for externally managed Iceberg tables. You might also use this function to roll back to the original Glue catalog integration, if needed.

You can also use this function to migrate your table from one Iceberg REST catalog integration to another.

Syntax¶

SYSTEM$SET_CATALOG_INTEGRATION(
  '<table_name>' ,
  '<new_catalog_integration_name>'
)

Arguments¶

'table_name'

Name of the Iceberg table whose catalog integration you want to replace.

'new_catalog_integration_name'

Name of the catalog integration that you want to migrate the given table_name to.

Returns¶

The function returns a status message that the catalog integration for the table is successfully migrated. For an example, see Examples.

Access control requirements¶

Usage notes¶

• You can only replace the catalog integration for externally managed Iceberg tables in a standard Snowflake database. You can’t replace the catalog integration for Iceberg tables in a catalog-linked database or replace the catalog integration for any other type of Iceberg table.

• The type of the current catalog integration associated with the table restricts the types of catalog integrations that you can use as a replacement. The following table lists the supported transitions when you replace one type of catalog integration with another:

  Current catalog integration type	New catalog integration type	Notes
  AWS Glue	AWS Glue Iceberg REST
  AWS Glue Iceberg REST	AWS Glue	Fall back to a catalog integration that uses an AWS Glue catalog source.
  Iceberg REST	Iceberg REST	Migrate the table to an alternative catalog integration.
  No other transition combinations are supported.

  Expand

  Show lessSee more

• table_name and new_catalog_integration_name are string literals, so you must include the values in single quotes.

• Both the current and target catalog integrations must point to the same external catalog.

• Both the current and target catalog integrations can’t have credential vending enabled.

Examples¶

Replace the AWS Glue catalog integration associated with an Iceberg table named glue_table with an AWS Glue Iceberg REST catalog integration named glue_rest_catalog_int:

SELECT SYSTEM$SET_CATALOG_INTEGRATION('glue_table', 'glue_rest_catalog_int');

Sample output:

+------------------------------------------------------------------------------------------------------------------------------+
|                                                SYSTEM$SET_CATALOG_INTEGRATION                                                |
+------------------------------------------------------------------------------------------------------------------------------+
| Catalog integration for table GLUE_TABLE has been migrated from 'GLUE_CATALOG_INTEGRATION' to 'GLUE_REST_CATALOG_INT'        |
+------------------------------------------------------------------------------------------------------------------------------+

Troubleshooting¶

If the function fails, it returns an error response. Common error messages include: