既存のMySQLテーブルのカラムにコメントを設定する方法

MySQLテーブルのカラムにコメントを追加するには

既存のMySQLテーブルのカラムにコメントを追加したい場合は、ALTER TABLEコマンドでカラムを変更する際にCOMMENTキーワードを使用します。

例えば、testingテーブルのidカラムにコメントを付けたい場合、次のようなクエリを実行します。

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ステートメントを実行して、カラムの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)

ポイント

• MODIFY句を使う場合は、既存のデータ型（上記の例ではINT）も忘れずに指定する必要があります。
• コメントは日本語でも設定可能ですが、その際はテーブルや接続の文字セット（utf8mb4など）に注意してください。
• 複数のカラムにコメントを付ける場合は、カンマで区切って複数のMODIFY句を1つのALTER TABLE文にまとめると効率的です。