Skip to content

Simple tool to generate database schema documentation and export in svg, dot, rst or csv

License

Notifications You must be signed in to change notification settings

vranac/erdammer

Repository files navigation

ERDammer

image

image

image

Simple tool to generate database schema documentation and export in svg, dot, rst or csv

ERDammer in current version does not mark the relationships properly, that will be fixed in future versions.

Install

pip install erdammer

Usage

Run erdammer --help for a list of options.

Things to note, to connect to the database you will have to supply a connection string uri. For example

erdammer --uri "mysql+mysqlconnector://user:password@server/dbname" \
--output-directory="db-schema/" --output-format=svg

By default svg export creates a file called erd.svg in the directory you specified in output, in this case it is ./db-schema.

If on the other hand you execute

erdammer --uri "mysql+mysqlconnector://user:password@server/dbname" --output-directory="db-schema/" \
--output-format=rst

One ReStructured file per table will be created, with table name as filename.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

About

Simple tool to generate database schema documentation and export in svg, dot, rst or csv

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published