Set up a development environment

Prerequisites

  • Users must configure the dbt project’s Git repository to access the Console page.

  • Users must configure the development environment to start working on the Console.

Once you have set up the dbt project, you can begin writing and testing dbt models using the development environment without affecting production data. To set up your development environment for a dbt project on your 5X workspace, follow the steps below:

  1. Navigate to Console on 5X Managed dbt Core™. You can view the project files on the file explorer and start working on the dbt models after configuring the development environment. Click Create an environment on the Console page.

Alternatively, you can also navigate to the Environments and click Create environment to add a development environment.

  1. Configure the general settings and development credentials of the development environment:

  • General settings: Enter the development environment name, select the dbt version and the target name. Setting the default target will mean dbt will access the default target named dev and the modified changes will be built in your development target. Users can check the target-path directory from the dbt_project.yml project file on the Console. The target-path directory stores compiled SQL files.

  • Development credentials: Enter the development credentials required for the 5X managed dbt core instance to build on top of the warehouse connection. The development credentials depend on the warehouse connection set up for the dbt project.

Development credentials depend on the dbt project connection. General settings parameters are common across all configurations. The development credentials have the following parameters:

  • Snowflake connection: The required parameters are the same as when setting up a snowflake connection for the project. Refer to Parameters to check the specifications. Users can also select the authentication type from Password or Key Pair. Key pair authentication ​​uses a public-private key pair to establish secure connections, eliminating the need for passwords. This ensures a private key is securely stored, while the public key is shared with the server. You can also opt to add private key passphrase.

  • Databricks connection: The parameters are the same as required when you set up a Databricks connection for the project. Refer to Parameters to check the specifications.

  • Google BigQuery connection: The required parameters are the same as when you set up a Google BigQuery connection for the project.

Click Save to set up your development environment. You can check and update the development environment from Environments or project settings.

dbt project is successfully set up with the required environment configurations, you can work on your 5X dbt project on Console in a development environment. The project is updated on the main (read-only) branch. Create a new branch to modify models. You can also run dbt commands from the dbt command terminal.

Run projects using Jobs in the deployment environment. Deploy and run a job or schedule a job run to run your dbt project in production. To create a job, refer to Create a Job. Learn to manage your job runs from Manage Job Run.

Last updated