Documentatie in dbt maken en genereren

Introductie tot dbt

Mike Metzger

Data Engineer

Waarom documenteren?

  • Gegevensdetails delen met andere gebruikers

 

  • Bronnen voor documentatie centraliseren

 

  • Details geven voor updates/wijzigingen/etc.

 

  • Voorbeelden, gebruikstips, SLA-details maken

Documenten

Introductie tot dbt

Documentatie maken in dbt

  • Documentatie toevoegen aan modeldefinities
  • Documentatie toevoegen over kolommen in modellen
  • Automatisch datalinage/DAG tonen
  • Tests/validaties documenteren
  • Gegenereerde warehouse-info bekijken
    • Kolomdatatypes
    • Datagroottes
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
Introductie tot dbt

Documentatie genereren in dbt

  • dbt docs
    • dbt docs -h
    • dbt docs generate
  • Maakt de documentatiesite op basis van je project
  • Draai na dbt run
Introductie tot dbt

Documentatie openen

  • Webbrowser
  • dbt docs serve
    • Alleen lokaal/voor ontwikkeling gebruiken
  • Content kopiëren naar andere hosting
    • dbt Cloud
    • Amazon S3
    • Nginx/Apache/etc.

dbt-documentatieweergave

Introductie tot dbt

Voorbeeld van documentatie

  • Weergave
    • Modellen
    • Beschrijvingen
    • Kolomdetails
    • Afstammingsgrafieken

dbt-documentatieweergave

Introductie tot dbt

Laten we oefenen!

Introductie tot dbt

Preparing Video For Download...