【MySQL】COMMENT - テーブル定義・カラム定義のコメント

MySQLのテーブル定義・カラム定義のコメントについて解説します。

検証環境

MySQLはテーブル定義やカラム定義にコメントを付与できます。

主にテーブル情報（SHOW CREATE TABLEやDESC）の補足情報などにコメントを利用します。

COMMENT

コメントはCOMMENTを使います。

テーブル単位、カラム単位でコメントを付けることが可能です。

テーブルコメント

テーブル単位のコメントを付与できます。

基本構文

CREATE TABLE テーブル名 (カラム定義) COMMENT = 'コメント';

テーブル定義の最後にCOMMENT = 'コメント'の形式でコメントを記述します。

サンプル

Command Line

mysql> CREATE  TABLE sample ( num INT ) COMMENT = 'Hello World!';
Query OK, 0 rows affected (0.02 sec)

mysql> SHOW CREATE TABLE sample;
+--------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Table  | Create Table                                                                                                                               |
+--------+--------------------------------------------------------------------------------------------------------------------------------------------+
| sample | CREATE TABLE `sample` (
  `num` int DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='Hello World!' |
+--------+--------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set (0.00 sec)

コメントの確認はSHOW CREATE TABLEで表示します。

カラムコメント

カラム単位のコメントを付与できます。

基本構文

CREATE TABLE テーブル名 (
    カラム定義1 COMMENT 'コメント',
    カラム定義2 COMMENT 'コメント',
    カラム定義3 COMMENT 'コメント'
);

カラム定義の最後にCOMMENT 'コメント'の形式でコメントを記述します。

カラムごとにコメントを付与でき、テーブルコメントとは異なり、イコール（=）は不要です。

サンプル

Command Line

mysql> CREATE TABLE sample (
    -> num1 INT COMMENT 'Hello World!',
    -> num2 INT COMMENT 'Good Morning!'
    -> );
Query OK, 0 rows affected (0.01 sec)

mysql> SHOW CREATE TABLE sample;
+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Table  | Create Table                                                                                                                                                                                   |
+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sample | CREATE TABLE `sample` (
  `num1` int DEFAULT NULL COMMENT 'Hello World!',
  `num2` int DEFAULT NULL COMMENT 'Good Morning!'
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci |
+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set (0.00 sec)

コメントの確認はテーブルコメントと同様にSHOW CREATE TABLEで表示します。