https://github.com/dbt-labs/dbt-project-evaluator

This package contains macros and models to find DAG issues automatically
https://github.com/dbt-labs/dbt-project-evaluator

dbt-packages

Last synced: 5 days ago
JSON representation

This package contains macros and models to find DAG issues automatically

• Host: GitHub
• URL: https://github.com/dbt-labs/dbt-project-evaluator
• Owner: dbt-labs
• License: apache-2.0
• Created: 2022-01-07T16:15:09.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T06:56:08.000Z (4 months ago)
• Last Synced: 2024-10-25T02:14:40.122Z (4 months ago)
• Topics: dbt-packages
• Language: Shell
• Homepage: https://dbt-labs.github.io/dbt-project-evaluator/latest/
• Size: 4.63 MB
• Stars: 442
• Watchers: 7
• Forks: 65
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-dbt - dbt-project-evaluator - This package highlights areas of a dbt project that are misaligned with dbt Labs' best practices. (Packages)

README

        
# dbt_project_evaluator

This package highlights areas of a dbt project that are misaligned with dbt Labs' best practices.

Specifically, this package tests for:

1. __[Modeling](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/modeling/)__ - your dbt DAG for modeling best practices

2. __[Testing](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/testing)__ - your models for testing best practices

3. __[Documentation](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/documentation)__ - your models for documentation best practices

4. __[Structure](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/structure)__ - your dbt project for file structure and naming best practices

5. __[Performance](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/performance)__ - your model materializations for performance best practices

6. __[Governance](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/governance)__ - your best practices for model governance features.

In addition to tests, this package creates the model `int_all_dag_relationships` which holds information about your DAG in a tabular format and can be queried using SQL in your Warehouse.

Currently, the following adapters are supported:

- BigQuery

- Databricks/Spark

- PostgreSQL

- Redshift

- Snowflake

- DuckDB

- Trino (tested with Iceberg connector)

- AWS Athena (tested manually)

- Greenplum (tested manually)

- ClickHouse (tested manually)

## Using This Package

### Cloning via dbt Package Hub

  

Check [dbt Hub](https://hub.getdbt.com/dbt-labs/dbt_project_evaluator/latest/) for the latest installation instructions, or [read the docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages.

### Additional setup for Databricks/Spark/DuckDB/Redshift/ClickHouse

In your `dbt_project.yml`, add the following config:

```yml

# dbt_project.yml

dispatch:

  - macro_namespace: dbt

    search_order: ['dbt_project_evaluator', 'dbt']

```

This is required because the project currently overrides a small number of dbt core macros in order to ensure the project can run across the listed adapters. The overridden macros are in the [cross_db_shim directory](macros/cross_db_shim/).

  

## Documentation

The full documentation and list of rules are available on [this website](https://dbt-labs.github.io/dbt-project-evaluator/)