SQLを見やすく整形するメリット|保守性を高めるコーディング規約
SQL データベース 開発効率
結論
SQLは「書く時間」より「読む時間」の方が長い。 キーワードを大文字にし、適切なインデントを付けることで、結合(JOIN)や条件(WHERE)の構造が一目で把握できるようになります。
整形前後の比較
整形前
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;
🗃️ この場でSQLを整形する
推奨されるコーディングスタイル
- 予約語は大文字 —
SELECT,FROM,WHEREなどを大文字にすると、テーブル名や列名との区別が容易になります。 - カンマの置く位置 — 行頭にカンマを置くスタイル(カンマファースト)は、コメントアウトや行の入れ替えがしやすいため好まれることがあります。
- 別名(Alias)を付ける — テーブル名が長い場合は
uやoなど短い別名を付け、すべての列にu.nameのようにテーブル指定を付けると曖昧さがなくなります。
複雑な集計クエリやサブクエリを書く際は、まず整形ツールで構造を整えてからデバッグする習慣をつけると、ミスを劇的に減らすことができます。