SQL コードをフォーマットする方法

2024-04-02

SQL 書式標準

SQL は非常に強力な言語ですが、コードの書き方には決まったルールがありません。そのため、コードが読みづらかったり、理解しにくかったりすることがあります。

そこで、SQL コードを分かりやすく、読みやすくするために、SQL 書式標準 が定められています。

SQL 書式標準には、以下のような利点があります。

コードの読みやすさが向上する
チームメンバー間でコードの共有がしやすくなる

SQL 書式標準には、様々なルールがあります。以下に、いくつかの例を紹介します。

キーワードは大文字で書く
識別子は小文字で書く
インデントを使用する
空白行を使用する

SQL 書式標準を自動的に適用するツールがあります。これらのツールを使うと、簡単にコードをフォーマットすることができます。

以下に、いくつかのツールを紹介します。

SQL Formatter
SQL Beautifier
SQL Prompt

SQL 書式標準は、SQL コードを分かりやすく、読みやすくするために定められたルールです。SQL 書式標準を使用することで、コードの保守性や共有性を向上させることができます。

-- テーブル作成
CREATE TABLE employees (
  id INT NOT NULL AUTO_INCREMENT,
  name VARCHAR(255) NOT NULL,
  email VARCHAR(255) NOT NULL,
  department VARCHAR(255) NOT NULL,
  PRIMARY KEY (id)
);

-- データ挿入
INSERT INTO employees (name, email, department)
VALUES ('山田太郎', '[email protected]', '営業'),
       ('佐藤花子', '[email protected]', '人事');

-- データ更新
UPDATE employees
SET department = '開発'
WHERE id = 1;

-- データ削除
DELETE FROM employees
WHERE id = 2;

-- データ取得
SELECT *
FROM employees;

-- データ取得 (条件指定)
SELECT *
FROM employees
WHERE department = '営業';

-- データ集計
SELECT COUNT(*)
FROM employees;

-- 結合
SELECT e.name, e.department, d.location
FROM employees AS e
INNER JOIN departments AS d
ON e.department = d.name;

このコードでは、以下の SQL 書式標準を使用しています。

ツールによるフォーマット

上記のコードを SQL Formatter ツールでフォーマットすると、以下のようになります。

CREATE TABLE employees (
    id INT NOT NULL AUTO_INCREMENT,
    name VARCHAR(255) NOT NULL,
    email VARCHAR(255) NOT NULL,
    department VARCHAR(255) NOT NULL,
    PRIMARY KEY (id)
);

INSERT INTO employees (name, email, department)
VALUES ('山田太郎', '[email protected]', '営業'),
       ('佐藤花子', '[email protected]', '人事');

UPDATE employees
SET department = '開発'
WHERE id = 1;

DELETE FROM employees
WHERE id = 2;

SELECT *
FROM employees;

SELECT *
FROM employees
WHERE department = '営業';

SELECT COUNT(*)
FROM employees;

SELECT e.name, e.department, d.location
FROM employees AS e
INNER JOIN departments AS d
ON e.department = d.name;

ツールによって、フォーマットの詳細が異なる場合があります。

サンプルコードを参考に、SQL 書式標準を意識してコード 작성することをおすすめします。

SQL コードをフォーマットする方法

手動でフォーマットする

エディタや IDE の設定を使用して、インデントや空白行などを自動的に挿入する。
キーワードは大文字で、識別子は小文字で書く。
コメントを記述して、コードを分かりやすくする。

SQL Formatter などのツールを使用して、自動的にコードをフォーマットする。
オンラインの SQL フォーマッターを使用する。

手動フォーマットの例

-- テーブル作成
CREATE TABLE employees (
  id INT NOT NULL AUTO_INCREMENT,
  name VARCHAR(255) NOT NULL,
  email VARCHAR(255) NOT NULL,
  department VARCHAR(255) NOT NULL,
  PRIMARY KEY (id)
);

-- データ挿入
INSERT INTO employees (name, email, department)
VALUES ('山田太郎', '[email protected]', '営業'),
       ('佐藤花子', '[email protected]', '人事');

-- データ更新
UPDATE employees
SET department = '開発'
WHERE id = 1;

-- データ削除
DELETE FROM employees
WHERE id = 2;

-- データ取得
SELECT *
FROM employees;

-- データ取得 (条件指定)
SELECT *
FROM employees
WHERE department = '営業';

-- データ集計
SELECT COUNT(*)
FROM employees;

-- 結合
SELECT e.name, e.department, d.location
FROM employees AS e
INNER JOIN departments AS d
ON e.department = d.name;

上記のコードは、手動でフォーマットした例です。

このコードでは、以下の点に注意しています。

インデントは 2 スペースを使用する。
空白行を使用して、コードの区切りを明確にする。

ツールを使用したフォーマット

CREATE TABLE employees (
    id INT NOT NULL AUTO_INCREMENT,
    name VARCHAR(255) NOT NULL,
    email VARCHAR(255) NOT NULL,
    department VARCHAR(255) NOT NULL,
    PRIMARY KEY (id)
);

INSERT INTO employees (name, email, department)
VALUES ('山田太郎', '[email protected]', '営業'),
       ('佐藤花子', '[email protected]', '人事');

UPDATE employees
SET department = '開発'
WHERE id = 1;

DELETE FROM employees
WHERE id = 2;

SELECT *
FROM employees;

SELECT *
FROM employees
WHERE department = '営業';

SELECT COUNT(*)
FROM employees;

SELECT e.name, e.department, d.location
FROM employees AS e
INNER JOIN departments AS d
ON e.department = d.name;