5 分钟生成一套数据库文档DBCHM 数据库字典导出教程【免费下载链接】DBCHMDBCHM修改版本支持导出数据库字典分组 The modified version of dbchm supports exporting database dictionary groups ( chm/word/markdown/html)项目地址: https://gitcode.com/gh_mirrors/db/DBCHM新同事接手老项目开口第一句经常是表结构文档在哪里找不到就只能在代码里逐张表猜字段含义。DBCHM 是一款数据库文档生成工具连上数据库后读取表、视图和存储过程的结构自动导出成可检索的离线字典替代手工整理。它对新成员上手和日常查字段的开发者都有用。 先看成品生成的文档长什么样图生成的 CHM 文档预览界面左侧是按分组组织的表目录右侧展示 Account 表的完整字段列表点击某一行时该行高亮显示以 CHM 格式为例CHM 是 Windows 上常见的离线帮助文档格式带目录树和全文检索左侧目录树按分组列出所有表右侧是单表结构列包括序号、列名、数据类型、长度、小数位数、主键、自增、允许空、默认值、列说明。连上数据库后点一次按钮就能完成数据库文档自动生成不用手写任何 SQL。这份文档对三类人最直接新成员接手项目时快速熟悉库表结构写代码怀疑某个字段语义时对照列说明DBA 交接数据库时作为交付材料。同样的信息还能换成 Word、Excel、PDF、HTML、Markdown、XML 等格式按用途选。能力边界能连哪些库、能导出哪些格式DBCHM 做的事情是数据库表结构导出支持范围可以一表看清。数据库侧README 中列出的有六种SqlServer、MySQL、Oracle、PostgreSQL、DB2、SQLite。导出格式共七种与工具栏上的导出按钮一一对应导出格式它是什么适合什么时候用CHMWindows 离线帮助文档带目录树和搜索团队共用的离线手册Word标准办公文档打印、评审、流转Excel电子表格一行一个字段批量核对、筛选字段清单PDF固定版式打印文档归档、交接HTML浏览器可打开的网页放到内网供在线查阅Markdown纯文本文档纳入版本库可 diffXML结构化数据文件供脚本解析做二次处理从 0 到第一份文档连接、筛选、点导出先克隆仓库并在本地运行程序git clone https://gitcode.com/gh_mirrors/db/DBCHM选择数据库类型填主机、端口、用户名、密码和目标库点连接程序开始查询表结构信息。在左侧查询框输入关键词模糊搜索表名或用全选/反选批量圈定要导出的表选中的表会列出它的列和注释可直接在列批注列里补充说明再保存。点工具栏对应的格式按钮如CHM导出在保存对话框里选择目录和文件名底部进度条走到操作已完成文档即生成。图填写连接信息并点连接后程序正在查询该库的表结构信息图在查询框输入 account 筛选出相关表右侧可查看并编辑表注释、列名与列批注图点击 CHM 导出后在另存为对话框中选择保存目录和文件名让文档更好用的三个方向按业务模块给表分组这个修改版 DBCHM 的核心卖点就是支持导出数据库字典分组可以按业务模块用户、订单、支付分组按功能类别基础数据、日志表分组也可以按表名前缀tb_、tmp_、view_分组。生成的文档目录按组展开表一多就能省掉翻找时间。改 DocTools/TplFile/ 下的模板换样式文档生成逻辑在DocTools/工程里模板文件集中在DocTools/TplFile/目录chm/下放 CHM 模板目录、索引、表详情等页面模板以及高亮和 SQL 格式化脚本html/下放 HTML 模板pdf/下放 PDF 相关资源。想调整文档外观、字段排列顺序或 SQL 关键字高亮效果改对应模板文件即可chm 和 html 都走模板生成。连接配置保存下来搜索和批量选择复用程序把连接信息存到本地 ini 配置文件仓库根目录可见MySql_dbchm_config.ini、wms_user_config.ini这类样例下次连接直接复用不用重复填写。查询框的模糊搜索配合全选/反选可以把几十张表快速缩小到要导出的几张适合只更新部分模块的场景。出问题怎么办三类常见现象的排查动作连不上数据库→ 按顺序确认网络是否通、数据库服务是否启动、主机/端口/账号/密码是否正确跨机器连接时检查防火墙。连接超时默认 30 秒Oracle 报 ORA-28040 这类认证错误时重点回到账号信息核对。导出过程报错→ 先看程序记录的详细日志常见原因有三个数据库账号没有查询系统元数据的权限、目标目录不可写、磁盘空间不足。逐项确认后重新导出即可。生成格式不满足需求→ 不改代码改模板调整DocTools/TplFile/下的模板文件可修改样式、输出字段和排列顺序改完重新生成对比效果。建议先拿一个测试库把完整流程跑一遍连库、勾选几张表、导出一份 CHM 或 Markdown确认目录、字段、注释都正常再换生产库正式使用。【免费下载链接】DBCHMDBCHM修改版本支持导出数据库字典分组 The modified version of dbchm supports exporting database dictionary groups ( chm/word/markdown/html)项目地址: https://gitcode.com/gh_mirrors/db/DBCHM创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考