dbt - Documentation

Using the dbt IDE

The dbt Integrated Development Environment (IDE) is a single interface for building, testing, running, and version controlling dbt projects. The IDE is currently in an open beta until 2020 - during this time, we encourage you to use the IDE and share your feedback with the dbt Cloud team.

Requirements

Creating a development environment

New dbt Cloud accounts will automatically be created with a Development Environment for the project created during setup. If you have an existing dbt Cloud account, you may need to create a Development Environment manually to use the dbt IDE.

To create a Development Environment, navigate to the Environments page for your Project and click the "New Environment" button.

Creating a new environment for the Analytics project

Creating a new environment for the Analytics project

To create a Development Environment, change the environment "type" to "development". Enter a name like "Dev" for the environment to help identify it amongst your other environments. Finally, click "Save" to finish creating your Development Environment.

Creating a development environment

Creating a development environment

Setting up developer credentials

The IDE uses developer credentials to connect to your database. These developer credentials should be specific to your user. They should not be super user credentials, or the same credentials that you use for your production deployment of dbt.

New dbt Cloud accounts should have developer credentials created automatically as a part of Project creation in the initial application setup.

Developer credentials are created during project setup

Developer credentials are created during project setup

Existing accounts may not have development credentials configured already. To manage your development credentials, navigate to your Profile in dbt Cloud and find the relevant Project under the Credentials header. After entering your developer credentials, you'll be able to access the dbt IDE.

Configure developer credentials in your Profile.

Configure developer credentials in your Profile.

Compiling and running SQL

This video explores entering the IDE and compiling and running SQL for a dbt project.

Running dbt projects

This video explores running dbt projects in the dbt IDE. For a full list of the commands that can be run in the IDE, consult the dbt Command reference.

Version control

This videos explores version controlling changes to dbt projects with git in the dbt IDE.

Using the dbt IDE


Suggested Edits are limited on API Reference Pages

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