Page cover

Sync back to Coalesce

Document in the catalog and get it propagated to your Coalesce Nodes! When you request a sync bac will create a new branch in your git repositories and push to it all descriptions added on the Catalog

Why sync back?

  1. Use the catalog efficiency to write tables and columns descriptions.

  2. Automatically push these to Coalesce Transform and Snowflake.

  3. Keep all descriptions in sync.

Requirements: Allow to open a Merge Request to your Git Repo

For Github:

  • We only need you to grant contributor access to our technical Github user techcastor to your main Coalesce Github repository so we can push a new branch with the updates. For more details on this check here

  • Works with both dbt Core and dbt Cloud, as long as the underlying git repo is on Github

For Gitlab:

  • We need a Project Access Token (PAT) to your dbt Gitlab repository, more information here

  • 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 [email protected] or Slack alongside the HTTP needed to clone the repository

How to sync back

Only Catalog admins can request a sync back.

You need to have set up your Git repository access, see how to here:

Set Up

Request the sync

Do it from this page: https://app.castordoc.com/settings/integrations

In the catalog app, on the integration list page, click the "Request sync back" button. A Coalesce Support will run the sync back process in the next 24 hours and reach back 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 Tranform 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 suppport 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'll just add descriptions to snowflake assets.

  • Merge the branch into your production branch

  • Deploy again

Last updated

Was this helpful?