laravel マイグレーションでテーブルコメントをつける

概要

• マイグレーションでテーブルにコメントを付ける方法をまとめる。

ご注意

• 本方法でテーブルにコメントがつけられるのは現在MySQLとPostgresのみである。

方法

• マイグレーションファイルに下記のように記載する。

  /**
   * Run the migrations.
   *
   * @return void
   */
  public function up()
  {
      Schema::create('テーブル名', function (Blueprint $table) {
          $table->comment('テーブルのコメント');
      });
  }
  

• マイグレーションを実行する。

• ちなみに下記SQLを実行した結果のcommentを見ることにより、テーブルのコメントが入っていることを確認できる。

  show table status;