group

Models

dbt_project.yml

models:

  <resource-path>:
    +group: GROUP_NAME

models/schema.yml

version: 2

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

models/<modelname>.sql

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

select ...

Seeds

dbt_project.yml

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

seeds/properties.yml

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

Snapshots

dbt_project.yml

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

snapshots/<filename>.sql

{% snapshot snapshot_name %}

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

select ...

{% endsnapshot %}

Tests

dbt_project.yml

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

tests/properties.yml

version: 2

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

tests/<filename>.sql

{% test <testname>() %}

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

select ...

{% endtest %}

tests/<filename>.sql

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

Analyses

analyses/<filename>.yml

version: 2

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

Metrics

dbt_project.yml

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

models/metrics.yml

version: 2

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

Semantic models

dbt_project.yml

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

models/semantic_models.yml

semantic_models:
  - name: SEMANTIC_MODEL_NAME
    config:
      group: GROUP_NAME

Saved queries

dbt_project.yml

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

models/semantic_models.yml

saved_queries:
  - name: SAVED_QUERY_NAME
    config:
      group: GROUP_NAME

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

models/marketing_model.sql

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

$ 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.

Related docs

• Model Access
• Defining groups