SQL Formatter

粘贴 SQL 语句，一键格式化或压缩

关键字大写缩进：

输入 SQL

格式化结果

结果将在此处显示

📖 SQL 格式化最佳实践

良好的 SQL 书写风格能够极大地提升代码的可读性和可维护性，尤其是在团队协作和代码审查时。无论是简单的查询还是复杂的多表关联，规范的格式都能帮助开发者快速理解语义。

主要格式化规则

规则	说明	示例
关键字大写	SQL 关键字使用全大写，与用户标识符区分	`SELECT`、`FROM`、`WHERE`
主子句换行	SELECT / FROM / WHERE / JOIN 等主要子句单独占一行	每个子句顶格或缩进对齐
列名缩进	SELECT 后的列名列表相对主关键字缩进一级	4 个空格或 1 个 Tab
括号对齐	嵌套子查询的括号单独一行，内部内容缩进	与外层语句保持层级关系
逗号前置/后置	列名之间的逗号统一放在行末或行首，保持一致	`id,` 或 `, id`

常用 SQL 关键字分类

类别	关键字
查询	`SELECT` `FROM` `WHERE` `GROUP BY` `HAVING` `ORDER BY` `LIMIT` `OFFSET`
联接	`JOIN` `INNER JOIN` `LEFT JOIN` `RIGHT JOIN` `FULL JOIN` `CROSS JOIN` `ON`
操作符	`AND` `OR` `NOT` `IN` `NOT IN` `LIKE` `BETWEEN` `IS NULL` `EXISTS`
数据操作	`INSERT INTO` `VALUES` `UPDATE` `SET` `DELETE FROM`
集合操作	`UNION` `UNION ALL` `INTERSECT` `EXCEPT`
DDL	`CREATE TABLE` `ALTER TABLE` `DROP TABLE` `INDEX`

格式化前后对比

-- 格式化前（压缩写法）
select u.id,u.name,o.total from users u left join orders o on u.id=o.user_id where u.status=1 and o.total>100 order by o.total desc limit 20

-- 格式化后
SELECT
    u.id,
    u.name,
    o.total
FROM users u
LEFT JOIN orders o ON u.id = o.user_id
WHERE u.status = 1
    AND o.total > 100
ORDER BY o.total DESC
LIMIT 20

SQL 注释规范

-- 注释内容：单行注释，适用于对某一行 SQL 的解释
/* 注释内容 */：多行注释，适用于大段说明或临时注释掉代码块
建议在复杂查询的每个主要子句前添加注释，说明该步骤的业务含义

性能相关的书写建议

避免使用 SELECT *，明确指定所需列名，减少数据传输量
WHERE 条件中避免对索引列使用函数（如 WHERE YEAR(create_time) = 2024 会导致全表扫描）
大表 JOIN 时，将小表或过滤后行数少的结果集放在驱动表位置
子查询能用 JOIN 替代时优先使用 JOIN，便于优化器选择更优执行计划
使用 LIMIT 分页时，配合索引覆盖扫描（覆盖索引）可以大幅提升深翻页性能

💡 小贴士：SQL 格式化不仅是美观问题，更是工程习惯。统一的格式风格能让 Code Review 时聚焦在逻辑变化而非格式差异上。推荐团队内部约定一套格式规范（例如 SQLFluff 或 sql-formatter 的默认风格），并集成到 CI/CD 流程中自动检查，确保代码库风格一致。