Laravel テーブルとカラムへコメントを付与する方法

Laravel

テーブルにコメントを付与する方法

PostgreSQLの場合

マイグレーションファイル

テーブルにコメントを付与するには、マイグレーションファイル内にあるup()関数の中で、DBファサードのstatementメソッド(DB::statement)を使用し、通常のSQL文を実行することでコメントを付与していきます!

実際にコメント付与に使用するSQLは、PostgreSQL構文のCOMMENT ON TABLE 〜 IS 〜を使用することでコメントを付与することができます!

	public function up()
	{
		Schema::create('samples', function(Blueprint $table) {
.
.

		});
		
		DB::statement("COMMENT ON TABLE samples IS 'サンプル';");

	}
マイグレーション後の確認

PostgreSQLのコマンドラインで確認すると、ちゃんと説明欄にコメントが記載されていることがわかります。

# \d+
                                                   リレーションの一覧
 スキーマ |                              名前                               |     型     |  所有者  |   サイズ   | 説明 
----------+-----------------------------------------------------------------+------------+----------+------------+------
 public   | sample                                                          | テーブル   | postgres | 8192 bytes | サンプル

参考サイト

カラムにコメントを付与する方法

マイグレーションファイル

各カラムへ->comment(”)を使用して、コメントを付与することができます。

	public function up()
	{
		Schema::create('samples', function(Blueprint $table) {
            $table->bigIncrements('sample_id')->comment('サンプルID');
.
.
		});
	}

マイグレーション後の確認

PostgreSQLのコマンドラインで確認すると、ちゃんと説明欄にコメントが記載されていることがわかります。

# \d+ samples
                                                                   テーブル "public.samples"
             列             |               型               |                          修飾語                           | ストレージ | 対象統計情報 |  説明  
----------------------------+--------------------------------+-----------------------------------------------------------+------------+--------------+--------
 sample_id                   | bigint                         | not null default nextval('samples_sample_id_seq'::regclass) | plain      |              | サンプルID

オススメの関連商品

コメント