hub / github.com/enilu/database-doc-generator

github.com/enilu/database-doc-generator @1.3.0

Chat with this repo

repository ↗ · DeepWiki ↗ · release 1.3.0 ↗ · + Follow

49 symbols 127 edges 9 files 11 documented · 22% ● updated 2mo ago1.3.0 · 2019-01-12★ 2262 open issues

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

database-doc-generator

数据库文档生成器

该工具根据给定的链接生成数据库文档，如果你嫌powerdesigner太重，那么可以试试该工具。
你可以下载release包来或者下载源代码来使用。
如果使用源代码，需要先克隆该项目后运行mvn package打包，然后运行发布报中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

输入完成后回车，即可生成数据库文档目录${dbname}-doc,目录中文档以markdown文件为载体：

doc

确保安装了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，即可在线查看数据库文档

summary

table

Core symbols most depended-on inside this repo

getTable

called by 7

src/main/java/cn/enilu/tool/database/doc/generator/bean/TableVo.java

getList

called by 7

src/main/java/cn/enilu/tool/database/doc/generator/database/Generator.java

getComment

called by 6

src/main/java/cn/enilu/tool/database/doc/generator/bean/TableVo.java

setTable

called by 4

src/main/java/cn/enilu/tool/database/doc/generator/bean/TableVo.java

setComment

called by 4

src/main/java/cn/enilu/tool/database/doc/generator/bean/TableVo.java

setColumns

called by 4

src/main/java/cn/enilu/tool/database/doc/generator/bean/TableVo.java

setName

called by 4

src/main/java/cn/enilu/tool/database/doc/generator/bean/ColumnVo.java

setType

called by 4

src/main/java/cn/enilu/tool/database/doc/generator/bean/ColumnVo.java

Shape

Method 40

Class 9

Languages

Java100%

Modules by API surface

src/main/java/cn/enilu/tool/database/doc/generator/bean/ColumnVo.java11 symbols

src/main/java/cn/enilu/tool/database/doc/generator/database/Generator.java9 symbols

src/main/java/cn/enilu/tool/database/doc/generator/bean/TableVo.java7 symbols

src/main/java/cn/enilu/tool/database/doc/generator/doc/WordGenerator.java4 symbols

src/main/java/cn/enilu/tool/database/doc/generator/doc/Html2DocConverter.java4 symbols

src/main/java/cn/enilu/tool/database/doc/generator/database/PostgreSQL.java4 symbols

src/main/java/cn/enilu/tool/database/doc/generator/database/Oracle.java4 symbols

src/main/java/cn/enilu/tool/database/doc/generator/database/MySQL.java4 symbols

src/main/java/cn/enilu/tool/database/doc/generator/Main.java2 symbols

Datastores touched

(mysql)Database · 1 repos

For agents

$ claude mcp add database-doc-generator \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact