persist_docs

Models

dbt_project.yml

models:
  <resource-path>:
    +persist_docs:
      relation: true
      columns: true

models/<modelname>.sql

{{ config(
  persist_docs={"relation": true, "columns": true}
) }}

select ...

Sources

Эта конфигурация не реализована для источников.

Seeds

dbt_project.yml

seeds:
  <resource-path>:
    +persist_docs:
      relation: true
      columns: true

Snapshots

dbt_project.yml

snapshots:
  <resource-path>:
    +persist_docs:
      relation: true
      columns: true

snapshots/<filename>.sql

{% snapshot snapshot_name %}

{{ config(
  persist_docs={"relation": true, "columns": true}
) }}

select ...

{% endsnapshot %}

Определение

Опционально сохраняйте описания ресурсов в виде комментариев к столбцам и отношениям в базе данных. По умолчанию сохранение документации отключено, но его можно включить для конкретных ресурсов или групп ресурсов по мере необходимости.

Поддержка

Конфигурация persist_docs поддерживается на наиболее широко используемых адаптерах dbt:

• Postgres
• Redshift
• Snowflake
• BigQuery
• Databricks
• Apache Spark

Однако некоторые базы данных ограничивают, где и как можно добавлять описания к объектам базы данных. Эти адаптеры баз данных могут не поддерживать persist_docs или могут предлагать только частичную поддержку.

Некоторые известные проблемы и ограничения:

Databricks

• Комментарии на уровне столбцов требуют file_format: delta (или другого "v2 формата файла")

Snowflake

• Известных проблем нет

Использование

Документирование столбцов и отношений

Предоставьте описание для модели:

models/schema.yml

version: 2

models:
  - name: dim_customers
    description: Одна запись на клиента
    columns:
      - name: customer_id
        description: Первичный ключ

Включите persist_docs для столбцов и отношений в вашем проекте:

dbt_project.yml

models:
  +persist_docs:
    relation: true
    columns: true

Запустите dbt и убедитесь, что созданные отношения и столбцы аннотированы вашими описаниями:

Описания отношений в BigQuery

Описания столбцов в BigQuery