dbt-Dokumentation erstellen und generieren

Einführung in dbt

Mike Metzger

Data Engineer

Warum dokumentieren?

  • Dateninfos mit anderen Nutzenden teilen

 

  • Dokumentationsquellen zentralisieren

 

  • Details zu Updates/Änderungen bereitstellen

 

  • Beispiele, Nutzungstipps, SLA-Details erstellen

Dokumente

Einführung in dbt

Dokumentation in dbt erstellen

  • Doku mit Modelldefinitionen bereitstellen
  • Spalten in Modellen dokumentieren
  • Datenabstammung/DAG automatisch anzeigen
  • Tests/Validierungen dokumentieren
  • Generierte Warehouse-Infos ansehen
    • Spaltendatentypen
    • Datengrößen
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
Einführung in dbt

Dokumentation in dbt generieren

  • dbt docs
    • dbt docs -h
    • dbt docs generate
  • Erstellt die Doku-Website basierend auf dem Projekt
  • Nach dbt run ausführen
Einführung in dbt

Auf Dokumentation zugreifen

  • Webbrowser
  • dbt docs serve
    • Nur lokal/für Entwicklung nutzen
  • Inhalte auf anderen Host kopieren
    • dbt Cloud
    • Amazon S3
    • Nginx/Apache etc.

dbt-Dokumentationsansicht

Einführung in dbt

Beispiel für Dokumentation

  • Ansicht
    • Modelle
    • Beschreibungen
    • Spaltendetails
    • Abstammungsdiagramme

dbt-Dokumentationsansicht

Einführung in dbt

Lass uns üben!

Einführung in dbt

Preparing Video For Download...