Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tilde-lab/sql_visualization
Generate entity-relationship diagrams from PostgreSQL by PlantUML, DBML-renderer, ERAlchemy, etc.
https://github.com/tilde-lab/sql_visualization
Last synced: about 2 months ago
JSON representation
Generate entity-relationship diagrams from PostgreSQL by PlantUML, DBML-renderer, ERAlchemy, etc.
- Host: GitHub
- URL: https://github.com/tilde-lab/sql_visualization
- Owner: tilde-lab
- Created: 2023-07-31T16:58:01.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-08-23T17:36:17.000Z (over 1 year ago)
- Last Synced: 2024-03-27T05:09:22.077Z (9 months ago)
- Language: Python
- Homepage:
- Size: 9.83 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# database_visualization
Generate Entity-Relationship Diagrams from PostgreSQL by PlantUML, DBML-renderer, ERAlchemy, Graphviz.
### 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:
```bash
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:
```bash
sudo apt-get install graphviz libgraphviz-dev
```
Next:
```bash
pip install -r requirements.txt
sudo npm install -g @softwaretechnik/dbml-renderer
```
Run:
```bash
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.