dbt Cloud IDE
The dbt Cloud integrated development environment (IDE) is a single interface for building, testing, running, and version-controlling dbt projects from your browser. With the Cloud IDE, you can compile dbt code into SQL and run it against your database directly. The IDE leverages the open-source dbt-rpc plugin to recompile only the changes made in your project.
To develop in the Cloud IDE, make sure you have the following:
- A dbt Cloud account and Developer seat license
- A git repository set up and git provider must have
writeaccess enabled. See Connecting your GitHub Account or Importing a project by git URL for detailed setup instructions
- A dbt project connected to a data platform
- Set up a development environment and development credentials
- The environment must be on dbt version 1.0 or higher
Cloud IDE features
The dbt Cloud IDE comes with tips and features that make it easier for you to develop, build, compile, run, and test data models.
Read more about IDE updates in the dbt Cloud release notes, and select the tag
IDE to view IDE related release notes.
|Keyboard shortcuts||You can access a variety of commands and actions in the IDE by choosing the appropriate keyboard shortcut. This includes the command palette (Command-P or Control-P), which has common shortcuts and build commands to optimize your developer workflow. For example, you can build modified models or continue the build from the last failure point.|
|File state indicators||Ability to see when changes or actions have been made to the file. The indicators M, D, A, and • appear to the right of your file or folder name and indicate the actions performed: |
- Unsaved (•) — The IDE detects unsaved changes to your file/folder
- Modification (M) — The IDE detects a modification of existing files/folders
- Added (A) — The IDE detects added files
- Deleted (D) — The IDE detects deleted files.
|IDE version control||The IDE version control section and git button allow you to apply the concept of version control to your project directly into the IDE. |
- Create or change branches
- Commit or revert individual files by right-clicking the edited file
- Resolve merge conflicts
- Execute git commands using the git button
- Link to the repo directly by clicking the branch name
|Project documentation||Generate and view your project documentation for your dbt project in real-time. You can inspect and verify what your project's documentation will look like before you deploy your changes to production.|
|Preview and Compile button||You can run your code against your data platform by clicking the Preview. Use the Compile button in the IDE to generate executable SQL, which occurs locally within dbt. |
The Preview button will display 500 rows by default, but you can change this by adding
|Build, test, and run button||Build, test, and run your project with a button click or by using the Cloud IDE command bar.|
|Command bar||You can enter and run commands from the command bar at the bottom of the IDE. Use the rich model selection syntax to execute dbt commands directly within dbt Cloud. You can also view the history, status, and logs of previous runs by clicking History on the left of the bar.|
|Drag and drop||Drag and drop files located in the file explorer, and use the file breadcrumb on the top of the IDE for quick, linear navigation. Access adjacent files in the same file by right-clicking on the breadcrumb file.|
|Organize tabs and files||- Move your tabs around to reorganize your work in the IDE |
- Right-click on a tab to view and select a list of actions to take
- Close multiple, unsaved tabs to batch save your work
- Double click files to rename files and tabs
|Find and replace||- Press Command-F or Control-F to open the find-and-replace bar in the upper right corner of the current file in the IDE. The IDE highlights your search results in the current file and code outline|
- You can use the up and down arrows to see the match highlighted in the current file when there are multiple matches
- Use the left arrow to replace the text with something else
|Multiple selections||You can make multiple selections for small and simultaneous edits. The below commands are a common way to add more cursors and allow you to insert cursors below or above with ease.|
- Option-Command-Down arrow or Ctrl-Alt-Down arrow
- Option-Command-Up arrow or Ctrl-Alt-Up arrow
- Press Option and click on an area or Press Ctrl-Alt and click on an area
|Formatting||Format your files with a click of a button, powered by sqlfmt.|
|Git diff view||Ability to see what has been changed in a file before you make a pull request.|
|dbt autocomplete||New autocomplete features to help you develop faster:|
- Start typing a hyphen (-) to use in-line autocomplete in a YAML file
|DAG in the IDE||You can see how models are used as building blocks from left to right to transform your data from raw sources into cleaned-up modular derived pieces and final outputs on the far right of the DAG. The default view is 2+model+2 (defaults to display 2 nodes away), however you can change it to +model+ (full DAG).|
- Double-click a node in the directed acyclic graph (DAG) to open that file in a new tab
- Expand the DAG and use node selection syntax (select or exclude) to view a subset of your DAG
|Status bar||This area provides you with useful information about your IDE and project status. You also have additional options like enabling light or dark mode, restarting the IDE, or recloning your repo.|
|Dark mode||From the status bar in the Cloud IDE, enable dark mode for a great viewing experience in low-light environments.|
There are three start-up states when using or launching the Cloud IDE:
- Creation start — This is the state where you are starting the IDE for the first time. You can also view this as a cold start (see below), and you can expect this state to take longer because the git repository is being cloned.
- Cold start — This is the process of starting a new develop session, which will be available for you for three hours. The environment automatically turns off three hours after the last activity with the rpc server. This includes compile, preview, or any dbt invocation, however, it does not include editing and saving a file.
- Hot start — This is the state of resuming an existing or active develop session within three hours of the last activity.
The Cloud IDE needs explicit action to save your changes. There are three ways your work is stored:
- Unsaved, local code — Any code you write is automatically available from your browser’s storage. You can see your changes but will lose them if you switch branches or browsers (another device or browser).
- Saved but uncommitted code — When you save a file, the data gets stored in your local storage (EFS storage). If you switch branches but don’t commit your saved changes, you will lose your changes.
- Committed code — This is stored in the branch with your git provider and you can check out other (remote) branches.
Access the Cloud IDE
New to dbt? Check out our quickstart guide to build your first dbt project in the Cloud IDE!
In order to start experiencing the great features of the Cloud IDE, you need to first set up a dbt Cloud development environment. In the following steps, we outline how to set up developer credentials and access the IDE. If you're creating a new project, you will automatically configure this during the project setup.
The IDE uses developer credentials to connect to your data platform. These developer credentials should be specific to your user and they should not be super user credentials or the same credentials that you use for your production deployment of dbt.
Set up your developer credentials:
- Navigate to your Credentials under Your Profile settings, which you can access at
YOUR_ACCESS_URLwith the appropriate Access URL for your region and plan.
- Select the relevant project in the list.
- Click Edit on the bottom right of the page.
- Enter the details under Development Credentials.
- Click Save.
- Access the Cloud IDE by clicking Develop at the top of the page.
- Initialize your project and familiarize yourself with the IDE and its delightful features.
Nice job, you're ready to start developing and building models 🎉!
Build, compile, and run projects
You can build, compile, run, and test dbt projects using the command bar or Build button. Use the Build button to quickly build, run, or test the model you're working on. The Cloud IDE will update in real-time when you run models, tests, seeds, and operations.
If a model or test fails, dbt Cloud makes it easy for you to view and download the run logs for your dbt invocations to fix the issue.
Use dbt's rich model selection syntax to run dbt commands directly within dbt Cloud.Preview, compile, or build your dbt project. Use the lineage tab to see your DAG.
Build and view your project's docs
The dbt Cloud IDE makes it possible to build and view documentation for your dbt project while your code is still in development. With this workflow, you can inspect and verify what your project's generated documentation will look like before your changes are released to production.
Is there a cost to using the Cloud IDE?
Can I be a contributor to dbt Cloud?
What is the difference between developing on the Cloud IDE and on the CLI?
—dbt Cloud IDE dbt Cloud is a web-based application that allows you to develop dbt projects with the IDE, includes a purpose-built scheduler, and provides an easier way to share your dbt documentation with your team. The IDE is a faster and more reliable way to deploy your dbt models and provides a real-time editing and execution environment for your dbt project.
—dbt Core CLI The command line interface (CLI) uses dbt Core, an open-source software that’s freely available. You can build your dbt project in a code editor, like Jetbrains or VSCode, and run dbt commands from the command line.