hywan/database-to-plantuml

Extract database table information into a PlantUML description.

Database to PlantUML

This utility renders a graphical 2D visualisation of a database., _(*1)

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:, _(*2)

• PNG,
• SVG,
• EPS,
• PDF,
• VDX,
• XMI,
• HTML,
• TXT,
• UTXT,
• LaTeX.

Installation

With Composer, simply run the following command:, _(*3)

$ composer install

If you would like to use it as a dependency of your project, then:, _(*4)

$ composer require hywan/database-to-plantuml

To use the plantuml backend, you can use the JAR in resource/plantuml.jar., _(*5)

Examples with…

… PostgreSQL

Taking as an example the famous employees use case:, _(*6)

# 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

, _(*7)

… MySQL

With the same employees use case:, _(*8)

# 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

, _(*9)

Note: Outputs differ because the employees examples are not exactly the same. They are here to illustrate the tool only., _(*10)

License

BSD-3-License, but seriously, do what ever you want!, _(*11)