ドキュメント(description)とdbt docs

dbtは、モデルやカラムに書いた説明文から、そのままドキュメントサイトを自動生成できる。

models:
  - name: customers
    description: 顧客ごとの注文集計を持つマートモデル
    columns:
      - name: customer_id
        description: 顧客を一意に識別するID
        data_tests:
          - unique
          - not_null

descriptionは1行で書くほか、>(改行をスペースに畳み込む)や|(改行をそのまま保持)を使って複数行で書くこともできる。

ドキュメントサイトはdbt docs generateでモデル・カラムの説明やDAG(依存関係グラフ)、テストの情報などをまとめたメタデータを生成し、dbt docs serveでローカルにサイトとして表示できる。ウェアハウスのスキーマ情報(カラムのデータ型など)は自動的に取得されるため、descriptionを書いていないカラムも一覧には表示される。