Генератор документации по базам данных

Данный инструмент генерирует документацию по базе данных на основе предоставленной ссылки. Если вам не нравится PowerDesigner из-за его большого размера, вы можете попробовать этот инструмент.

Поддерживаемые типы баз данных:

• MySQL;
• Oracle;
• SQLServer;
• MongoDB;
• PostgreSQL.

Вы можете скачать пакет release или исходный код для использования инструмента.

Если вы используете исходный код, вам необходимо выполнить следующие шаги:

1. Клонировать проект.
2. Запустить команду mvn package для создания пакета.
3. Запустить bin/start.bat для запуска программы.

После запуска программы вам будет предложено ввести параметры базы данных:

choose database:
1:mysql
2:oracle
3:PostgreSQL
Select the appropriate numbers choose database type
(Enter 'c' to cancel): 3
input database name:
gunslite
input host:
localhost
input port:
5432
input username:
enilu
input password:
123456

После ввода всех параметров нажмите Enter. Это позволит создать каталог с документацией по базе данных ${dbname}-doc. Каталог содержит три вида документации: один файл HTML, документ Word и Markdown.

Markdown можно использовать для генерации HTML-документации для онлайн-просмотра.

Убедитесь, что у вас установлен GitBook, затем перейдите в командную строку каталога файлов и запустите команду gitbook serve:

E:\database-doc-generator-20181006100721\guns-lite-doc>gitbook serve
openssl config failed: error:02001003:system library:fopen:No such process
Live reload server started on port: 35729
Press CTRL+C to quit ...

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 15 pages
info: found 0 asset files
info: >> generation finished with success in 1.6s !

Starting server ...
Serving book on http://localhost:4000

Перейдите по адресу http://localhost:4000, чтобы просмотреть документацию по базе данных онлайн.