schema to doc

数据字典生成把表头和样本,变成能交付的字段说明

写数据字典最烦的是逐个字段查类型、量长度、找示例。这里接受三种输入:CSV 表头+样本、JSON 数据样本、CREATE TABLE 语句;自动推断整数、小数、日期、布尔、邮箱、手机号等类型,给出最大长度、是否可空与示例值,导出 Markdown 或 Excel 可读的 CSV。

CSV 表头JSON 样本建表 SQL类型推断Markdown / CSV
① 选择来源并粘贴内容
粘贴内容后点「生成数据字典」。

推断基于样本,不等价于数据库真实约束;注释字段建议人工补充。

📚口径说明与常见误填

样本越多推断越准;SQL 输入能直接读出字段备注。

CSV 怎么推断
第一行当表头,后面最多取 100 行做样本。类型按样本值判定:全是整数就写整数,出现空值就标可空,长度取样本最大值。
JSON 怎么处理
数组取所有对象的键并集,单对象取它的键。值为对象或数组时用 JSON 字符串做示例,类型按字符串处理。
SQL 能保留什么
从 CREATE TABLE 语句里读字段名、类型、长度、NOT NULL 与 COMMENT 备注,推断成分更可靠。
推断的边界
样本里没出现的值无法预知;长度是样本最大长度而非字段上限。交付前请对照真实表结构确认。

这个工具解决什么问题

数据字典生成把「表结构文档」从手工活变成一次点击。支持三种输入:CSV(首行表头 + 若干样本行)、JSON(对象或对象数组)、CREATE TABLE SQL。工具推断字段类型、样本最大长度、是否可空与示例值;SQL 输入还会读出 COMMENT 备注。结果同时以表格和 Markdown 预览,可导出 Markdown 直接贴进 Wiki,或导出 CSV 用 Excel 继续补说明。推断基于样本,交付前请对照真实表结构确认。

写数据字典的三条经验

① 多给几行样本:样本越全,类型和长度推断越接近真实约束。

② 备注别省:字段含义比类型更重要,导出后在 Excel 里补注释。

③ 长度当参考:样本最大长度不是字段上限,别直接写进数据库设计。

怎么用

  1. 第 1 步 · 选来源
    CSV、JSON 或 SQL,粘贴内容。
  2. 第 2 步 · 生成
    工具推断类型、长度、可空与示例值。
  3. 第 3 步 · 补说明
    在导出的 CSV 里填字段含义与业务规则。
  4. 第 4 步 · 交付
    Markdown 贴 Wiki,CSV 留档。

更新记录

  • v1.0 2026-11-16
  • 首个版本:CSV/JSON/SQL 三种输入、类型与长度推断、可空判断、Markdown 与 CSV 导出

常见问题

支持哪些输入格式?
CSV(首行表头)、JSON(对象/数组)、CREATE TABLE SQL。
字段类型怎么判断?
按样本值匹配整数、小数、日期、日期时间、布尔、邮箱、手机号等正则,都不匹配就写字符串。
长度是字段上限吗?
不是,是样本中的最大长度。真实上限要看数据库 DDL。
能读 COMMENT 吗?
SQL 输入可以读取 COMMENT 后的字符串作为备注;CSV 与 JSON 没有备注来源。
空值怎么算?
样本中出现空字符串或 null 就标为可空。
数据会上传吗?
不会,推断和导出都在浏览器本地完成。

💬 留言板 0

全部留言需审核通过后展示
💬

还没有留言,来抢沙发吧!

✍️ 说点什么
0 / 500
图形验证码
👣 做完这一步,顺便看看
🧰 乱码修复 / 文本编码转换 在线乱码修复工具:上传乱码文本文件或粘贴乱码字符串,用 UT… → 💻 假装工作模拟器 老板走近工位的一瞬间,点一下就能从摸鱼切回正经工作界面。代码… → 🧰 IP / 子网掩码计算器 在线子网计算器:输入 IP 地址与掩码(CIDR 前缀或点分… → ⏰ 下班倒计时 打工人专属下班计算器:实时倒计时距离下班还有多久、进度环显示… →
全部工具 →