dbt - Documentation

dbt Cloud Quickstart

dbt Cloud

The functionality documented here is available in dbt Cloud. Don't have an account? You can get started for free here.

Connect a repository

dbt Cloud plugs directly into your version control system (GitHub, GitLab, BitBucket, etc) to pull the latest version of your dbt project. To connect a repository to your dbt Cloud account, first navigate to the Repositories Page in the app sidebar. From the Repositories page, click the "New Repository" button to begin adding a new Repository.

If you've installed the dbt Cloud application in your GitHub account, then you will be able to select a repo from your GitHub org using this interface. If you're not using GitHub, or if you haven't installed the integration yet, you can optionally connect a git repository by providing a git URL from the "Git URL" tab.

Adding a new repository from GitHub

Adding a new repository from GitHub

Create a connection

dbt Cloud uses Connections to connect to your database when running dbt jobs. Depending on the type of data warehouse you're using, you'll need to supply different configuration parameters.

To create a new Connection, click the Connections link in the left sidebar. From here, click the "New Connection" button to begin creating a new Connection. Next, pick your desired data warehouse type from the type dropdown.

After picking a data warehouse type, a form will be generated which you can populate with your warehouse's credentials. These credentials are encrypted at rest, and dbt Cloud never stores credentials in plaintext.

An example connection for a Redshift data warehouse

An example connection for a Redshift data warehouse

Create an environment

Environments specify the information required to run dbt jobs for your project. For information about configuring a Development environment, see creating a development environment.

Scheduled dbt jobs can be configured in Deployment environments. These deployment environments must be configured with deployment credentials. Unlike Development credentials which run with the permissions of a human being, deployment credentials should be configured with a service account database user. We recommend configuring deployment environments to run as a user named dbt_cloud (or similar) in your database.

To create an Environment, navigate to the Environments page, and then click the "New Environment" button. On this page, you can specify the dbt version and custom branch (if applicable) that dbt Cloud should use to build your project. Additionally, the deployment credentials for the Environment can be configured on this page.

Creating a new connection

Creating a new connection

Create a new job

Now that dbt Cloud is able to clone your dbt repo and connect to your warehouse, you're ready to create a new job! To create a job, navigate to the Job page from the left sidebar, then click the "New Job" button. In the job creation interface, you can specify the environment that the job should use, as well as commands and configuration for your new job.

An example job definition

An example job definition

Job schedules can be configured from the job creation interface. You can either schedule your job using the visual editor, or you can enter a custom cron syntax for your job.

Setting a job schedule

Setting a job schedule

Updated about a month ago

dbt Cloud Quickstart


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.