Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enilu/database-doc-generator
数据库文档成成器，根据数据库表DDL生成markdown和word文档，如果你觉得powerdesigener太重，可以试试这个小工具
https://github.com/enilu/database-doc-generator
java tool
Last synced: 17 days ago
JSON representation
数据库文档成成器，根据数据库表DDL生成markdown和word文档，如果你觉得powerdesigener太重，可以试试这个小工具
- Host: GitHub
- URL: https://github.com/enilu/database-doc-generator
- Owner: enilu
- License: mit
- Created: 2018-10-06T10:15:28.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-08T00:59:26.000Z (about 2 years ago)
- Last Synced: 2024-10-12T07:38:11.894Z (about 1 month ago)
- Topics: java, tool
- Language: Java
- Homepage:
- Size: 1020 KB
- Stars: 221
- Watchers: 16
- Forks: 76
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# database-doc-generator
数据库文档生成器
- 该工具根据给定的链接生成数据库文档，如果你嫌powerdesigner太重，那么可以试试该工具。
- 支持的数据库类型：
- MySQL
- Oracle
- SQLServer
- MongoDB
- PostgreSQL
- 你可以下载[release](https://github.com/enilu/database-doc-generator/releases/tag/1.3.0)包来或者下载源代码来使用。
- 如果使用源代码，需要先克隆该项目后运行mvn package打包，然后运行发布报中bin/start.bat
- 运行程序后按照下面提示输入对应数据库参数：
```bash
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
```
- 输入完成后回车，即可生成数据库文档目录${dbname}-doc,目录中文档有三种形式：单文件html，word，markdown
其中markdown可以用来生成html用于在线查看数据库文档：
- 确保安装了gitbook后，进入上述文件目录的命令行窗口运行：gitbook serve
```bash
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，即可在线查看数据库文档
