MySQLのALTER TABLEコマンドでカラムにコメントを追加する方法

MySQLでは、ALTER TABLEコマンドでカラムを変更する際に「COMMENT」キーワードを使用することで、カラムにコメントを追加できます。コメントはテーブル構造をドキュメント化するのに役立ち、後からデータベースを参照する開発者にとって貴重な情報となります。

例えば、テーブル「testing」のカラム「id」にコメントを追加したい場合は、以下のようにMODIFY句とCOMMENTキーワードを組み合わせたクエリを実行します。

mysql> ALTER TABLE testing MODIFY id INT COMMENT 'id of employees';
Query OK, 0 rows affected (0.07 sec)
Records: 0 Duplicates: 0 Warnings: 0

追加したコメントの確認方法

コメントが正しく登録されたかどうかは、SHOW FULL COLUMNSステートメントで確認できます。このコマンドを実行すると、各カラムの詳細情報（データ型、照合順序、NULL許可、キー、デフォルト値、権限など）に加えて、Commentフィールドに設定されたコメントも表示されます。

mysql> Show full columns from testing\G
*************************** 1. row ***************************
      Field: id
       Type: int(11)
 Collation: NULL
       Null: NO
        Key: PRI
    Default: 0
      Extra:
Privileges: select,insert,update,references
    Comment: id of employees
*************************** 2. row ***************************
      Field: Name
       Type: varchar(20)
 Collation: latin1_swedish_ci
       Null: YES
        Key:
    Default: NULL
      Extra:
Privileges: select,insert,update,references
    Comment:
2 rows in set (0.05 sec)

出力結果を見ると、カラム「id」のCommentフィールドに「id of employees」というコメントが登録されていることがわかります。一方、コメントが設定されていないカラム（例：「Name」）では、Commentフィールドが空欄のまま表示されます。

注意点

MODIFY句を使用する場合は、既存のカラム定義（データ型やNULL制約など）をすべて含めて記述する必要があります。定義を省略してしまうと、意図せず元の設定が失われる恐れがあるため、実行前に現在のカラム定義を確認しておくことをおすすめします。