サイトアイコン IT NEWS

【SQL】見やすさと可読性アップのための改行とインデントの活用法

みなさんはSQL文を書く場合にどのようなことに注意をしていますか?
もちろん、正常に動作することは大前提ですが、自分が後から見返したり、チームで開発をしているのであれば、他の人が見てもわかるように書かなくては、バグの温床になりかねません。

そこで今回は、SQL文を誰が見てもわかるように、美しく書く方法をいくつかご紹介します!

SQL文を見やすくする書き方

SQL文を見やすくする方法はいくつかあります。
一般的な方法は、改行インデント字下げ)を利用することです。
予約語大文字にし、テーブル名に別名を付けることも有効です。
後ほど紹介しますが、無料のツールを使ってSQL文を整形することもできます。

SQLSELECT文を縦に区切って書く場合、以下のような方法があります。

SELECT文の各句を改行してインデント

SELECT
  name,
  age,
  address
FROM
  users
WHERE
  age > 20
ORDER BY
  name;

列名の後にAS句を使って別名を指定

SELECT
 name AS 名前,
 age AS 年齢
FROM
 users;

GROUP BY句と集約関数

SELECT
 gender,
 COUNT(*) AS 人数,
 AVG(age) AS 平均年齢
FROM
 users
GROUP BY
 gender;

SQLの書き方とルール

私はSQL書き方については、客観的な判断をすることができません。
SQL書き方は、目的や好みによって異なるかもしれません。

しかし、SQL書き方には決まったルールがあります。
SQL書き方は、データベースの種類や目的によって異なる場合がありますが、一般的には以下のようなルールがあります。

  • 予約語や関数は大文字にする
  • インデントや改行を入れてコードを整形する
  • カンマやAND/ORなどの記号は先頭に置く
  • 列名やテーブル名に意味のある名前を付ける
  • AS句を使って別名を付ける
  • コメントを入れてコードの意図を説明する
  • 不要な列や条件を省く

これらのルールは、SQL書き方を分かりやすくするために有用です。
しかし、必ずしも厳密に守らなければならないというわけではありません。
自分や他人が読みやすいように工夫してみてください。

【おまけ】SQL自動整形ツール

最後に、SQL文を整形するのにとても便利なSQL自動整形ツールを紹介して終わります。
SQL自動整形ツールとは、SQL文を読みやすくするために、インデントや改行を自動で調整してくれるツールのことで、SQL文の可読性や品質を向上させるために、とても便利なツールです。

ぜひ、活用してみてください!

モバイルバージョンを終了