SQLを見やすく整形するメリット｜保守性を高めるコーディング規約

整形前後の比較

整形前

select u.id,u.name,o.total from users u join orders o on u.id=o.user_id where o.status='completed' order by o.created_at desc;

整形後

SELECT
  u.id,
  u.name,
  o.total
FROM
  users u
  JOIN orders o ON u.id = o.user_id
WHERE
  o.status = 'completed'
ORDER BY
  o.created_at DESC;

推奨されるコーディングスタイル

1. 予約語は大文字 — SELECT, FROM, WHERE などを大文字にすると、テーブル名や列名との区別が容易になります。
2. カンマの置く位置 — 行頭にカンマを置くスタイル（カンマファースト）は、コメントアウトや行の入れ替えがしやすいため好まれることがあります。
3. 別名（Alias）を付ける — テーブル名が長い場合は u や o など短い別名を付け、すべての列に u.name のようにテーブル指定を付けると曖昧さがなくなります。

複雑な集計クエリやサブクエリを書く際は、まず整形ツールで構造を整えてからデバッグする習慣をつけると、ミスを劇的に減らすことができます。

関連記事

あわせて読むと理解が深まる関連記事をまとめました。