はじめに
当記事は、Laravelのマイグレーションファイルでカラムにコメントをつける方法、およびmysqlでそのカラムにつけられているコメントを確認する方法を書いています。
#経緯
先日、業務内でデータベースのカラムにコメントがつけられていないために、間違った設計を行ってしまったことがありました(自己責任です)。
やはり、テーブル名、カラム名から推測しにくかったり、外部にも同名のカラムがあって、且つ意味するものが違う場合などはカラムにコメントを付けたほうが良いと思います。
マイグレーションファイルの記述
二行目のcomment()
でカラムにつけるコメントを記述する。
migration.php
Schema::create('users', function (Blueprint $table) {
$table->string('name')->comment('名前');
});
##MySQLでの確認方法
show full columns from users;
右端のcommentのところに名前
と出てますね。
+-------------------+---------------------+--------------------+------+-----+---------+----------------+---------------------------------+---------+
| Field | Type | Collation | Null | Key | Default | Extra | Privileges | Comment |
+-------------------+---------------------+--------------------+------+-----+---------+----------------+---------------------------------+---------+
| name | varchar(255) | utf8mb4_unicode_ci | NO | | NULL | | select,insert,update,references | 名前 |
#終わりに
カラムにコメントがあった方が、後々プロジェクトに参加してくるエンジニアさんにも親切ですね。