datnguye/dbterd

🧩 dbterd: Tạo ERD từ dự án dbt chỉ bằng một lệnh

Chuyển artifact dbt thành sơ đồ ERD đa định dạng: DBML, Mermaid, PlantUML, GraphViz, D2, DrawDB, JSON — tất cả đều dưới dạng code.

dbterd là một công cụ CLI bằng Python giúp bạn tự động sinh sơ đồ Entity Relationship Diagram (ERD) từ các file artifact của dbt — bao gồm cả manifest và catalog. Dự án hỗ trợ ba thuật toán phát hiện mối quan hệ thực thể khác nhau, phù hợp với cách bạn cấu trúc data contract trong dự án.

✨ Điểm nổi bật

• Hỗ trợ ba thuật toán ERD: Test Relationships (mặc định), Semantic Entities (-a entity_relationship), Model Contract Constraints (-a model_contract)
• Đa dạng định dạng đầu ra: DBML, Mermaid, PlantUML, GraphViz, D2, DrawDB, JSON
• Cài đặt nhanh: Chỉ với pip install dbterd và dbterd run -ad <project_path>
• Hỗ trợ cấu hình file: Sử dụng .dbterd.yml hoặc pyproject.toml để lưu cài đặt
• Tích hợp VS Code: Có tiện ích mở rộng dbterd cho VS Code với giao diện đồ họa
• Hệ sinh thái mở rộng: Kết nối với dbdocs — trang tài liệu dbt thay thế với ERD và lineage tích hợp

💡 Vì sao đáng chú ý

dbterd khác biệt ở khả năng tự động nhận diện quan hệ thực thể từ ba nguồn khác nhau — tests, semantic layer, hoặc model contracts — giúp người dùng linh hoạt chọn phương pháp phù hợp với quy trình dbt của mình. Đặc biệt, việc hỗ trợ đến 7 định dạng ERD khác nhau giúp dễ dàng tích hợp vào mọi công cụ và quy trình làm việc.

#ERD #dbt #DataModeling #OpenSource #TiniX