ildar7sins/db-docs

DBDocs is a simple tool to generate documentation for your database.

1.0.9 2025-03-03 22:50 UTC

Requires

• php: ^8.2.0

MIT

• database
• documentation
• dbdocs

README

Installation

• Install package composer require --dev ildar7sins/db-docs
• Run command php ./vendor/ildar7sins/db-docs/init.php for clone configs
• Update configs in configs/dbdocs.php file
• Run commands for generate your doccumentation:
  • php ./vendor/ildar7sins/db-docs/generate.php mysql 127.0.0.1 3306 <db_name> <user> <password> - localhost doesn't work, use 127.0.01
  • php ./vendor/ildar7sins/db-docs/generate.php pgsql localhost 5432 postgres_air postgres postgres postgres_air
  • Or use code, example of code usage you can see in generate.php file

What this library do

• Describe tables
• Describe columns
• Describe indexes
• Describe foreign keys

License

DBDocs is an open-source software licensed under the MIT license.