SQLの整形：具体的な進め方、ツール活用についても解説します。

2023.04.20 株式会社システムインテグレータ

SQL文の整形は、コードの可読性を向上させ、チームメンバー間のコミュニケーションをスムーズにするために重要なスキルです。本記事では、SQLコードの可読性を向上させるためのベストプラクティスをご紹介します。
Young businessman with tablet in hands against digital background

今回は例として以下のSQLを整形し、可読性を高めていきます。

例：

select users.id, usars.name, users.age, countries.name as country_name from users inner join countries on users.country_id = countries.id

where users.age >= 30 and ( users.country = 'Japan' or users.country = 'USA');

キーワードを大文字にする

SQLのキーワード（SELECT, FROM, WHEREなど）は、大文字で記述することで、コードの構造を明確にし、可読性を向上させます。

例：

SELECT users.id, users.name, users.age, countries.name AS country_name FROM users INNER JOIN countries ON users.country_id = countries.id

WHERE users.age >= 30 AND (users.country = ‘Japan’ OR users.country = ‘USA’);

長いリストや式を改行で分割する

複数のカラムや条件を含む場合、適切な改行を使用してコードを整理し、可読性を向上させます。

例：

SELECT
users.id,
users.name,
users.age,
countries.name AS country_name
FROM users
INNER JOIN countries ON users.country_id = countries.id

WHERE users.age >= 30 AND (users.country = ‘Japan’ OR users.country = ‘USA’);

インデントを活用する

インデントを使用して、SQLクエリの階層構造を明確に示すことができます。これにより、クエリの構成要素が一目でわかりやすくなります。

インデントをつけるポイントは以下のとおりです。
・半角スペース（2文字～4文字程度）、またはタブ文字でインデントする
・AND/ORは行の先頭に記載（かっこがある場合など意味によっては1行にまとめる）
・「=」「>」「<」などの記号の前後は半角スペース

例：

SELECT
users.id,
users.name,
users.age,
countries.name AS country_name
FROM users
INNER JOIN countries
ON users.country_id = countries.id
WHERE users.age >= 30

AND (users.country = 'Japan' OR users.country = 'USA');

一貫したエイリアス（※）の使用

テーブルやカラムにわかりやすいエイリアスを使用することで、コードの可読性が向上します。エイリアスは一貫性を持って使用し、他の開発者が理解しやすいようにすることが重要です。

※エイリアスとは、一言で言うと、「別名」です。テーブル名やカラム名に短い名前を割り当てたものを指します。

例：

SELECT
u.id,
u.name,
u.age,
c.name AS country_name
FROM users AS u
INNER JOIN countries AS c
ON u.country_id = c.id
WHERE u.age >= 30
AND (u.country = 'Japan' OR u.country = 'USA');

適切なカラム順序

SELECT文で指定するカラムの順序は、できるだけ自然で理解しやすいものにすることが望ましいです。一般的には、主キーや外部キー、その他の重要なカラムを最初に指定し、その後に関連するカラムを続けます。

コメントの活用

複雑なクエリや特定の処理について、他の開発者が理解しやすいようにコメントを記述することが重要です。コメントは、コードの意図や目的を明確に伝える役割を果たします。

例：

--年齢が30歳以上で、国籍が日本またはアメリカのユーザーを取得
SELECT
u.id,
u.name,
u.age,
c.name AS country_name
FROM users AS u
INNER JOIN countries AS c
ON u.country_id = c.id
WHERE u.age >= 30

AND (u.country = 'Japan' OR u.country = 'USA');

一貫したコーディングスタイル

チーム全体で一貫したコーディングスタイルを採用することで、コードの可読性が向上し、コードレビューや保守が容易になります。チーム内でスタイルガイドを策定し、それに沿ってコーディングを行いましょう。

ツールを活用する

SQL整形ツールやプラグインを活用することで、コードの整形やリファクタリングを容易に行うことができます。これらのツールは、コードの可読性を向上させるだけでなく、一貫したコーディングスタイルを維持するのに役立ちます。

ツールの活用に関する注意点

ツールやプラグインを活用する際には、いくつかの注意点があります。以下のポイントに留意して、適切にツールを活用しましょう。

・チームの要件や開発環境に適したものを選ぶ
・ツールの設定やカスタマイズをする
・ツールの過信を避け、出力を確認する
・ツールのアップデートによる機能・セキュリティの変更点に注意を払う

まとめ

SQL文の整形に関するベストプラクティスを適用することで、コードの可読性が向上し、開発効率やチーム間のコミュニケーションがスムーズになります。キーワードの大文字化、インデントの活用、エイリアスの一貫性、適切なカラム順序、コメントの記述、適切な改行、サブクエリのラベル付け、短い行の結合、一貫したコーディングスタイル、そしてツールの活用を心がけましょう。これらのベストプラクティスを継続的に適用することで、高品質なSQLコードを維持することができます。

－－－－－参考情報－－－－－
■TV出演動画：ええじゃない課Biz（2022/05/29 放送 TOKYO MX）
アンタッチャブル柴田さん、アルコ＆ピースさんがレギュラーのビジネス情報番組「ええじゃない課Biz」にて、プログラミングスキル判定サービス「TOPSIC」と企業・学校対抗プログラミングコンテスト「PG BATTLE」のご紹介をさせていただきました。