Membuat dan menghasilkan dokumentasi dbt

Pengantar dbt

Mike Metzger

Data Engineer

Mengapa mendokumentasikan?

  • Berbagi detail data dengan konsumen lain

 

  • Memusatkan sumber dokumentasi

 

  • Menyediakan detail untuk pembaruan/perubahan/dll.

 

  • Membuat contoh, saran penggunaan, detail SLA

Dokumen

Pengantar dbt

Membuat dokumentasi di dbt

  • Dapat menyertakan dokumentasi pada definisi model
  • Dapat menambahkan dokumentasi kolom dalam model
  • Otomatis menampilkan lineage/DAG data
  • Mendokumentasikan pengujian/validasi apa pun
  • Melihat info gudang data yang dihasilkan
    • Tipe data kolom
    • Ukuran data
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
Pengantar dbt

Menghasilkan dokumentasi di dbt

  • dbt docs
    • dbt docs -h
    • dbt docs generate
  • Membuat situs dokumentasi berdasarkan proyek
  • Jalankan setelah dbt run
Pengantar dbt

Mengakses dokumentasi

  • Peramban web
  • dbt docs serve
    • Hanya untuk lokal/pengembangan
  • Salin konten ke layanan hosting lain
    • dbt Cloud
    • Amazon S3
    • Nginx/Apache/dll.

Tampilan dokumentasi dbt

Pengantar dbt

Contoh dokumentasi

  • Tampilan
    • Model
    • Informasi deskripsi
    • Detail kolom
    • Grafik garis keturunan

Tampilan dokumentasi dbt

Pengantar dbt

Ayo berlatih!

Pengantar dbt

Preparing Video For Download...