10分钟跑通数据库字典导出：手把手从连接数据库到生成CHM文档

10分钟跑通数据库字典导出手把手从连接数据库到生成CHM文档【免费下载链接】DBCHMDBCHM修改版本支持导出数据库字典分组 The modified version of dbchm supports exporting database dictionary groups ( chm/word/markdown/html)项目地址: https://gitcode.com/gh_mirrors/db/DBCHM接手一个老项目同事问account 表里 CurBalanceAmount 字段存的是什么你翻遍代码仓库也没找到表结构文档。DBCHM 解决的就是这个问题连接数据库勾选你要的表一键导出带字段备注的数据库字典文档。先花30秒认清它项目说明定位图形化数据库文档生成工具把表结构、字段类型、备注导出成规范文档输出格式CHM、Word、Excel、PDF、Html、XML 共 6 种支持数据库SQL Server、MySQL、Oracle、PostgreSQL、DB2、SQLite运行平台Windows.NET Framework 4.8双击 exe 即可运行适合人群需要交付/维护数据库字典的开发者、DBA本仓库是 DBCHM 的修改版本额外支持导出数据库字典分组即把表按业务模块归类到同一目录下。动手前克隆仓库git clone https://gitcode.com/gh_mirrors/db/DBCHM关键目录速览DBChm/主程序含界面代码和连接配置样例DBChm/MySql_dbchm_config.iniDocTools/文档生成核心按格式输出DocTools/TplFile/CHM、Html 等格式的模板文件改样式用MJTop.Data/各数据库的连接与元数据读取层运行前提装好 .NET Framework 4.8 的 Windows 机器目标数据库可网络访问数据库账号有查询元数据权限。一次完整的实操第1步配置数据库连接启动 DBChm 后点击工具栏左侧的数据连接按钮弹出数据库连接配置窗口。顶部下拉框选择数据库类型如 SQL Server下方列表会显示你保存过的连接。新增或编辑一条连接填写主机、端口、用户名、密码点连接测试测试通过后窗口中央会显示正在查询表结构信息请耐心等待的加载动画随后右侧出现可选的数据库下拉列表。图1数据连接窗口——选择库类型、填写连接信息、测试并选择目标数据库注意这一步连接只影响能查到什么表不影响后面导出什么内容。确认目标库已选中后点保存关闭连接窗口。第2步筛选并勾选目标表主界面左侧是表清单顶部查询框支持表名模糊搜索。输入accv列表立即过滤出所有匹配的表如 Account、AccountInfo、EnrollAccount 等。图2表名模糊搜索界面——输入关键字过滤表右侧可查看和编辑表批注、列批注此时右侧列批注区显示选中表的字段列表。如果某些字段缺少备注直接在列批注列里补上如给 AccountName 填账户名称点保存固化下来——这些备注会原样写进导出文档。勾选你想导出的表单张表点前面的复选框全部要就点全选排除临时表就点反选再逐个勾选过滤框还能按关键字隐藏表。第3步选定格式并导出表选好后点工具栏的CHM导出。程序会弹出另存为文件对话框选择保存目录文件名如订单库_结构信息.chm保存类型保持.chm点保存。图3CHM导出文件保存界面——选择导出格式为.chm并指定保存路径主界面底部随即出现进度条右侧状态区滚动显示每张表的生成过程。表多的库需要等一两分钟看到操作已完成!即导出成功。图4导出执行进度界面——底部进度条显示生成状况完成后提示操作已完成其余格式同理点Word导出、Excel导出、PDF导出、Html导出、XML导出按钮各自弹出保存对话框即可。拿到文档后怎么看双击生成的 .chm 文件用 Windows 内置帮助查看器打开图5生成的CHM数据库字典文档——左侧目录树按分组展开右侧显示表字段详情左侧目录树列出全部表若配置了分组表会收在对应分组节点下顶部搜索框支持按表名或表注释查找。定位某张表的字段只需两步点目录树里的表名右侧即显示序号、列名、数据类型、长度、主键、默认值、列说明点击某一行该行高亮。30 秒内你就能看到这个字段是什么类型、允不允许空、备注写了什么。让它更快更好看按业务模块分组数据库字典分组是修改版的核心能力。在DBChm/下新建一个 ini 配置文件格式参考DBChm/MySql_dbchm_config.ini[config]下type1表示表名匹配后面每个方括号如[订单信息]是一个分组组下列出表名。场景订单、支付、用户表混在一个库里 → 主界面点加载配置选择该 ini导出后目录树按分组展开。改文档样式CHM 和 Html 用模板渲染场景公司要求文档页眉带项目名 → 编辑DocTools/TplFile/chm/下的table.cshtml、list.cshtml等模板文件重编译 DocTools 项目。批量导出把库里要交付的表一次性全选连点几个导出按钮CHM、Word、Excel 各出一份。连接配置保存连接测试成功后工具会把该连接存进本地配置下次启动直接出现在连接列表里不用再填主机和账号。避坑记录点连接后一直转圈先确认数据库服务已启动、端口没被防火墙拦再用命令行客户端如 sqlplus、mysql验证同一组账号密码能登录工具连接超时默认 30 秒慢网络可在连接里调大。Oracle 报 ORA-28040 认证失败这是客户端认证版本不匹配。到数据库服务器改$ORACLE_HOME/network/admin/sqlnet.ora把SQLNET.ALLOWED_LOGON_VERSION_SERVER和_CLIENT都设为 8再重启监听。参考图图6ORA-28040 排查——修改 sqlnet.ora 的认证版本配置导出的表比预期少检查是否只勾了搜索框过滤后的表、过滤框里是否残留了关键字如copy,bak清空过滤条件重新勾选。备注没进文档列批注编辑后必须点保存按钮才生效仅输入不保存不会写进导出结果。DBCHM 的价值在于把表结构 字段备注这件事从口头交接变成一份可分发的文件。建议把表结构变更提交前先跑一遍导出写进你的开发 checklist下次同事再问字段含义时直接甩文档。【免费下载链接】DBCHMDBCHM修改版本支持导出数据库字典分组 The modified version of dbchm supports exporting database dictionary groups ( chm/word/markdown/html)项目地址: https://gitcode.com/gh_mirrors/db/DBCHM创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考