画布上改表名,SQL自动同步:SQL to ER Diagram双向编辑与新增字段技巧
画布上改表名,SQL自动同步:SQL to ER Diagram双向编辑与新增字段技巧
SQL to ER Diagram 是一款免费开源的在线 ERD 工具:把 CREATE TABLE 语句粘贴进编辑器,立刻得到一张干净、可交互的 ER 图,且 100% 在浏览器本地运行,数据不会上传到任何服务器。它的最大亮点是双向编辑——直接在画布上双击改表名、改字段名,左侧的 SQL 会即时同步更新;还能在画布上点"+ add column"给表新增字段,自动按你选择的数据库方言生成合适的类型。
什么是"双向编辑"?和普通 ERD 工具有什么区别?
大多数 ER 图工具是"只读"的:图只是 SQL 的镜像,想改结构只能回到编辑器里改 SQL,再重新渲染。
SQL to ER Diagram 反了过来——画布本身就是编辑器:
| 你在画布上的操作 | SQL 里发生的事 |
|---|---|
| 双击表名修改 | 表名被替换,且所有指向该表的 REFERENCES 自动同步更新 |
| 双击字段名修改 | 字段名被替换,表级 PRIMARY KEY / FOREIGN KEY / UNIQUE 子句中的引用一并更新 |
| 双击字段类型修改 | 类型被替换,输入时还有方言感知的类型建议 |
| 点击表后选 + add column | 一条带默认类型的新字段定义插入到该表的 CREATE TABLE 中 |
整个流程不经过"重新生成",而是对原始 SQL 做精准的最小改动,你的注释、格式、手写内容都不会被破坏。
三步在画布上重命名表,外键引用自动跟着改
这是双向编辑最实用的场景。步骤如下:
- 双击画布中任意表格的表名(顶部深色标题栏位置),表名会变成可编辑的输入框;
- 输入新名称,按回车确认;
- 观察左侧 SQL 面板——不只是
CREATE TABLE里的名字变了,所有引用这张表的外键子句也同步改名了。
以项目自带的电商示例(见 src/examples.js)为例:orders 表通过 FOREIGN KEY (user_id) REFERENCES users(id) 关联 users 表。如果你把 users 重命名为 members,SQL 会自动改写为 REFERENCES members(id),不会出现"图改了、SQL 里还是旧名字"的错位问题。
这个行为由 src/edit.js 中的 applyEdit 实现:它在解析阶段就记录了表名和每处 REFERENCES 在原文中的精确位置(source span),改名时逐处替换,逻辑见 src/main.js 的 onEdit 回调。
💡 小细节:重命名后表格在画布上的位置保持不变,不会触发重新排布,视觉上一切平滑衔接。
新增字段技巧:点 + add column,类型自动匹配方言
想在画布上给某张表加一个字段?
- 单击该表格——表格会进入"钉住"(pin)状态,下方出现 + add column 按钮;
- 点击按钮,SQL 中立刻插入一行新字段定义,例如 PostgreSQL 方言下插入
new_column text; - 内联编辑框自动打开,直接把字段命名为你需要的名字,回车完成。
几个值得知道的机制:
- 默认类型跟随方言:工具栏的方言下拉框支持 PostgreSQL / MySQL / SQLite / SQL Server / Snowflake,各自的新建字段默认类型不同(如 MySQL 用
varchar(255),SQL Server 用nvarchar(255)),定义集中在 src/dialects.js; - 字段名自动去重:默认名是
new_column,若已存在会自动变成new_column_2、new_column_3……; - 缩进风格自适应:插入的字段会沿用你 SQL 原有文件的缩进与换行风格,多行表和单行表都能正确处理,实现见 src/edit.js 的
addColumn函数。
改字段类型时,享受"方言感知"的智能提示
双击任一字段右侧的类型列,同样会弹出内联编辑器。此时输入框挂上了 datalist 建议源,你会看到当前方言的常用类型清单,例如:
| 方言 | 默认类型 | 候选类型(节选) |
|---|---|---|
| PostgreSQL | text |
integer、timestamptz、jsonb、uuid |
| MySQL | varchar(255) |
bigint、decimal(12,2)、datetime、enum |
| SQLite | TEXT |
INTEGER、REAL、BLOB |
| SQL Server | nvarchar(255) |
int、datetime2、uniqueidentifier |
| Snowflake | VARCHAR |
NUMBER(12,2)、TIMESTAMP_NTZ、VARIANT |
完整交互逻辑在 src/diagram.js:双击定位到表名/字段名/字段类型三类目标之一(_editTargetAt,见 src/diagram.js),弹出与单元格等宽等高的输入框,字号随缩放级别联动,体验上就像在表格软件里编辑单元格。
为什么你的 SQL 不会被"洗掉"?
传统"解析 → 重建 SQL"的方案会把注释和自定义格式全部丢弃,这是很多开发者不敢用可视化工具的原因。
SQL to ER Diagram 采用的是外科手术式编辑(surgical text edit):
- 解析器在解析时就记录每个标识符(表名、字段名、类型)在原文中的起止偏移;
- 任何一次画布编辑,只替换被触及的那几段字符,其余部分(注释、空行、不支持的子句)原样保留;
- 多处替换按从右到左的顺序应用(src/edit.js),避免偏移量错位。
所以你可以放心:改完画布,左边那份精心维护的 DDL 依然整洁如初。
编辑完之后的收尾动作:保存、分享、导出
修改完成后的配套功能都在顶部工具栏(见 index.html):
- Save / Open:把 SQL + 布局 + 方言保存为
.json项目文件,下次一键打开; - Share:把整个项目 gzip 压缩后编码进 URL 的
#片段,复制链接即可分享——片段不会发送到任何服务器,零后端; - Export:导出 PNG(位图)、SVG(矢量),还可以导出为 Mermaid / DBML / PlantUML 文本格式,方便贴进文档;
- Arrange(或快捷键
⌘ / Ctrl + Enter):一键重新自动排版,菜单里可选横向/纵向方向和紧凑/舒适/宽松间距。
快速参考:常用操作对照表
| 操作 | 方式 |
|---|---|
| 重命名表 / 字段 / 改类型 | 双击对应单元格 |
| 新增字段 | 单击钉住表格 → + add column |
| 聚焦单表关系 | 悬停高亮、单击钉住、点空白处清除 |
| 重新自动排版 | ⌘ / Ctrl + Enter 或 Arrange 按钮 |
| 放大 | 双击画布空白处 / 滚轮 |
| 隐藏 SQL 面板看全图 | 工具栏 ⬚ 按钮 |
关键源码位置速查
想深入了解或二次开发,可以从这几个文件入手:
- 画布编辑 → SQL 改写核心:src/edit.js
- 编辑回调与方言选择:src/main.js
- 画布交互(双击、钉住、内联编辑框):src/diagram.js
- 各数据库方言类型表:src/dialects.js
- 内置示例电商 Schema:src/examples.js
- 项目说明:README.md
总的来说,SQL to ER Diagram 把"改结构"这件事从代码编辑器里搬到了画布上:双击即改、点一下就加字段,而 SQL 始终作为唯一事实源被精准同步——这正是双向编辑最该做到的样子。
