enabled

Models

dbt_project.yml

models:
  <resource-path>:
    +enabled: true | false

models/<modelname>.sql

{{ config(
  enabled=true | false
) }}

select ...

Seeds

dbt_project.yml

seeds:
  <resource-path>:
    +enabled: true | false

Snapshots

dbt_project.yml

snapshots:
  <resource-path>:
    +enabled: true | false

snapshots/<filename>.sql

# Configuring in a SQL file is a legacy method and not recommended. Use the YAML file instead.

{% snapshot snapshot_name %}

{{ config(
  enabled=true | false
) }}

select ...

{% endsnapshot %}

Tests

dbt_project.yml

data_tests:
  <resource-path>:
    +enabled: true | false

tests/<filename>.sql

{% test <testname>() %}

{{ config(
  enabled=true | false
) }}

select ...

{% endtest %}

tests/<filename>.sql

{{ config(
  enabled=true | false
) }}

Unit tests

💡Did you know...

Available from dbt v1.8 or with the dbt "Latest" release track.

dbt_project.yml

unit_tests:
  <resource-path>:
    +enabled: true | false

models/<filename>.yml

unit_tests:
  - name: [<test-name>]
    config:
      enabled: true | false

Sources

dbt_project.yml

sources:
  <resource-path>:
    +enabled: true | false

models/properties.yml

version: 2

sources:
  - name: [<source-name>]
    config:
      enabled: true | false
    tables:
      - name: [<source-table-name>]
        config:
          enabled: true | false

Metrics

dbt_project.yml

metrics:
  <resource-path>:
    +enabled: true | false

models/metrics.yml

version: 2

metrics:
  - name: [<metric-name>]
    config:
      enabled: true | false

Exposures

dbt_project.yml

exposures:
  <resource-path>:
    +enabled: true | false

models/exposures.yml

version: 2

exposures:
  - name: [<exposure-name>]
    config:
      enabled: true | false

Semantic models

dbt_project.yml

semantic-models:
  <resource-path>:
    +enabled: true | false

models/semantic_models.yml

semantic_models:
  - name: [<semantic_model_name>]
    config:
      enabled: true | false

Saved queries

dbt_project.yml

saved-queries:
  <resource-path>:
    +enabled: true | false

models/semantic_models.yml

saved_queries:
  - name: [<saved_query_name>]
    config:
      enabled: true | false

Definition

An optional configuration for enabling or disabling a resource.

• Default: true

When a resource is disabled, dbt will not consider it as part of your project. Note that this can cause compilation errors.

If you instead want to exclude a model from a particular run, consider using the --exclude parameter as part of the model selection syntax

If you are disabling models because they are no longer being used, but you want to version control their SQL, consider making them an analysis instead.

Examples

Disable a model in a package in order to use your own version of the model.

This could be useful if you want to change the logic of a model in a package. For example, if you need to change the logic in the segment_web_page_views from the segment package (original model):

1. Add a model named segment_web_page_views (the same name) to your own project.
2. To avoid a compilation error due to duplicate models, disable the segment package's version of the model like so:

dbt_project.yml

models:
  segment:
    base:
      segment_web_page_views:
        +enabled: false

Was this page helpful?

Privacy policyCreate a GitHub issue

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.