使用帮助 · FieldDoc
3 分钟上手 FieldDoc,从连接数据库到导出专业字段字典
FieldDoc 是什么
FieldDoc 是一款纯本地运行的数据库字段字典生成工具。 它通过只读方式连接你的数据库,自动读取全部表结构、字段名、类型、长度、主键、是否可空、默认值和注释, 一键导出为 Excel、Word、Markdown 三种格式的专业文档。
- 支持 6 种数据库:SQL Server、Oracle、MySQL、PostgreSQL、MongoDB、SQLite
- 数据不出本机:只读取元数据,绝不读取业务数据
- 免安装:单文件 exe,解压即用,无需 .NET 环境
- 30 秒出文档:百张表秒级生成,比手写快上百倍
三步生成数据库文档
选择数据库类型,填写连接信息
在顶部下拉框选择你的数据库类型(SQL Server / MySQL / Oracle / PostgreSQL / MongoDB / SQLite)。
- SQL Server:服务器名或 IP,端口默认 1433(可留空)
- MySQL:主机 IP,端口 3306
- Oracle:主机 IP,端口 1521,数据库名填服务名(如 ORCL)
- PostgreSQL:主机 IP,端口 5432
- MongoDB:主机 IP,端口 27017,数据库名填库名
- SQLite:直接选择 .db / .sqlite 文件
填完点「测试连接」可验证是否连通。
点击「加载表结构」
软件自动扫描数据库中的全部用户表,左侧列表展示所有表名,右侧表格展示选中表的字段明细。
- 左侧表列表:点击任意表名切换查看
- 右侧字段明细:字段名、类型、长度、主键、允许空、默认值、注释
- Oracle 额外提供「Schema」输入框,可指定只读取某一个 schema
系统表、Apex 内部表等会自动过滤,只显示业务表。
导出文档
点击工具栏的「导出 Markdown」「导出 Word」「导出 Excel」按钮,选择保存位置即可。
- Markdown:适合放进 Wiki、Git 仓库、Confluence
- Word:适合交付文档、项目验收、打印归档
- Excel:适合技术评审、数据字典维护
导出的文档包含表清单 + 每张表的完整字段明细。
授权与激活
免费版 / 30 天免费试用 / 个人版
免费版
读取 / 导出前 5 张表,可体验完整流程。无需注册、无需激活,下载即用。
30 天全功能试用
打开软件点击「免费试用」,按机器码自动申请 30 天全功能试用令牌(无需授权码),试用期内全部表无限制读取与导出;到期后自动回到免费版。
个人版 ¥69/年
全部表无限制读取与导出,支持全部 6 种数据库。一个授权码绑定一台设备,有效期一年。
激活流程
- 加客服 QQ / 微信,说明购买个人版,转账 ¥69
- 客服生成授权码(格式如
XXXX-XXXX-XXXX-XXXX)发送给你 - 打开 FieldDoc,点击右上角「激活」,输入授权码
- 软件自动绑定当前电脑,右上角显示「已激活」即完成
还没决定购买?可先点击「免费试用」申请 30 天全功能试用,满意后再购买激活。
常见问题
Q:连接数据库时报"网络相关错误"?
检查:① 数据库服务是否启动 ② 防火墙是否开放对应端口 ③ SQL Server 需开启「允许远程连接」和 TCP/IP 协议 ④ Oracle 需确认服务名(不是 SID)和监听端口 1521。
Q:连接 MySQL 报 Unknown column 'TABLE_COMMENT'?
已在最新版本修复。请确认下载的是 v1.0.0 或更新版本,旧版本请重新下载。
Q:有免费试用吗?怎么开启?
有。新用户可免费试用 30 天全功能:打开软件点击「免费试用」,软件按当前电脑机器码自动向授权服务器申请试用令牌,无需授权码,试用期内全部表无限制读取与导出;到期后自动回到免费版(前 5 张表)。同一台电脑同一工具仅可试用一次。
Q:免费版有哪些限制?
免费版读取 / 导出前 5 张表,可体验完整流程。可先申请 30 天全功能免费试用体验无限制导出,或激活个人版后不限表数。
Q:换电脑后授权怎么办?
授权码绑定设备。换电脑前联系客服解绑,在新电脑上重新激活即可。
Q:数据安全吗?会不会泄露我的业务数据?
FieldDoc 纯本地运行,只读取数据库元数据(表结构、字段定义),绝不读取任何业务数据行。软件不联网上传任何内容,可放心使用。