hywan / database-to-plantuml
Extract database table information into a PlantUML description.
Installs: 6 921
Dependents: 0
Suggesters: 0
Security: 0
Stars: 191
Watchers: 10
Forks: 23
Open Issues: 6
Requires
- php: >=7.0
- hoa/console: ~3.0
- hoa/database: ~0.17
- hoa/router: ~3.0
- hoa/visitor: ~2.0
This package is not auto-updated.
Last update: 2024-10-27 04:07:57 UTC
README
This utility renders a graphical 2D visualisation of a database.
Currently, the only supported frontends are PostgreSQL and
MySQL. There are 2 backends: commonmark
and plantuml
. The
plantuml
backend allows to generate visualisations into the
following formats:
- PNG,
- SVG,
- EPS,
- PDF,
- VDX,
- XMI,
- HTML,
- TXT,
- UTXT,
- LaTeX.
Installation
With Composer, simply run the following command:
$ composer install
If you would like to use it as a dependency of your project, then:
$ composer require hywan/database-to-plantuml
To use the plantuml
backend, you can use the JAR in resource/plantuml.jar
.
Examples with…
… PostgreSQL
Taking as an example the famous employees
use case:
# Import the schema. $ psql -f resource/samples/pgsql-employees.sql postgres # Generate the visualisation. $ bin/database-to-plantuml -d 'pgsql:dbname=employees' -u hywan -s employees | \ java -jar resource/plantuml.jar -verbose -pipe > output.png
… MySQL
With the same employees
use case:
# Import the schema. $ mysql -u root < resource/samples/mysql-employees.sql # Generate the visualisation. $ bin/database-to-plantuml -d 'mysql:dbname=employees' -u root -s employees | \ java -jar resource/plantuml.jar -verbose -pipe > output.png
Note: Outputs differ because the employees
examples are not exactly
the same. They are here to illustrate the tool only.
License
BSD-3-License, but seriously, do what ever you want!