MySQLのテーブルやカラムにコメントをつける方法

2018.10.11

はじめに

MySQLではテーブルや、カラムにコメントをつけることができます。コメントに日本語で和名を書いたり、格納する値に関する情報を書いておくと後でみたときに役に立ちます。いちいち定義書を見なくても、ちょっとしたことなら分かるようにできます。

カラムにコメントをつける方法

commentの後ろにスペースを開けて、記述することでコメントをつけることができます。

CREATE TABLE tableName (
    col1 int comment 'カラムのコメントです',
    col2 varchar(100) comment 'カラムのコメントです'
)
default charset=utf8

テーブルにコメントをつける方法

カラムのときと同様に、commentの後ろにスペースを開けて、記述することでコメントをつけることができます。 記述する位置はCREATE文の一番下です。

CREATE TABLE tableName (
    col1 int comment 'カラムのコメントです',
    col2 varchar(100) comment 'カラムのコメントです'
)
default charset=utf8
comment='テーブルのコメントです';