Skip to content

Cum să generezi documentație cu dbt docs

DodaTech Updated 2025-01-15 1 min read

In this tutorial, you'll learn about Cum să generezi documentație cu dbt docs. We cover key concepts, practical examples, and best practices.

Documentația dbt oferă o interfață web pentru a explora modelele, testele, expunerile și graful de dependențe. Acest ghid explică generarea și servirea documentației.

Step-by-Step Fix

1. Generează documentația

dbt docs generate

Output așteptat:

15:23:45  Building catalog
15:23:46  Catalog written to target/catalog.json
15:23:46  Building project
15:23:47  Project written to target/manifest.json
15:23:47  Done.

2. Servește documentația

dbt docs serve

Output așteptat:

15:23:45  Serving docs at http://localhost:8080

3. Servește pe un port specific

dbt docs serve --port 9000

4. Personalizează documentația

# models/schema.yml
models:
  - name: fct_orders
    description: "Tabelul facturilor cu comenzile zilnice"
    columns:
      - name: order_id
        description: "Identificator unic al comenzii"
        tests:
          - unique
          - not_null

Common Mistakes

Greșeală Soluție
Se generează documentația fără a rula modelele Catalogul are nevoie de tabelele create în baza de date
Se uită să se ruleze dbt docs generate după modificări Regenerarea este necesară pentru a reflecta schimbările
Portul 8080 este deja ocupat Folosește --port pentru a specifica un port diferit

Prevention Tips

  • Rulează dbt docs generate după fiecare modificare majoră
  • Documentează fiecare model și coloană în schema.yml
  • Folosește descrieri detaliate cu markdown
  • Distribuie linkul către documentație echipei

DodaTech Tools

Doda Browser integrează documentația dbt într-un panou dedicat. DodaZIP arhivează versiunile anterioare ale documentației. Durga Antivirus Pro verifică documentația pentru informații sensibile expuse.

FAQ

### Ce informații conține documentația dbt?

Catalogul tabelelor, descrierile modelelor și coloanelor, testele și graful de dependențe.

### Pot accesa documentația de la distanță?

Da, poți hosting documentația generată pe un server web static (folderul target/).

### Cum adaug descrieri la modele?

Adaugă câmpul description în fișierele YAML de definire a modelelor.

Construit de dezvoltatorii Doda Browser, DodaZIP și Durga Antivirus Pro. Instrumentele DodaTech se integrează nativ cu dbt pentru productivitate și securitate sporite.

Built by the developers of DodaTech

Doda Browser, DodaZIP & Durga Antivirus Pro