dbt ドキュメントの作成と生成

dbt入門

Mike Metzger

Data Engineer

なぜドキュメント化するのか

  • 他の利用者とデータの詳細を共有

 

  • ドキュメントの情報源を一元化

 

  • 更新・変更などの詳細を提供

 

  • 例、使用提案、SLA などを作成

ドキュメント

dbt入門

dbt でのドキュメント作成

  • モデル定義にドキュメントを付与可能
  • モデル内のカラムについても記述可能
  • データ系譜/DAG を自動表示
  • テスト/検証を記録
  • 生成されたウェアハウス情報を表示
    • カラム型
    • データサイズ
version: 2

models:
  - name: taxi_rides_raw
    description: Yellow Taxi raw data
    access: public
  - name: avg_fare_per_day
    description: Average ride per day
    access: public
dbt入門

dbt でのドキュメント生成

  • dbt docs
    • dbt docs -h
    • dbt docs generate
  • プロジェクトに基づくドキュメントサイトを作成
  • dbt run 後に実行
dbt入門

ドキュメントへのアクセス

  • Web ブラウザ
  • dbt docs serve
    • ローカル/開発用のみに使用
  • 他のホスティングへ配置
    • dbt Cloud
    • Amazon S3
    • Nginx / Apache など

dbt ドキュメントのビュー

dbt入門

ドキュメント例

  • 表示
    • モデル
    • 説明情報
    • カラム詳細
    • 系譜グラフ

dbt ドキュメントのビュー

dbt入門

Passons à la pratique !

dbt入門

Preparing Video For Download...