DBeaver 数据字典快速上手：4 步生成完整数据库文档
【免费下载链接】dbeaverFree universal database tool and SQL client项目地址: https://gitcode.com/GitHub_Trending/db/dbeaver
周一接手一个陌生数据库，下午就要给团队讲表结构。打开 DBeaver，用它的数据字典导出功能，几分钟就能把字段类型、默认值、注释整整齐齐地拿到手，不用手写一个字。
本文讲数据库文档生成和文档自动化：从最短的导出路径，到格式怎么选，再到把文档接进自动更新流程，按需跳章即可。
🚀 30 秒上手：第一次导出表结构
最短路径一共 4 步：
- 连接：导航器里选「新建连接」，挑驱动、填地址和账号，点连接。
- 选对象：左侧树里选中表、视图，或直接选中整个数据库节点。
- 发起导出：右键选「导出数据…」，在对话框里挑 Markdown 等格式。
- 拿结果：指定保存位置，文档文件即刻生成。
整个过程不到一分钟，一行 SQL 都不用写。选数据库节点时，所有表会一起导出，生成的文档包含列类型、可否为空、默认值和注释，就是一份完整的数据字典。
📊 五种输出格式，分别适合谁
| 格式 | 适合谁 | 何时用 |
|---|---|---|
| Markdown | 文档放仓库的开发者 | 进 README 或 docs 目录，git diff 一眼能读 |
| HTML | 想浏览器直接看的 | 发到内网站点，单文件自带样式 |
| JSON | 程序脚本 | 喂给自动处理结构的工具链 |
| CSV | 数据分析 | 直接开 Excel 做二次整理 |
| XML | 系统集成 | 配置导入、跨系统交换 |
选择规则很简单：进仓库选 Markdown，给人看选 HTML，给机器读选 JSON。拿不准就先出 Markdown，后续再转其他格式，返工成本最低。
🔁 把导出接进自动化
手动导出一份，一周后又会过期。DBeaver 数据库文档生成真正的价值在自动化这一环。
单次导出走命令行就够：headless 模式直接连库，把文档写到指定目录，不用打开界面。最小示例：
dbeaver headless \ --url "jdbc:mysql://localhost:3306/mydb" \ --format markdown \ --output ./docs/database接 CI 更简单：在流水线里加一步，定时或在每次推送后执行上面的命令，把生成的文档提交回仓库。代码变、文档跟着变，团队再也不用猜哪份是最新的。
导出逻辑的核心实现位于 plugins/org.jkiss.dbeaver.data.transfer/，想改导出行为可以从那里读起。
⚡ 两个常见导出问题，直接给方案
导出来中文是乱码。编码问题。导出时把文件编码显式指定为 UTF-8，headless 执行时同样检查终端默认编码，重新导一次就好。
大库导得太慢。别一次全量。按库或按表分组分批导出，只保留关心的业务表即可，增量导出比整库全量快得多。
✅ 下一步
- 把上面「4 步」走一遍，导出当前项目的表结构为 Markdown，放进仓库 docs 目录。
- 给流水线加一个定时任务，每晚自动生成文档，随代码一起评审。
- 格式定下来后，把导出参数固定进脚本，以后改模板有依据，不靠手感。
【免费下载链接】dbeaverFree universal database tool and SQL client项目地址: https://gitcode.com/GitHub_Trending/db/dbeaver
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
