MySQL数据库文档生成器
数据库文档的整理其实挺头疼的,尤其是在项目尾声。MySQL 数据库文档生成工具就比较省事,配置好连接信息,一键就能把库结构、字段、索引啥的全导出来,生成个清爽的docx
文档,验收时有用。
文档内容也挺全的,像库名、表结构、字段类型、主键外键这些,全都自动拉出来。用的是读取数据库元数据的方式,执行几条 SQL 拿到结构,再生成文档。逻辑不复杂,但省了手工写书的时间。
config.xml
文件里你需要填上数据库连接的信息,像localhost
地址、端口号(一般是3306
)、库名、用户名、密码这些。记得写对,不然连不上库就白搭。
运行也蛮简单,装好Java
(JRE 或 JDK 都行),双击database_tools.jar
,它就开始跑了。中间会让你选数据库或表,输出一个叫database.docx
的文件,打开一看,结构啥的都清清楚楚,方便团队沟通。
建议你先读下工具使用方法.txt
,里面讲了不少实用小细节,比如报错怎么查、配置项有啥讲究。如果你是 Mac 用户,会看到一个__MACOSX
文件夹,别管它,系统自带的。
,这个工具挺适合开发和测试用的。项目快交付了、或者你想整理文档给新同事看,都可以用。如果你经常折腾MySQL
,装个 Java 环境,用上这工具,省心多了。
下载地址
用户评论