Configure Sigma for dbt (Beta)

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.

This feature is currently in beta.

  • To request access, contact your Sigma Account Representative.
  • Beta features are subject to quick, iterative changes. As a result, this document may not reflect the most current version.

Summary of Content

Requirements
dbt Data
Configuration
Remove dbt

Requirements

  • To configure dbt jobs to integrate with Sigma, you must be an organization Admin.
  • Creators with table access can view dbt data. 

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).

Configuration

Complete the steps below to create and configure a connection to dbt.

  1. Open your Admin Portal by selecting Administration in the user menu at the top right of your screen.
  2. On the Account tab, scroll down to the Integrations section. Click Add, to the right of dbt. 

    company apps
  3. In the dbt admin portal, find the dbt Job IDs that you want to integrate into Sigma. To locate these in the dbt admin portal, go to the Deploy dropdown menu > select/search for a job > copy the job ID. 
  4. On the dbt Integration page, enter your dbt API key. To get your key, see Get your dbt Cloud API key. In the field below, enter the dbt jobs from step 3 that you want to integrate into Sigma. Format this field as a comma-separated list of integers.  

    company apps
  5. Click Create
  6. On the dbt tab, you can view the metadata for the  dbt job, columns, and tables. 

    company apps

  7. 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. 

    company apps

Remove dbt

Once you have successfully integrated your dbt jobs with Sigma, you will see the option to Remove the integration.

  company apps