Skip to main content

Sync Back to Coalesce

Learn how to sync table and column descriptions from Catalog to Coalesce Transform and Snowflake.

Why Sync Back?​

Sync back lets you document in Catalog and propagate those descriptions to your transformation layer. Here is what you get:

  1. Use Catalog to efficiently write table and column descriptions.
  2. Automatically push these to Coalesce Transform and Snowflake.
  3. Keep all descriptions in sync.

Requirements for Opening a Merge Request to Your Git Repo​

Before requesting a sync back, you must grant Catalog access to your Git repositories. Choose your provider below.

For GitHub​

For GitLab​

  • We need a Project Access Token (PAT) to your GitLab repository. For more information, see create a project access token
  • In token configuration the only scope needed is write_repository and Contributor role must be selected so we can push a new branch with the updates
  • The token should then be sent to our support either through the support team or Slack alongside the URL needed to clone the repository

How to Sync Back​

Admin Only

Only Catalog admins can request a sync back.

You need to have set up your Git repository access. See the setup guide for instructions.

Set Up Git Repository Access

Request the Sync​

Request the sync from the integrations page.

Integrations page with Request sync back button

In the Catalog app, on the integration list page, click the Request sync back button. The Coalesce support team will run the sync back process in the next 24 hours and reach out to you.

What Happens Under the Hood?​

When you request a sync back from the Catalog, it will:

  • Create a new branch in your Coalesce Transform Git repositories
  • Push to this branch any table or column descriptions in the Catalog but not yet on the Coalesce Transform Nodes

Review the Changes​

When the branch is ready to review, the support team will share the branch name and optional GitHub branch URL. Now you only have to:

  • Open your favorite Coalesce Transform Workspace
  • Checkout the branch
  • Review the last commit

Merge Them​

This is the classic merge and deploy step you would take to deploy, except this time you will add descriptions to Snowflake assets.

  • Merge the branch into your production branch
  • Deploy again