Skip to main content

Sync Back to Snowflake

Push documentation from Catalog to your Snowflake instance. You can sync table and column descriptions (comments) so they appear natively in Snowflake.

Requirements​

You need a Catalog managed Snowflake integration to push back information to Snowflake. Configure it first if you haven't already.

What Can You Sync Back to Snowflake?​

The Snowflake Sync back feature pushes descriptions to your tables and columns in Snowflake. In Snowflake, these appear as comments on the corresponding objects.

How to Sync Back to Snowflake​

To request a sync:

  1. Go to Settings and open the Integration tab.
  2. Click Sync back to Snowflake.
The list of available Sync back options depends on which technologies you are integrated with in Catalog

How it works:

  1. Write descriptions in Catalog for your tables and columns.
  2. Request a Sync back to Snowflake from the Integration tab.
  3. Within up to 1 business day, receive an email from Coalesce Support with:
    • A description comparison file listing the objects whose descriptions were modified in Catalog, as well as their current values in Snowflake.
    • A SQL script that can be executed in Snowflake to add the descriptions.
  4. Review the comparison file to confirm the proposed description changes.
  5. Execute the provided SQL script in Snowflake to apply the description updates.

What Happens If a Description Already Exists in Snowflake?​

Catalog does not overwrite existing descriptions in Snowflake. If a table or column already has a comment, Catalog leaves it unchanged.

You can still write and store a different description in Catalog. Once you delete the existing description in Snowflake, a Sync back will push the description from Catalog to Snowflake.

Do You Need To Provide Additional Access?​

No. The permission level of your existing Snowflake integration stays the same. No extra access is required for Sync back.

What's Next?​