Skip to main content

Sync back to dbt

Now that you've documented your tables and columns in the Catalog, you can sync those descriptions back to your dbt YAML files.

Requirements

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

For GitHub

  • We only need you to grant contributor access to our technical GitHub user techcastor to your dbt GitHub repository so we can push a new branch with the updates. For more details, see managing teams and people with access to your repository
  • The GitHub user is available on the GitHub user page
  • Works with both dbt Core and dbt Cloud, as long as the underlying Git repository is on GitHub

For GitLab

  • We need a Project Access Token (PAT) to your dbt 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

Request the sync from the integrations page, then review the new branch when it appears.

Step 1: Request the Sync

On the integration page, click the Request sync back button.

Integrations page with Request sync back button
GitHub Access Required

If you haven't granted GitHub access prior to clicking the button, the Catalog team will reach out.

Step 2: Review the New Branch

A new branch called castor-sync-back will appear on your repository within 24 hours.

New castor-sync-back branch in repository