DBeaver 数据字典生成与文档自动化指南

DBeaver 数据字典生成与文档自动化指南【免费下载链接】dbeaverFree universal database tool and SQL client项目地址: https://gitcode.com/GitHub_Trending/db/dbeaver周五下午甲方催要数据库文档两百多张表躺在库里谁也不会一行行手抄。这时候 DBeaver 数据字典能力最省事结构直接从元数据里导出来改完表结构重跑一遍就是最新版。下面是这套流程的实战笔记。一分钟跑通从连库到 Markdown 文件的最短路径先让读者拿到结果。最短路径四步Database Navigator 里右键连接节点或具体的表节点选「导出数据」格式下拉里选 Markdown确认输出目录在对象选择步骤勾选要导出的表下一步点完成目标目录里会落出一个.md文件。五种格式的导出器实现都在 plugins/org.jkiss.dbeaver.data.transfer/ 插件里MarkdownTable、HTML、JSON、CSV、XML各有对应类想改输出行为可以直接从这里入手。导出格式怎么选一张决策表定格式你的目的选它说明文档进仓库、给同事查Markdown进版本控制diff 干净wiki 直接渲染交付客户或内部知识库HTML自带样式浏览器打开即可读程序消费、二次加工JSON结构化脚本好解析运营/分析同学自己统计CSVExcel 直接打开零成本系统间交换、老集成XML标签化老系统吃得下原则很简单人读选 Markdown/HTML机器读选 JSON/CSV/XML。拿不准就先 Markdown改库结构后重导一次git diff 就是字段级变更日志。从单表到整库三种导出粒度怎么配单表右键表节点走同一个「导出数据」产物只含这张表的字段、类型、约束、默认值和注释。库级右键连接节点对象选择步骤选整库勾选「包含视图和同义词」表、视图、索引、外键一次出全。过程对象存储过程不在数据导出范围对过程节点选「导出 DDL」拿到 CREATE 语句再和前面拼进同一份文档。CLI 下三种粒度是同一套参数对象范围不同而已dbeaver -console \ -driver mysql -url jdbc:mysql://10.0.0.8:3306 \ -user doc -password $DB_PASS \ -command export-database \ --format markdown \ --output docs/dbdict \ --tables \*\ \ --include-views --include-procedures用 CLI 和 CI 让数据库文档自动生成上面命令在开发机、脚本、runner 里行为一致所以数据库文档自动生成基本就是「命令 定时器」两件事。最短的 CI 骨架jobs: dbdict: runs-on: ubuntu-latest steps: - run: | tar -xzf dbeaver-ce-linux.tar.gz ./dbeaver/dbeaver -console -command export-database --format markdown --output docs/dbdict - uses: actions/checkoutv3 with: path: docs-repo ref: gh-pages - run: cp -r docs/dbdict docs-repo/ cd docs-repo git add -A git commit -m auto dict $(date %F) git push要点只有一个runner 是无状态环境连接串和密码从 secrets 取产物推到单独的 docs 分支。无人值守跑批时DBeaver 的 headless 支持在 plugins/org.jkiss.dbeaver.headless/ 插件里参数细节以你安装的版本--help为准别照抄博客。文档没告诉你的 3 个坑乱码、慢导出与模板路径坑1中文注释导出成乱码。原因是字符集没显式声明控制台按默认编码解析。解法导出命令加--encoding UTF-8老版本则用 JVM 参数-Dfile.encodingUTF-8跑。坑2大库导出慢到像挂死。元数据是逐对象查的串行且走网络往返几百张表要等几分钟。解法低峰期跑或按 schema 拆成几批并行导出别在白天高峰期触发。坑3模板路径找不到。CI 里工作目录和开发机不同相对路径直接失效。解法模板和输出都用绝对路径先在 runner 里echo $PWD确认工作目录再改。顺带一提界面文案的中文本地化在 plugins/org.jkiss.dbeaver.data.transfer/OSGI-INF/l10n/bundle_zh.properties导出向导看不懂某个选项名时可以对照着查。明天就能动手的 3 件事挑一张被问得最多的表走一遍导出向导生成 Markdown贴进 wiki顺手把缺失的字段注释补上。把库级导出命令写成一个 shell 脚本挂 crontab 或 CI 定时任务让文档每天凌晨自己更新。用 JSON 格式多导一份接进内部的元数据服务后续做字段变更告警就有现成的结构化输入。【免费下载链接】dbeaverFree universal database tool and SQL client项目地址: https://gitcode.com/GitHub_Trending/db/dbeaver创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考