1. Getting Started
  2. Quickstart: Data observability

To start using Elementary to monitor you dbt tests, executions and data, you need to add our dbt package to your dbt project.

How to install Elementary dbt package?

Install dbt package

1. Add elementary to packages.yml

Add the following to your packages.yml file (if missing, create it where dbt_project.yml is):

packages.yml

            
              
              
            
            
          packages:
  - package: elementary-data/elementary
    version: 0.4.8
    ## compatible with Elementary CLI version 0.4.8
    ## see docs: https://docs.elementary-data.com/

2. Add to your dbt_project.yml

This means Elementary models will have their own schema.

Make sure your user has permissions to create schemas.

dbt_project.yml

            
              
              
            
            
          models:
  ## elementary models will be created in the schema '<your_schema>_elementary'
  ## see docs: https://docs.elementary-data.com/
  elementary:
    +schema: "elementary"

3. Import the package

Terminal

            
              
              
            
            
          dbt deps

4. Run to create the package models

Terminal

            
              
              
            
            
          dbt run --select elementary

This will mostly create empty tables, that will be updated with artifacts, metrics and test results in your future dbt executions.

5. Run tests

Terminal

            
              
              
            
            
          dbt test

Running your tests will populate Elementary’s models with the relevant information that is needed to monitor your data. You can also choose to run only some of your tests, but keep in mind that only tests that ran after Elementary was installed will be monitored.

After you ran your tests, we recommend that you ensure that the results were uploaded to the elementary_test_results table.

What happens now?

Once the elementary dbt package has been installed and configured, your test results, run results and dbt artifacts will be loaded to elementary schema tables.

If you see data in these models you completed the package deployment (Congrats! 🎉).

What's next?

  1. Install the Elementary CLI to:
  2. Add data anomaly detection dbt tests 📈