Connecting to dbt Cloud¶
After installing the dbt Cloud provider in your Airflow environment, the corresponding connection type of
dbt_cloud will be made available. The following describes how to configure an API token and optionally
provide an Account ID for your dbt Cloud connection.
Default Connection ID¶
All hooks and operators related to dbt Cloud use
dbt_cloud_default by default.
Authenticating to the dbt Cloud API¶
Configuring the connection¶
- Password (required)
The API token to use when authenticating to the dbt Cloud API.
If using the Connection form in the Airflow UI, the token can also be stored in the "API Token" field.
- Login (optional)
The Account ID to be used as the default Account ID for dbt Cloud operators or
DbtCloudHookmethods. If an Account ID is provided in the connection, you are not required to pass
account_idto operators or hook methods. The
account_idvalue will be retrieved from the Airflow connection instead. If needed, the
account_idcan still be explicitly passed to an operator or hook method as an override the default value configured in the connection.
If using the Connection form in the Airflow UI, the Account ID can also be stored in the "Account ID" field.
If an Account ID is not provided in an Airflow connection,
account_idmust be explicitly passed to an operator or hook method.
When specifying the connection as an environment variable, you should specify it following the standard syntax of a database connection. Note that all components of the URI should be URL-encoded.
For example, to add a connection with the connection ID of "dbt_cloud_default":
When specifying an Account ID:export AIRFLOW_CONN_DBT_CLOUD_DEFAULT='dbt-cloud://account_id:api_token@'
When not specifying an Account ID:export AIRFLOW_CONN_DBT_CLOUD_DEFAULT='dbt-cloud://:api_token@'
You can refer to the documentation on creating connections via environment variables for more information.