laravel DBのカラムコメントを修正するマイグレーションファイルの記載

概要

• laravelのマイグレーションファイルにて、カラムコメントを修正、変更する方法についてまとめる。

方法

1. マイグレーションファイルを作成する。（--table=テーブル名以外のコマンドの引数は極論なんでもいい。なんのマイグレーションファイルかをファイル名から推測するため下記のような名前に下だけである。）

   php artisan make:migration change_テーブル名_カラム名_comment --table=テーブル名
   

2. マイグレーションファイルを開き下記の様に記載する。（hoge_hogesテーブルのfoo_idカラムのコメントを変更することを想定して記載してみる。）

   • 当該カラムに既にコメントが記載されている場合

     YYYY_MM_DD_XXXXXX_change_hoge_hoges_foo_id_comment.php

     <?php
     
     use Illuminate\Database\Migrations\Migration;
     use Illuminate\Database\Schema\Blueprint;
     use Illuminate\Support\Facades\Schema;
     
     class ChangeHogeHogesFooIdComment extends Migration
     {
         /**
          * Run the migrations.
          *
          * @return void
          */
         public function up()
         {
             Schema::table('hoge_hoges', function (Blueprint $table) {
                 $table->integer('foo_id')->comment('変更後コメント')->change();
             });
         }
     
         /**
          * Reverse the migrations.
          *
          * @return void
          */
         public function down()
         {
             Schema::table('hoge_hoges', function (Blueprint $table) {
                 $table->integer('foo_id')->comment('変更前コメント')->change();
             });
         }
     }
     

   • 当該カラムにコメントが設定されていない場合

     YYYY_MM_DD_XXXXXX_change_hoge_hoges_foo_id_comment.php

     <?php
     
     use Illuminate\Database\Migrations\Migration;
     use Illuminate\Database\Schema\Blueprint;
     use Illuminate\Support\Facades\Schema;
     
     class ChangeHogeHogesFooIdComment extends Migration
     {
         /**
          * Run the migrations.
          *
          * @return void
          */
         public function up()
         {
             Schema::table('hoge_hoges', function (Blueprint $table) {
                 $table->integer('foo_id')->comment('変更後コメント')->change();
             });
         }
     
         /**
          * Reverse the migrations.
          *
          * @return void
          */
         public function down()
         {
             Schema::table('hoge_hoges', function (Blueprint $table) {
                 $table->integer('foo_id')->change();
             });
         }
     }
     

3. マイグレーションを実行する