【Rails】マイグレーション時にコメントを追加する

マイグレーション時にコメントを追加する方法

Rails 5からこの機能が標準で装備されたそうです。
それ以前ではgemを利用していたそうです。
追加したコメントはデータベース側に保存されます。

コメントの付け方

マイグレーションファイルを生成されたら、
以下のような書式でコメントをマイグレーションファイルに追加します。

class CreateProducts < ActiveRecord::Migration[6.0]
  def change
    create_table :products do |t|
      t.string :name,                      comment: '雑誌名'
      t.integer :z_code, null: false,      comment: '雑誌コード'
      t.integer :num,    null: false,      comment: '取置冊数'
      t.string :release, null: false,      comment: '発売日'
      t.references :customer, null: false, foreign_key: true
      t.timestamps
    end
  end
end

その後、rails db:migrateで完了です！
Sequel Proの「構造」から確認できます。

コメントをつける意味

カラムにコメントをつける機能は「定義」を記録するって事が一番だと思います。
実際、6個程度のモデルしか作っていないのですが、
「name」カラム5つ「date」カラム３つも使っているのですよね・・・。
これからさらに追加で機能をつけていくとしたら、自身の備忘録としても意味がある機能だと思います。
ちなみに、コメントはあくまでメモとして残すものなので、
テーブルの動作的には何も影響はないそうです！

参考にさせていただいたサイト様

https://techracho.bpsinc.jp/hachi8833/2017_02_23/36083
ありがとうございます！！