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.12.0b1.tar.gz
(29.1 kB
view hashes)
Built Distribution
dbterd-1.12.0b1-py3-none-any.whl
(43.2 kB
view hashes)
Close
Hashes for dbterd-1.12.0b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d251f078f1bbad250b25e02ee093e39d1e9f8b48b4bbd66a9c34dd782461db6 |
|
MD5 | f22a64f76dfdf8cbb7672d3ed390ad69 |
|
BLAKE2b-256 | 378012ec83b7164d9c571aef7a29bcb841ad6399e975b09ce478190a593a3f7f |