Adding a dbt project

Adding a dbt project#

To run, schedule and monitor your dbt project executions in Adverity, you need to add the dbt project and configure the connection settings.

Prerequisites#

Note

This feature is available only to users with Administrator permissions in the root workspace of your organization.

Before you complete the procedure in this guide, perform all the following actions:

  • Create a Git repository for your dbt project. For more information, see the dbt documentation.

  • Ensure you have permissions to add deploy keys to your repository.

  • Set up a data warehouse destination in Adverity with a valid authorization. For more information, see Setting up destinations.

Adding your dbt project to Adverity#

To add your dbt project to Adverity, follow these steps:

  1. Go to the dbt Projects page.

  2. Click + Create project.

  3. In Name, enter a name for your project in Adverity. It does not have to match your repository name.

  4. In Warehouse, select a data warehouse from your existing Adverity destinations where your dbt transformations will be applied. Adverity will automatically create a profiles.yml file to connect to the warehouse during the dbt run.

    To use your own profiles.yml file, select this option in the drop-down.

  5. In Git repository SSH URL, enter the SSH URL of the repository with your dbt project.

  6. Copy the Adverity public key and add it to your Git repository as a deploy key. Read-only access is sufficient.

  7. Click Create.

To configure additional parameters, open your created project and adjust the settings.

Editing the dbt project connection to Adverity#

To update the details of how your dbt project is connected to Adverity, follow these steps:

  1. Go to the dbt Projects page.

  2. Click on the name of the dbt project that you want to update.

  3. In the Credentials section, modify the following fields if necessary:

    Git repository SSH URL

    Click image1 Edit and enter the new SSH URL.

    Public key

    Click image2 Copy to copy the key to the clipboard and then add it to your Git repository as a deploy key.

    Warehouse

    Click image1 Edit and select the data warehouse that you want to use or switch to using your own profiles.yml file.

    Path to dbt_project.yml

    Click image1 Edit and enter the path to the configuration file in your repository.

    If no path is provided, Adverity automatically searches for the file by walking the repository tree from the root. For more information, see Repository cloning.

    Warning

    Your dbt_project.yml must contain a profile property. If this property is missing, the job run will fail. For more information, see profiles.yml configuration.

    Git branch

    Click image1 Edit and select the branch you want to use for dbt runs.

    If no branch is selected, the default branch from the repository will automatically be used.

Removing a dbt project from Adverity#

To remove a dbt project from Adverity, follow these steps:

  1. Go to the dbt Projects page.

  2. In the Projects table, find the project that you want to remove.

  3. Click image3 Select an action in a specific project’s row.

  4. Click image4 Delete.

As a result, this project is removed from Adverity. This action does not affect the Git repository of the project.

If you encounter any issues, see dbt troubleshooting.

Contents