Simply and easily with SchemaSpy
It has never been easier to document you db. SchemaSpy analyzes your database with tables, columns, types and indexes. It even creates diagrams with relationships of your existing database.
The installation is super easy. You just have to download SchemaSpy https://github.com/schemaspy/schemaspy/releases and your database driver. Even Graphviz is no longer required. The configuration is really simple. Here I show a config.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # type of database. Run with -dbhelp for details | |
| schemaspy.t=mysql | |
| # optional path to alternative jdbc drivers. | |
| schemaspy.dp=mysql-connector-java-8.0.22 | |
| # database properties: host, port number, name user, password | |
| schemaspy.host=localhost | |
| schemaspy.port=3306 | |
| schemaspy.db=db | |
| schemaspy.u=root | |
| schemaspy.p=password | |
| # output dir to save generated files | |
| schemaspy.o=doc | |
| # db scheme for which generate diagrams | |
| schemaspy.s=db | |
| # run with java -jar schemaspy-6.1.0.jar -configFile config.properties |
You run the tool with "java -jar schemaspy-6.1.0.jar -configFile config.properties". Then you get a HTML documenation and the diagrams look like this.
And a really cool trick is to integrate SchemaSpy in your CI/CD pipeline.
I really like this tool.
Top comments (0)