-
Notifications
You must be signed in to change notification settings - Fork 18
Description
Context
Currently, Paracelsus excels at visualizing SQLAlchemy models by generating Mermaid and Dot (Graphviz) diagrams. While these are excellent for inline documentation (especially Mermaid in GitHub/GitLab), they can be limiting for interactive exploration or when sharing complex schemas with non-technical stakeholders.
When it comes to technical people who needs to perform a deeper exploration of the database schema, there is no support of a database design tools (like dbdiagram.io or dbdocs.io).
I would definitely opt for having a direct bridge from their SQLAlchemy code to the DBML format. spec DBML.
Why it makes sense
Introducing DBML support would significantly expand the utility of Paracelsus:
-
Interactive Visualization: DBML is the native format for tools like dbdiagram.io, which allow for interactive zooming, rearranging, and commenting on schema diagrams—features often missing from static Dot images or basic Mermaid renders.
-
Interoperability: DBML has become a de-facto standard for schema exchange. Exporting to DBML allows developers to use other ecosystem tools (e.g., converting schemas to different SQL dialects or generating independent documentation sites via dbdocs).
-
Readability: DBML is designed to be human-readable. For quick schema reviews, a DBML output is often cleaner and easier to parse mentally than raw SQL DDL or verbose Mermaid syntax.