Skip to content

Generate entity-relationship diagrams from PostgreSQL by PlantUML, DBML-renderer, ERAlchemy, etc.

Notifications You must be signed in to change notification settings

tilde-lab/sql_visualization

Folders and files

NameName
Last commit message
Last commit date

Latest commit

38197f8 · Aug 23, 2023

History

43 Commits
Aug 23, 2023
Aug 7, 2023
Aug 23, 2023
Aug 23, 2023
Aug 23, 2023
Aug 23, 2023
Aug 23, 2023
Aug 23, 2023
Aug 19, 2023
Aug 23, 2023

Repository files navigation

database_visualization

Generate Entity-Relationship Diagrams from PostgreSQL by PlantUML, DBML-renderer, ERAlchemy, Graphviz. image

Requirements

  • PostgreSQL*
  • graphviz==2.49.0
  • dbml-renderer==1.0.27
  • plantuml (specific version present in the repository)
  • npm==9.6.7
  • node==v18.17.0
  • Java Runtime Environment*

Installation

To download repository:

git clone https://github.com/alinzh/database_visualization.git

Install Graphviz for your version of Windows by following this link: https://graphviz.org/download/

Install Graphviz on Linux:

sudo apt-get install graphviz libgraphviz-dev

Next:

pip install -r requirements.txt
sudo npm install -g @softwaretechnik/dbml-renderer

Run:

python main.py --host HOST --port PORT --user USER --password PASSWORD \
--db_name DB_NAME --schema_name SCHEMA_NAME --engine ENGINE --direction DIRECTION --output_path PATH

DIRECTION, ENGINE and PATH are optional arguments.

Available engines:

  • 'plantuml'
  • 'eralchemy'
  • 'dbml-r'
  • 'dot-r'

You can not specify engine, then you will get diagrams generated by all available methods.

Available direction:

If you are not satisfied with the location of the blocks on the diagram, change their location by adding the argument DIRECTION = '2'. If you need to save image in specific folder, add an argument PATH with a path.

About

Generate entity-relationship diagrams from PostgreSQL by PlantUML, DBML-renderer, ERAlchemy, etc.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages