Config file

dbt-bouncer requires a config file to be provided. This file configures what checks are run. Here is an example config file:

dbt_artifacts_dir: target # [Optional] Directory where the dbt artifacts exists, generally the `target` directory inside a dbt project. Defaults to `./target`.

manifest_checks:
  - name: check_macro_name_matches_file_name
  - name: check_model_names
    include: ^staging
    model_name_pattern: ^stg_

For more example config files, see here.

Config file name

By default dbt-bouncer expects a config file named dbt-bouncer.yml:

$ dbt-bouncer
Running dbt-bouncer (X.X.X)...
Loaded config from <PATH>/dbt-bouncer.yml...
...

If your config file is named differently use the --config-file argument:

$ dbt-bouncer --config-file dbt_bouncer_config.yml
Running dbt-bouncer (X.X.X)...
Loaded config from dbt_bouncer_config.yml...
...

Common arguments

Most (but not all) checks accept the following optional arguments:

• exclude: Regexp to match which paths to exclude.
• include: Regexp to match which paths to include.

Example options:

• Exposures: The path to the properties file where the source is defined, e.g. ^marts/finance will match exposures defined in ./models/marts/finance/_exposures.yml.
• Macros: The path to the macro file, e.g. ^macros/system will match files like ./macros/system/generate_schema_name.sql.
• Models: The path to the model file, e.g. ^marts will match files like ./models/marts/customers.sql.
• Run Results: The path to the file associated with the resource, e.g. ^finance/.*\.csv$ will match seeds in ./seeds/finance, ^staging will match models and tests in ./models/staging.
• Sources: The path to the properties file where the source is defined, e.g. ^staging/crm will match sources defined in ./models/staging/crm/_crm__sources.yml.

To determine if a check accepts these arguments view the Checks page.

Config via pyproject.toml

Note that the config can also be passed via a pyproject.toml file:

[tool.dbt-bouncer]
dbt_artifacts_dir = "target"

[[tool.dbt-bouncer.manifest_checks]]
name = "check_macro_name_matches_file_name"

[[tool.dbt-bouncer.manifest_checks]]
name = "check_model_names"
include = "^staging"
model_name_pattern = "^stg_"