DataHub Tools SQL 格式化

SQL 格式化工具

本地优先

格式化常见 SQL SELECT、INSERT、UPDATE 和 WHERE 片段,便于快速阅读。

工具实际如何工作?

工具在本地加载 sql-formatter 15.8.2,采用通用 SQL 规则、关键字大写和两空格缩进。识别 token 的实现修复了旧正则可能改坏字符串和注释的问题,但不会校验数据库语义。

  • 使用 token-aware SQL 格式化
  • 保留字符串和注释
  • 固定关键字大写与两空格缩进

如何使用?

  1. 粘贴 SQL 并保留原始副本。
  2. 使用通用 SQL 规则格式化。
  3. 在识别方言的编辑器中检查厂商语法和占位符。
  4. 执行前通过数据库校验或测试。

快速示例

示例输入

SELECT id, note FROM jobs WHERE note='research and development' AND active=true;

预期结果

WHERE 子句会格式化,引号内的 research and development 保持不变。

格式化会识别 token,但使用通用 SQL 规则;厂商方言、模板和数据库语义仍需复核。

适合哪些场景?

  • 让 SQL 更易检查。
  • 统一文档示例排版。
  • 在方言校验前整理通用 SQL。

参考标准与适用边界

sql-formatter 会对输入进行 token 化并格式化;方言语法和执行语义仍以数据库文档为准。

来源核验日期:2026 年 7 月 24 日。规范与平台行为可能更新,正式使用前请复核来源。

已知限制

  • 当前页面固定使用关键字大写和两空格缩进。
  • 工具不会连接数据库或执行 SQL。
  • PostgreSQL、MySQL、SQLite 等方言仍可能需要不同规则。

FAQ

使用什么格式化库?

页面在浏览器本地加载 sql-formatter 15.8.2。

会保留引号字符串吗?

token-aware 格式化会把字符串和注释与 SQL 关键字分开处理。

会校验 SQL 吗?

不会。格式化不能证明数据库语法或语义正确。

使用哪种方言?

当前采用通用 SQL 格式化,厂商专属语句仍需单独复核。