MySQLテーブルに列コメントを追加する方法とは？初心者向けチュートリアル

2024-06-14

MySQLテーブルに列コメントを追加する方法

例

-- usersテーブルの`age`列にコメントを追加
ALTER TABLE users
MODIFY age INT(3) COMMENT '年齢';

オプションの説明

MODIFY：列のデータ型を変更する場合に使用します。既存のカラム値は、可能な限り新しい型に変換されます。
CHANGE：列の名前を変更する場合に使用します。

コメントの書き方

コメントは、単一引用符または二重引用符で囲まれた文字列として指定します。コメント内では改行や特殊文字を使用することができます。

注意点

列コメントは、テーブルの構造を変更する操作ではないため、単独で実行できます。
コメントは、情報共有の目的で使用されます。MySQLは、クエリの実行時にコメントを解析しません。

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

-- employeesテーブルの列にコメントを追加
ALTER TABLE employees
MODIFY id INT(11) AUTO_INCREMENT COMMENT '従業員ID',
MODIFY name VARCHAR(255) NOT NULL COMMENT '従業員名',
MODIFY email VARCHAR(255) UNIQUE NOT NULL COMMENT 'メールアドレス',
MODIFY department VARCHAR(255) NOT NULL COMMENT '部署',
MODIFY hire_date DATE NOT NULL COMMENT '入社日';

-- employeesテーブルの列コメントを確認
SHOW CREATE TABLE employees;

このコードは、employeesという名前のテーブルを作成し、そのテーブルの列にコメントを追加する例です。

CREATE TABLEステートメントを使用して、employeesテーブルを作成します。
ALTER TABLEステートメントのMODIFYオプションを使用して、employeesテーブルの列にコメントを追加します。

このサンプルコードを参考に、ご自身のニーズに合わせて列コメントを追加してください。

MySQLテーブルに列コメントを追加するその他の方法

GUIツールを使用する

MySQL WorkbenchなどのGUIツールを使用すると、列コメントを簡単に追加できます。これらのツールには、テーブル構造を視覚的に編集できるインターフェースがあり、コメントを直接入力するだけで済みます。

ORMを使用する

Object-relational mapping (ORM)ツールを使用すると、コードから列コメントを定義できます。ORMツールは、データベーステーブルとオブジェクト間のマッピングを自動的に生成するため、列コメントを個別に設定する必要がなくなります。

INFORMATION_SCHEMAデータベースには、COLUMNSテーブルというテーブルがあり、すべてのテーブルの列に関する情報が含まれています。このテーブルを使用して、列コメントを手動で追加または更新することができます。

-- employeesテーブルの`email`列にコメントを追加
UPDATE INFORMATION_SCHEMA.COLUMNS
SET COLUMN_COMMENT = 'メールアドレス'
WHERE TABLE_SCHEMA = 'mydb'
  AND TABLE_NAME = 'employees'
  AND COLUMN_NAME = 'email';