group

Models

dbt_project.yml

models:

  <resource-path>:
    +group: GROUP_NAME

Report incorrect code

models/schema.yml

models:
  - name: MODEL_NAME
    config:
      group: GROUP # changed to config in v1.10

Report incorrect code

models/<modelname>.sql

{{ config(
  group='GROUP_NAME'
) }}

select ...

Report incorrect code

Seeds

dbt_project.yml

models:
  <resource-path>:
    +group: GROUP_NAME

Report incorrect code

seeds/properties.yml

seeds:
  - name: [SEED_NAME]
    config:
      group: GROUP_NAME # changed to config in v1.10

Report incorrect code

Snapshots

dbt_project.yml

snapshots:
  <resource-path>:
    +group: GROUP_NAME

Report incorrect code

(Applies to dbt v1.9 and later)

snapshots/properties.yml

snapshots:
  - name: snapshot_name
    config:
      group: GROUP_NAME

Report incorrect code

snapshots/<filename>.sql

{% snapshot snapshot_name %}

{{ config(
  group='GROUP_NAME'
) }}

select ...

{% endsnapshot %}

Report incorrect code

Tests

dbt_project.yml

data_tests:
  <resource-path>:
    +group: GROUP_NAME

Report incorrect code

tests/properties.yml

<resource_type>:
  - name: <resource_name>
    data_tests:
      - <test_name>:
          config:
            group: GROUP_NAME

Report incorrect code

tests/<filename>.sql

{% test <testname>() %}

{{ config(
  group='GROUP_NAME'
) }}

select ...

{% endtest %}

Report incorrect code

tests/<filename>.sql

{{ config(
  group='GROUP_NAME'
) }}

Report incorrect code

Analyses

analyses/<filename>.yml

analyses:
  - name: ANALYSIS_NAME
    config:
      group: GROUP_NAME # changed to config in v1.10

Report incorrect code

Metrics

dbt_project.yml

metrics:
  <resource-path>:
    +group: GROUP_NAME

Report incorrect code

models/metrics.yml

metrics:
  - name: [METRIC_NAME]
    config:
      group: GROUP_NAME

Report incorrect code

Semantic models

dbt_project.yml

semantic-models:
  <resource-path>:
    +group: GROUP_NAME

Report incorrect code

(Applies to dbt v1.12 and later)

models/file_name.yml

models:
  - name: model_name
    semantic_model:
      enabled: true
      group: group_name

Report incorrect code

Saved queries

dbt_project.yml

saved-queries:
  <resource-path>:
    +group: GROUP_NAME

Report incorrect code

models/semantic_models.yml

saved_queries:
  - name: SAVED_QUERY_NAME
    config:
      group: GROUP_NAME

Report incorrect code

Note that for backwards compatibility, group is supported as a top-level key, but without the capabilities of config inheritance.

Definition

An optional configuration for assigning a group to a resource. When a resource is grouped, dbt will allow it to reference private models within the same group.

For more details on reference access between resources in groups, check out model access.

Examples

Prevent a 'marketing' group model from referencing a private 'finance' group model

This is useful if you want to prevent other groups from building on top of models that are rapidly changing, experimental, or otherwise internal to a group or team.

models/schema.yml

models:
  - name: finance_model
    config:
      group: finance # changed to config in v1.10
      access: private # changed to config in v1.10
  - name: marketing_model
    config:
      group: marketing # changed to config in v1.10

Report incorrect code

models/marketing_model.sql

select * from {{ ref('finance_model') }}

Report incorrect code

$ dbt run -s marketing_model
...
dbt.exceptions.DbtReferenceError: Parsing Error
  Node model.jaffle_shop.marketing_model attempted to reference node model.jaffle_shop.finance_model, 
  which is not allowed because the referenced node is private to the finance group.

Report incorrect code

Related docs

• Model Access
• Defining groups

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.