前言
有个项目需要交付,需要提供
数据库设计文档
.所以找了一个数据库生成文档工具。分享给大家!!!
1、工具介绍 :
这是一个简单的小工具,可以根据数据库表结构生成数据库设计文档(格式包括markdown,html,word),支持数据库(MySQL,Oracle,PostgreSQL)
2、下载工具:
链接:
https://pan.baidu.com/s/1ouQI-ksvkXNroPyYewQPNA
提取码:
6vke
3、解压
解压后进入文件夹执行以下命令
windows 下执行
bin/start.bat
mac或linux 下执行 (需设定执行权限
chmod 0755 bin/start.sh)
bin/start.sh
4、详细操作
执行后就可以按提示进行文档生成操作了:
choose database:
1:mysql
2:oracle
3:PostgreSQL
Select the appropriate numbers choose database type
(Enter 'c' to cancel): 1
input database name:
aliexpress_lf
input host:
localhost
input port:
3306
input username:
root
input password:
123456
输入完成后回车,即生成以名字为 ${dbname}-doc 格式的文件夹,我这里生成的是 aliexpress_lf-doc
├── README.md
├── bin
├── aliexpress_lf-doc
├── database.html
└── lib
文件夹中的文档就是以 markdown 文件来载体,
├── aliexpress_lf.doc
├── aliexpress_lf.html
├── bak_kj_hot_data.md
└── feedback_main_id.md
生成出的 markdown 文件内容示例:
bak_kj_hot_data(bak_kj_hot_data)
列名 | 类型 | KEY | 可否为空 | 注释 |
---|---|---|---|---|
id | varchar(100) | PRI | 否 | |
data | longtext | 是 | ||
create_date | datetime | 是 |
总结
如果此篇文章有帮助到您, 希望打大佬们能
关注
、点赞
、收藏
、评论
支持一波,非常感谢大家!
如果有不对的地方请指正!!!