【Ruby on Rails】migrationファイルでコメントをつける方法

migrationファイルでコメントをつける方法を解説しておく。

migrationファイルのコメントの書き方

まず基本

class CreateProducts < ActiveRecord::Migration[7.0]
  def change
    create_table :goriras do |t|
      t.string :name
      t.string :self_introduction

      t.timestamps
    end
  end
end

こんな感じ。これでマイグレーションをすれば、goriraテーブルに、nameとselfintroductionというカラムを追加することができる。

コメントをつける

class CreateProducts < ActiveRecord::Migration[7.0]
  def change
    create_table :goriras do |t|
      t.string :name, comment: "ゴリラ名"
      t.text :self_introduction, commnet: "自己紹介文"

      t.timestamps
    end
  end
end

こんな感じで、commnet: "******"という感じでカラムにコメントをつけることができる。マイグレーションをしたあとに、DBクライアントなどを見ると、このコメントが反映されていてなににこのカラムを使用するのかを判断しやすくなるので便利。

ちなみに、create_table :goriras do |t|というところのテーブル名にももちろんコメントを追加することができる。

class CreateProducts < ActiveRecord::Migration[7.0]
  def change
    create_table :goriras, comment: " ゴリラ" do |t|  ##ここに追加した
      t.string :name, comment: "ゴリラ名"
      t.text :self_introduction, commnet: "自己紹介文"

      t.timestamps
    end
  end
end

こんな感じ。