创建与生成 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...