Configure dbt Integration
This article provides instructions on how to integrate dbt jobs with Sigma. You can access the docs & metadata generated from dbt jobs directly in Sigma.
Some of the benefits of this integration Sigma are:
- Data freshness: The dbt job execution data is displayed in Sigma which allows you to verify the freshness of the data.
- Data quality: You can view dbt quality tests on columns and models in Sigma, which provides a greater degree of transparency into data quality issues.
- Data cataloging: The dbt table and column descriptions are displayed in Sigma, providing users with additional insights into the data they will explore.
Summary of Content
- To configure dbt jobs to integrate with Sigma, you must be an organization Admin.
- Creators with table access can view dbt data.
The dbt metadata available in Sigma is:
- Table Description- Provides dbt-source information about the table view.
- Column Description- Provides dbt-source information about the column views.
- Last Refresh Time- You can view the Last Modified date to verify when that model ran, which is when the data was last updated.
- Tests- Tests are assertions made about your models and other resources in your dbt project (e.g. sources, seeds and snapshots).
Complete the steps below to create and configure a connection to dbt.
- Open your Admin Portal by selecting Administration in the user menu at the top right of your screen.
- On the Account tab, scroll down to the Integrations section. Click Add, to the right of dbt.
- On the dbt Integration page, enter your dbt API key. To get your key, see Get your dbt Cloud API key.
Note: your token will need to have at least read access to the dbt account, e.g.
Read-Onlyfor Team plans and
account viewerfor Enterprise plans. Refer to the dbt service account tokens documentation for more information.
- Click Save.
- On the dbt tab, you can view the metadata for the dbt job, columns, and tables.
- In the Details section, you can view the metadata for the Model you integrated. The Last Modified field allows you to verify the freshness of the dbt job.
Once you have successfully integrated your dbt jobs with Sigma, you will see the option to Remove the integration.