Automatically Document Your Database in Markdown

Use SchemaCrawler to generate Markdown documentation from your existing database. You can tweak the output to your heart's content using Python scripting. (SchemaCrawler also supports JavaScript and Ruby scripting.)

Try it out. Make sure that you have . Download a sample SQLite database called , and save it in your local directory.

Then run a command like:

docker run \

--mount type=bind,source="$(pwd)",target=/home/schcrwlr/share \

--rm -it \

schemacrawler/schemacrawler \

/opt/schemacrawler/bin/schemacrawler.sh \

--server=sqlite \

--database=share/chinook-database-2.0.1.sqlite \

--info-level=standard \

--command script \

--script-language python \

--script share/markdown.py

(If you are using PowerShell on Windows, replace the trailing backslash on each line with a back-tick "`".)

There is a simpler example of this in the repository.

To learn about how to use SchemaCrawler, download the SchemaCrawler distribution zip file and go through the examples.

Vollständiger Original-Bericht

Ausführliche Details, Code-Beispiele & Hersteller-Stellungnahme auf dev.to.

↗ Original-Artikel auf dev.to lesen