CLI to generate ERD Diagram file from dbt artifact files
Project description
dbterd
CLI to generate Diagram-as-a-code file (DBML, Mermaid, PlantUML, GraphViz, D2) from dbt artifact files (required: )
pip install dbterd --upgrade
Verify installation:
dbterd --version
Quick examine with existing samples
Click me
# select all models in dbt_resto
dbterd run -ad samples/dbtresto
# select all models in dbt_resto, Select multiple dbt resources
dbterd run -ad samples/dbtresto -rt model -rt source
# select only models in dbt_resto excluding staging
dbterd run -ad samples/dbtresto -s model.dbt_resto -ns model.dbt_resto.staging
# select only models in schema name mart excluding staging
dbterd run -ad samples/dbtresto -s schema:mart -ns model.dbt_resto.staging
# select only models in schema full name dbt.mart excluding staging
dbterd run -ad samples/dbtresto -s schema:dbt.mart -ns model.dbt_resto.staging
# other samples
dbterd run -ad samples/fivetranlog
dbterd run -ad samples/fivetranlog -rt model -rt source
dbterd run -ad samples/facebookad
dbterd run -ad samples/facebookad -rt model -rt source
dbterd run -ad samples/shopify -s wildcard:*shopify.shopify__*
dbterd run -ad samples/shopify -rt model -rt source
dbterd run -ad samples/dbt-constraints -a "test_relationship:(name:foreign_key|c_from:fk_column_name|c_to:pk_column_name)"
# your own sample without commiting to repo
dbterd run -ad samples/local -rt model -rt source
Quick DEMO
Check Quick Demo out! And, following is the sample result using dbdocs
:
Contributing ✨
If you've ever wanted to contribute to this tool, and a great cause, now is your chance!
See the contributing docs CONTRIBUTING for more information.
Finally, super thanks to our Contributors:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
dbterd-1.11.0b1.tar.gz
(26.9 kB
view hashes)
Built Distribution
dbterd-1.11.0b1-py3-none-any.whl
(40.1 kB
view hashes)
Close
Hashes for dbterd-1.11.0b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eca956be613dcee7c4490cd09cff5dc9a17135a743201cd66d3a22d2471a1d3e |
|
MD5 | 81df8cbbe1dfd1ff5459380f2e541cf6 |
|
BLAKE2b-256 | 8b749fccc1659d40b168ec58f7e32c8555871fce725003ac56604a11efaee140 |