企业官网建设流程全解析

DBeaver 数据字典导出：数据库文档自动化的完整指南

【免费下载链接】dbeaverFree universal database tool and SQL client项目地址: https://gitcode.com/GitHub_Trending/db/dbeaver

DBeaver 是一款免费的通用数据库管理工具，用它的导出向导就能把表结构直接生成 Markdown、HTML、JSON 等格式的文档，把原来手动整理半天数据字典的活变成几分钟的自动任务。这篇适合新手和 DBA 一起看。

需要数据库结构文档的场景

你多半遇到过这两种情况：发版前运维找你要"最新的表结构文档"；新人接手一个库，打开发现一半字段名看不懂是什么意思。手动逐表复制粘贴又慢，一次发版之后文档就过期了。DBeaver 的数据字典生成功能，就是为这种场景准备的。

3 步导出数据字典

第 1 步：连接数据库。在左侧数据库导航器里创建连接并打开。不管连的是 MySQL、PostgreSQL 还是 SQL Server，后面的操作都一样。

第 2 步：圈定导出范围。在导航器里选中一个数据库、一个 schema，或者几张具体的表。范围选小一点没关系，后面可以补。

第 3 步：打开导出向导，选格式。右键选中的对象，点"导出数据"（Export Data）。在向导里选择输出格式、目标文件和编码，一路确认，文档就生成了。向导里要填的关键项就这几项：

格式 ：Markdown 编码 ：UTF-8 范围 ：第 2 步选中的库/表 输出 ：docs/database.md

注意把输出目录固定下来，比如放在仓库里专门的 database-docs 目录，这样文档能直接进版本管理。

导出格式怎么选

格式不是越多越好，按"文档给谁看、给谁用"来定就行：

默认推荐Markdown：人直接能读，版本 diff 干净，以后想转 HTML 随时可以转。

让文档自动更新

文档生成一次不难，难的是跟上结构变化。比较稳的做法是把生成任务挂进 CI/CD：每次发布后（或每天定时）跑一次无界面导出，结果自动提交进仓库，文档就始终和表结构同步。思路很简单，简化示例如下：

# 发布后自动生成并提交数据字典 /opt/dbeaver/dbeaver --console \ --export mydb --format markdown --output docs/database git add docs && git commit -m "update data dictionary"

具体参数以你本地的 DBeaver 版本为准，核心就一句：定时导出，生成后自动提交。先手动导一次放进仓库，再把它挪进流水线，方向是一样的。

三个常见坑与处理办法

中文注释乱码。导出的文档里注释全是方块，通常是导出时没指定 UTF-8。在向导的编码选项里明确选 UTF-8，之后打开文件检查也用 UTF-8 编辑器，两边一致就不会乱。

大库导出慢。整个实例几百张表一次导完，又慢又容易超时。拆开做：先按 schema 分批导，再只导真正要写进文档的表，系统表和临时表可以跳过。

文档发完就过期。这不是工具的问题，是流程问题。如果不愿意依赖记性，就按上一节挂上自动更新；实在不挂 CI，也给自己立个规矩：改了表结构，当场重新导一次。

数据字典导出是 DBeaver 做数据库文档自动化里门槛最低的入口：不写代码，一次向导操作，文档就出来了。下次有人找你要表结构文档时，先试一次，跑通后再考虑挂进流水线自动更新。

【免费下载链接】dbeaverFree universal database tool and SQL client项目地址: https://gitcode.com/GitHub_Trending/db/dbeaver