https://github.com/datnguye/dbterd
Generate the ERD as a code from dbt artifacts
https://github.com/datnguye/dbterd
cli d2 dbml dbt-cloud dbt-core erd graphviz mermaid plantuml python-api
Last synced: 5 months ago
JSON representation
Generate the ERD as a code from dbt artifacts
- Host: GitHub
- URL: https://github.com/datnguye/dbterd
- Owner: datnguye
- License: mit
- Created: 2022-06-24T07:35:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T06:43:55.000Z (12 months ago)
- Last Synced: 2024-04-23T11:13:43.014Z (12 months ago)
- Topics: cli, d2, dbml, dbt-cloud, dbt-core, erd, graphviz, mermaid, plantuml, python-api
- Language: Python
- Homepage: https://dbterd.datnguyen.de/
- Size: 4.39 MB
- Stars: 162
- Watchers: 8
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-dbt - dbterd - CLI to generate DBML file from dbt manifest.json. (Utilities)
- jimsghstars - datnguye/dbterd - Generate the ERD as a code from dbt artifacts (Python)
README
# dbterd
Generate the ERD-as-a-code ([DBML](https://dbdiagram.io/d), [Mermaid](https://mermaid-js.github.io/mermaid-live-editor/), [PlantUML](https://plantuml.com/ie-diagram), [GraphViz](https://graphviz.org/), [D2](https://d2lang.com/), [DrawDB](https://drawdb.vercel.app/)) from dbt artifact files (`dbt Core`) or from dbt metadata (`dbt Cloud`)
Entity Relationships are configurably detected by ([docs](https://dbterd.datnguyen.de/latest/nav/guide/cli-references.html#dbterd-run-algo-a)):
- [Test Relationships](https://docs.getdbt.com/reference/resource-properties/data-tests#relationships) (default)
- [Semantic Entities](https://docs.getdbt.com/docs/build/entities) (use `-a` option)
[](https://pypi.org/project/dbterd/)
[](https://opensource.org/licenses/MIT)
[](https://www.python.org)
[](https://codecov.io/gh/datnguye/dbterd)
```bash
pip install dbterd --upgrade
```
Verify installation:
```bash
dbterd --version
```
> [!TIP]
> For `dbt-core` Users, it's highly recommended to upgrade `dbt-artifacts-parser` to the latest version in order to support the newer `dbt-core` version which would cause to have the [new manifest / catalog json schema](https://schemas.getdbt.com/):
> 👉 `pip install dbt-artifacts-parser --upgrade`
## Quick examine with existing samples
- Play with CLIs:
Click me
```bash
# 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 committing to repo
dbterd run -ad samples/local -rt model -rt source
```
- Play with Python API (whole ERD):
```python
from dbterd.api import DbtErd
erd = DbtErd().get_erd()
print("erd (dbml):", erd)
erd = DbtErd(target="mermaid").get_erd()
print("erd (mermaid):", erd)
```
- Play with Python API (1 model's ERD):
```python
from dbterd.api import DbtErd
dim_prize_erd = DbtErd(target="mermaid").get_model_erd(
node_unique_id="model.dbt_resto.dim_prize"
)
print("erd of dim_prize (mermaid):", dim_prize_erd)
```
Here is the output:
```mermaid
erDiagram
"MODEL.DBT_RESTO.DIM_PRIZE" {
varchar prize_key
nvarchar prize_name
int prize_order
}
"MODEL.DBT_RESTO.FACT_RESULT" {
varchar fact_result_key
varchar box_key
varchar prize_key
date date_key
int no_of_won
float prize_value
float prize_paid
int is_prize_taken
}
"MODEL.DBT_RESTO.FACT_RESULT" }|--|| "MODEL.DBT_RESTO.DIM_PRIZE": prize_key
```
🏃Check out the [Quick Demo](https://dbterd.datnguyen.de/latest/nav/guide/targets/generate-dbml.html) with DBML!
## Contributing ✨
If you've ever wanted to contribute to this tool, and a great cause, now is your chance!
See the contributing docs [CONTRIBUTING](https://dbterd.datnguyen.de/latest/nav/development/contributing-guide.html) for more information.
If you've found this tool to be very helpful, please consider giving the repository a star, sharing it on social media, or even writing a blog post about it 💌
[](https://github.com/datnguye/dbterd)
[](https://www.buymeacoffee.com/datnguye)
Finally, super thanks to our *Contributors*:
