マイグレーション（migration）はActive Recordの機能の1つであり、データベーススキーマが長期にわたって進化を安定して繰り返せるようにするための仕組みです。マイグレーション機能のおかげで、スキーマ変更を生SQLで記述せずに、Rubyで作成されたマイグレーション用のDSL（ドメイン固有言語）を用いてテーブルの変更を簡単に記述できます。
このガイドの内容:
railsタスクの解説schema.rbの関係マイグレーションは、データベーススキーマの継続的な変更（英語）を、統一的かつ簡単に行なうための便利な手法です。マイグレーションではRubyのDSLが使われているので、生のSQLを作成する必要がなく、スキーマおよびスキーマ変更がデータベースに依存しなくなります。
個別のマイグレーションは、データベースの新しい「バージョン」とみなせます。スキーマは空の状態から始まり、マイグレーションによる変更が加わるたびにテーブル、カラム、エントリが追加または削除されます。Active Recordはマイグレーションの時系列に沿ってスキーマを更新する方法を知っているので、履歴のどの時点からでも最新バージョンのスキーマに更新できます。Active Recordはdb/schema.rbファイルを更新し、データベースの最新の構造と一致するようにします。
マイグレーションの例を以下に示します。
class CreateProducts < ActiveRecord::Migration[7.1] def change create_table :products do |t| t.string :name t.text :description t.timestamps end end end
上のマイグレーションを実行するとproductsという名前のテーブルが追加されます。この中にはnameというstringカラムと、descriptionというtextカラムが含まれています。主キーはidという名前で暗黙に追加されます。idはActive Recordモデルにおけるデフォルトの主キーです。timestampsマクロは、created_atとupdated_atという2つのカラムを追加します。これらの特殊なカラムが存在する場合、Active Recordによって自動的に管理されます。
マイグレーションで定義されているのは、時間を先に進めるときに実行したい動作である点にご注目ください。マイグレーションの実行前にはテーブルは1つもありません。マイグレーションを実行すると、テーブルが作成されます。Active Recordは、このマイグレーションを逆進させる方法も知っています。マイグレーションをロールバックさせると、テーブルは削除されます。
トランザクション内でスキーマを変更するステートメントがデータベースでサポートされていれば、個別のマイグレーションはトランザクションでラップされます。この機能がデータベースでサポートされていない場合は、マイグレーションの一部が失敗した場合にロールバックされません。その場合は、変更の逆進を手動で記述する必要があります。
ある種のクエリは、トランザクション内で実行できないことがあります。アダプタがDDLトランザクションをサポートしている場合は、disable_ddl_transaction!を使えば単一のマイグレーションでこれらを無効にできます。
マイグレーションを取り消す（逆進させる）方法をActive Recordが推測できない場合は、reversibleメソッドを利用できます。
class ChangeProductsPrice < ActiveRecord::Migration[7.1] def change reversible do |direction| change_table :products do |t| direction.up { t.change :price, :string } direction.down { t.change :price, :integer } end end end end
上のマイグレーションでは、priceカラムの型を文字列に変更し、マイグレーションを取り消した場合は整数に戻します。
direction.upとdirection.downにそれぞれブロックを渡している点にご注目ください。
changeの代わりにupとdownを使うこともできます。
class ChangeProductsPrice < ActiveRecord::Migration[7.1] def up change_table :products do |t| t.change :price, :string end end def down change_table :products do |t| t.change :price, :integer end end end
詳しくはreversibleを参照してください。
マイグレーションはdb/migrateディレクトリに保存されます。1つのマイグレーションファイルが1つのマイグレーションクラスに対応します。マイグレーションファイル名はYYYYMMDDHHMMSS_create_products.rbのような形式になります。ファイル名の日時はマイグレーションを識別するUTCタイムスタンプであり、アンダースコアに続いてマイグレーション名が記述されます。マイグレーションのクラス名（CamelCase）は、ファイル名の後半（snake_case）と一致する必要があります。たとえば、20080906120000_create_products.rbではCreateProductsというクラスを定義し、20080906120001_add_details_to_products.rbではAddDetailsToProductsというクラスを定義する必要があります。Railsはマイグレーションの実行順序をファイル名のタイムスタンプで決定するので、マイグレーションを他のアプリケーションからコピーする場合や、自分でマイグレーションを生成する場合は、実行順に注意する必要があります。
タイムスタンプを算出する作業は退屈です。Active Recordにはタイムスタンプを自動生成するジェネレータが用意されています。
$ bin/rails generate migration AddPartNumberToProducts
上を実行すると、空のマイグレーションが適切な名前で作成されます。
class AddPartNumberToProducts < ActiveRecord::Migration[7.1] def change end end
ジェネレータは、単にファイル名の冒頭にタイムスタンプを追加するだけではありません。命名規約や追加の（オプション）引数に基づいて、マイグレーションに肉付けすることもできます。
マイグレーション名が"AddColumnToTable"や"RemoveColumnFromTable"で、かつその後ろにカラム名や型が続く形式になっていれば、適切なadd_column文やremove_column文を含むマイグレーションが作成されます。
$ bin/rails generate migration AddPartNumberToProducts part_number:string
上を実行すると以下のマイグレーションファイルが生成されます。
class AddPartNumberToProducts < ActiveRecord::Migration[7.1] def change add_column :products, :part_number, :string end end
新しいカラムにインデックスも追加したい場合は以下のようにします。
$ bin/rails generate migration AddPartNumberToProducts part_number:string:index
上を実行すると以下のように適切なadd_columnとadd_indexステートメントが生成されます。
class AddPartNumberToProducts < ActiveRecord::Migration[7.1] def change add_column :products, :part_number, :string add_index :products, :part_number end end
自動生成されるカラムは1個だけではありません。たとえば以下のような指定も可能です。
$ bin/rails generate migration AddDetailsToProducts part_number:string price:decimal
上を実行すると、productsテーブルに2個のカラムを追加するスキーママイグレーションを生成します。
class AddDetailsToProducts < ActiveRecord::Migration[7.1] def change add_column :products, :part_number, :string add_column :products, :price, :decimal end end
同様に、カラムを削除するマイグレーションをコマンドラインで生成するには以下のようにします。
$ bin/rails generate migration RemovePartNumberFromProducts part_number:string
上を実行すると、適切なremove_columnステートメントが生成されます。
class RemovePartNumberFromProducts < ActiveRecord::Migration[7.1] def change remove_column :products, :part_number, :string end end
マイグレーション名が"CreateXXX"のような形式で、その後にカラム名と型が続く場合、XXXという名前のテーブルが作成され、指定の型のカラム名がその中に生成されます。たとえば次のようになります。
$ bin/rails generate migration CreateProducts name:string part_number:string
上を実行すると以下のマイグレーションファイルが生成されます。
class CreateProducts < ActiveRecord::Migration[7.1] def change create_table :products do |t| t.string :name t.string :part_number t.timestamps end end end
これまでと同様、ここまでに生成したマイグレーションの内容は単なる出発点でしかありません。db/migrate/YYYYMMDDHHMMSS_add_details_to_products.rbファイルを編集して、項目の追加や削除を行えます。
同様に、カラム型にreferencesも指定できます（belongs_toも可）。たとえば次のようになります。
$ bin/rails generate migration AddUserRefToProducts user:references
上を実行すると以下のadd_reference呼び出しが生成されます。
class AddUserRefToProducts < ActiveRecord::Migration[7.1] def change add_reference :products, :user, foreign_key: true end end
このマイグレーションを実行すると、user_idが作成されます。reference（参照）は、「カラムの作成」「インデックスの作成」「外部キーの作成」そして「ポリモーフィック関連付けカラムの作成」のショートハンドです。
名前の一部にJoinTableが含まれているとjoinテーブルを生成するジェネレータもあります。
$ bin/rails generate migration CreateJoinTableCustomerProduct customer product
上によって以下のマイグレーションが生成されます。
class CreateJoinTableCustomerProduct < ActiveRecord::Migration[7.1] def change create_join_table :customers, :products do |t| # t.index [:customer_id, :product_id] # t.index [:product_id, :customer_id] end end end
モデルのジェネレータとscaffoldジェネレータは、新しいモデルを追加するマイグレーションを生成します。このマイグレーションには、関連するテーブルを作成する命令が既に含まれています。必要なカラムを指定すると、それらのカラムを追加する命令も同時に生成されます。たとえば、以下を実行するとします。
$ bin/rails generate model Product name:string description:text
このとき、以下のようなマイグレーションが作成されます。
class CreateProducts < ActiveRecord::Migration[7.1] def change create_table :products do |t| t.string :name t.text :description t.timestamps end end end
カラム名と型のペアはいくつでも追加できます。
よく使われる型修飾子の中には、コマンドラインで直接渡せるものもあります。これらの型修飾子はフィールド型の後ろに波かっこ{}で追加します。
たとえば以下を実行したとします。
$ bin/rails generate migration AddDetailsToProducts 'price:decimal{5,2}' supplier:references{polymorphic}
これによって以下のようなマイグレーションが生成されます。
class AddDetailsToProducts < ActiveRecord::Migration[7.1] def change add_column :products, :price, :decimal, precision: 5, scale: 2 add_reference :products, :supplier, polymorphic: true end end
詳しくはジェネレータのヘルプ（bin/rails generate --help）を参照してください。
ジェネレータでマイグレーションを作成できるようになったら、今度は自分で作成してみましょう。
create_tableメソッドは最も基本的なメソッドであり、ほとんどの場合モデルやscaffoldの生成時に使われます。典型的な利用法は以下のとおりです。
create_table :products do |t| t.string :name end
このメソッドは、productsテーブルを作成し、nameという名前のカラムをその中に作成します。
デフォルトでは、create_tableによってidという名前の主キーが暗黙で作成されます。:primary_keyオプションを指定する（複合主キーの場合は:primary_keyに配列を渡す）ことで、このカラム名を変更できます。主キーを使いたくない場合はid: falseオプションを指定することも可能です。
特定のデータベースに依存するオプションが必要な場合は、以下のように:optionsオプションに続けてSQLフラグメントを記述します。
create_table :products, options: "ENGINE=BLACKHOLE" do |t| t.string :name, null: false end
上のマイグレーションでは、テーブルを生成するSQLステートメントにENGINE=BLACKHOLEを追加しています。
以下のように、index: trueを渡すか、:indexオプションにオプションハッシュを渡すと、create_tableブロックで作成されるカラムにインデックスを追加できます。
create_table :users do |t| t.string :name, index: true t.string :email, index: { unique: true, name: 'unique_emails' } end
:commentオプションを使うと、テーブルを説明するコメントを書いてデータベース自身に保存することも可能です。保存した説明文はMySQL WorkbenchやPgAdmin IIIなどのデータベース管理ツールで表示できます。説明文を追加しておくことでデータモデルが理解しやすくなり、ドキュメントも生成されるので、大規模なデータベースを持つアプリケーションでは、マイグレーションにこのようなコメントを追加しておくことを強くおすすめします。
現時点では、MySQLとPostgreSQLアダプタのみがコメント機能をサポートしています。
マイグレーションのcreate_join_tableメソッドはhas_and_belongs_to_many（HABTM）というjoinテーブルを作成します。典型的な利用法は以下のとおりです。
create_join_table :products, :categories
上によってcategories_productsテーブルが作成され、その中にcategory_idカラムとproduct_idカラムが生成されます。
これらのカラムはデフォルトで:nullオプションがfalseに設定されます。これは、このテーブルにレコードを保存するためには必ず値を指定しなければならないことを意味します。これは、以下のように:column_optionsオプションを指定することで上書きできます。
create_join_table :products, :categories, column_options: { null: true }
デフォルトでは、create_join_tableに渡された引数の最初の2つをつなげたものがjoinテーブル名になります。
独自のテーブル名を使いたい場合は、:table_nameで指定します。
create_join_table :products, :categories, table_name: :categorization
上のようにすることでcategorizationテーブルがjoinテーブルとして作成されます。
create_join_tableにはブロックも渡せます。ブロックはインデックスの追加（インデックスはデフォルトでは作成されません）やカラムの追加に使われます。
create_join_table :products, :categories do |t| t.index :product_id t.index :category_id end
既存のテーブルを変更するchange_tableは、create_tableとよく似ています。
基本的にはcreate_tableと同じ要領で使いますが、ブロックでyieldされるオブジェクトでは、以下のようないくつかのテクニックが利用できます。
change_table :products do |t| t.remove :description, :name t.string :part_number t.index :part_number t.rename :upccode, :upc_code end
上のマイグレーションではdescriptionとnameカラムが削除され、stringカラムであるpart_numberが作成されてインデックスが追加されます。最後にupccodeカラムをupc_codeにリネームしています。
Railsのマイグレーションでは、上述したremove_columnやadd_columnと同様に、change_columnメソッドも利用できます。
change_column :products, :part_number, :text
上は、productsテーブル上のpart_numberカラムの型を:textフィールドに変更しています。
change_columnコマンドは逆進できない点にご注意ください。
前述したように、reversibleなマイグレーションを独自に提供すべきです。
change_columnの他に、not null制約を変更するchange_column_nullメソッドや、デフォルト値を指定するchange_column_defaultメソッドも利用できます。
change_column_null :products, :name, false change_column_default :products, :approved, from: true, to: false
上のマイグレーションは、productsテーブルの:nameフィールドにNOT NULL制約を設定し、:approvedフィールドのデフォルト値をtrueからfalseに変更します。これらの変更は、どちらも今後のトランザクションにのみ適用され、既存のレコードには適用されない点にご注意ください。
NULL制約をtrueに設定すると、そのカラムはnull値を受け入れ可能になります。そうでない場合はNOT NULL制約が適用され、レコードをデータベースに永続化するには必ず値を渡さなければならなくなります。
上のchange_column_defaultマイグレーションはchange_column_default :products, :approved, falseと書くことも可能ですが、先ほどの例と異なり、マイグレーションは逆進できなくなります。
カラムの作成時や変更時に、カラムの修飾子を適用できます。
comment: カラムにコメントを追加します。collation: stringカラムやtextカラムのコレーション（照合順序）を指定します。default: カラムでのデフォルト値の設定を許可します。dateなどの動的な値を使う場合は、デフォルト値は初回（すなわちマイグレーションが実行された日付）しか計算されないことにご注意ください。デフォルト値をNULLにする場合はnilを指定してください。limit: stringフィールドについては最大文字数を、text/binary/integerについては最大バイト数を設定します。null: カラムでNULL値を許可または禁止します。precision: decimal/numeric/datetime/timeフィールドの精度（precision）を定義します。scale: decimal/numericフィールドのスケールを指定します。スケールは小数点以下の桁数で表されます。アダプタによっては他にも利用できるオプションがあります。詳しくは各アダプタ固有のAPIドキュメントを参照してください。
nullとdefaultは、コマンドラインでマイグレーションを生成するときには指定できません。
add_referenceメソッドを使うと、1個以上の関連付け同士のつながりとして振る舞う適切な名前のカラムを作成できます。
add_reference :users, :role
上のマイグレーションは、usersテーブルにrole_idカラムを作成します。index: falseオプションを明示的に指定しない限り、そのカラムのインデックスも作成します。
詳しくはActive Record の関連付けガイドも参照してください。
add_belongs_toメソッドはadd_referenceのエイリアスです。
add_belongs_to :taggings, :taggable, polymorphic: true
polymorphic:オプションは、taggingsテーブルにtaggable_typeカラムおよびtaggable_idカラムというポリモーフィック関連付け用のカラムを2つ作成します。
詳しくはポリモーフィック関連付けも参照してください。
foreign_keyオプションを指定すると外部キーを作成できます。
add_reference :users, :role, foreign_key: true
add_referenceオプションについて詳しくはAPIドキュメントを参照してください。
remove_referenceを使って参照を削除できます。
remove_reference :products, :user, foreign_key: true, index: false
参照整合性の保証に対して外部キー制約を追加することも可能です。これは必須ではありません。
add_foreign_key :articles, :authors
上のadd_foreign_key呼び出しは、articlesテーブルに新たな制約を追加します。この制約によって、idカラムがarticles.author_idと一致する行がauthorsテーブル内に存在することが保証されます。
to_table名からfrom_tableカラム名を導出できない場合は、:columnオプションでカラム名を指定できます。参照されている主キーが:id以外の場合は、:primary_keyオプションで主キーを指定してください。
たとえば、authors.emailを参照するarticles.reviewerに外部キーを追加するには以下のようにします。
add_foreign_key :articles, :authors, column: :reviewer, primary_key: :email
上はarticlesテーブルに制約を追加します。この制約は、emailカラムがarticles.reviewerフィールドと一致する行が、authorsテーブルに存在することを保証します。
add_foreign_keyでは、name、on_delete、if_not_exists、validate、deferrableなどのオプションもサポートされています。
外部キーの削除も以下のようにremove_foreign_keyで行えます。
# 削除するカラム名の決定をActive Recordに任せる場合 remove_foreign_key :accounts, :branches # カラムを指定して外部キーを削除する場合 remove_foreign_key :accounts, column: :owner_id
Active Recordでは単一カラムの外部キーのみがサポートされています。複合外部キーを使う場合はexecuteとstructure.sqlが必要です。詳しくはスキーマダンプの意義を参照してください。
1つのカラム値だけではテーブルの各行を一意に識別するのに不十分でも、2つ以上のカラムを組み合わせれば一意に識別できる場合があります。この状況は、主キーとして単一のidカラムを持たない既存のデータベーススキーマを利用する場合や、シャーディングやマルチテナンシー向けにスキーマを変更する場合に起こる可能性があります。
create_tableで以下のように:primary_keyオプションと配列の値を渡すことで、複合主キー（composite primary key）を持つテーブルを作成できます。
class CreateProducts < ActiveRecord::Migration[7.1] def change create_table :products, primary_key: [:customer_id, :product_sku] do |t| t.integer :customer_id t.string :product_sku t.text :description end end end
複合主キーを持つテーブルでは、多くのメソッドで整数のIDではなく配列値を渡す必要があります。詳しくは、Active Recordクエリガイドも参照してください。
Active Recordが提供するヘルパーの機能だけでは不十分な場合、executeメソッドで任意のSQLを実行できます。
Product.connection.execute("UPDATE products SET price = 'free' WHERE 1=1")
個別のメソッドについて詳しくは、APIドキュメントを確認してください。
特に、ActiveRecord::ConnectionAdapters::SchemaStatementsは、change、up、downメソッドで利用可能なメソッドを提供します。
create_tableで生成されるオブジェクトで利用可能なメソッドについては、ActiveRecord::ConnectionAdapters::TableDefinitionを参照してください。
change_tableで生成されるオブジェクトで利用可能なメソッドについては、ActiveRecord::ConnectionAdapters::Tableを参照してください。
changeメソッドを使うchangeメソッドは、マイグレーションを自作する場合に最もよく使われます。このメソッドを使えば、多くの場合にActive Recordがマイグレーションを逆進させる（以前のマイグレーションにロールバックする）方法を自動的に認識します。以下はchangeでサポートされているマイグレーション定義の一部です。
add_check_constraintadd_columnadd_foreign_keyadd_indexadd_referenceadd_timestampschange_column_comment（:fromと:toの指定は省略不可）change_column_default（:fromと:toの指定は省略不可）change_column_nullchange_table_comment（:fromと:toの指定は省略不可）create_join_tablecreate_tabledisable_extensiondrop_join_tabledrop_table（テーブル作成時のオプションとブロックは省略不可）enable_extensionremove_check_constraint（元の制約式の指定は省略不可）remove_column（元の型名とカラムオプションの指定は省略不可）remove_columns（元の型名とカラムオプションの指定は省略不可）remove_foreign_key（他のテーブル名と元のオプションの指定は省略不可）remove_index（カラム名と元のオプションの指定は省略不可）remove_reference（元のオプションの指定は省略不可）remove_timestamps（元のオプションの指定は省略不可）rename_columnrename_indexrename_tableブロックで上記の逆進可能操作が呼び出されない限り、change_table も逆進可能です。
これ以外のメソッドを使う必要がある場合は、changeメソッドの代わりにreversibleメソッドを利用するか、upとdownメソッドを明示的に書いてください。
reversibleを使うマイグレーションが複雑になると、Active Recordがマイグレーションを逆進できないことがあります。reversibleメソッドを使うと、マイグレーションを通常どおり実行する場合と逆進する場合の動作を以下のように指定できます。
class ExampleMigration < ActiveRecord::Migration[7.1] def change create_table :distributors do |t| t.string :zipcode end reversible do |direction| direction.up do # distributors_viewを作成する execute <<-SQL CREATE VIEW distributors_view AS SELECT id, zipcode FROM distributors; SQL end direction.down do execute <<-SQL DROP VIEW distributors_view; SQL end end add_column :users, :address, :string end end
reversibleメソッドを使うことで、各命令を正しい順序で実行できます。前述のマイグレーション例を逆転させた場合、downブロックは必ずusers.addressカラムが削除された直後、そしてdistributorsテーブルがDROPされる直前に実行されます。
up/downメソッドを使うchangeの代わりに、従来のupメソッドとdownメソッドも利用できます。
upメソッドにはスキーマに対する変換方法を記述し、downメソッドにはupメソッドによって行われた変換をロールバック（逆転）する方法を記述する必要があります。つまり、upの後にdownを実行した場合、スキーマが元に戻る必要があります。
たとえば、upメソッドでテーブルを作成したら、downメソッドではそのテーブルを削除する必要があります。downメソッド内で行なう変換の順序は、upメソッド内で行なう順序の正確な逆順にするのが賢明です。先のreversibleセクションの例は以下と同等になります。
class ExampleMigration < ActiveRecord::Migration[7.1] def up create_table :distributors do |t| t.string :zipcode end # distributors_viewを作成する execute <<-SQL CREATE VIEW distributors_view AS SELECT id, zipcode FROM distributors; SQL add_column :users, :address, :string end def down remove_column :users, :address execute <<-SQL DROP VIEW distributors_view; SQL drop_table :distributors end end
場合によっては、純粋に逆進不可能なマイグレーションを実施することもあります（データの一部を削除するなど）。
このような場合、downブロックで ActiveRecord::IrreversibleMigrationをraiseできます。
誰かがマイグレーションを取り消そうとすると、逆進不可能であることを示すエラーメッセージが表示されます。
revertメソッドを使うと、Active Recordマイグレーションのロールバック機能を利用できます。
require_relative '20121212123456_example_migration' class FixupExampleMigration < ActiveRecord::Migration[7.1] def change revert ExampleMigration create_table(:apples) do |t| t.string :variety end end end
revertには、逆進を行う命令を含むブロックも渡せます。これは、以前のマイグレーションの一部のみを逆進させたい場合に便利です。
たとえば、ExampleMigrationがコミット済みになっており、後になってDistributorsのビューが不要になったとします。この場合、revertを使ってビューを削除するマイグレーションを作成できます。
class DontUseDistributorsViewMigration < ActiveRecord::Migration[7.1] def change revert do # ExampleMigrationのコードをコピペ reversible do |direction| direction.up do # distributors_viewを作成する execute <<-SQL CREATE VIEW distributors_view AS SELECT id, zipcode FROM distributors; SQL end direction.down do execute <<-SQL DROP VIEW distributors_view; SQL end end # 以後のマイグレーションはOK end end end
revertを使わなくても同様のマイグレーションは自作できますが、その分作業が増えます。
create_tableとreversibleの順序を逆にする。create_tableをdrop_tableに置き換える。upとdownを入れ替える。revertは、これらの作業を一手に引き受けてくれます。
Railsにはマイグレーションを実行するためのコマンドがいくつか用意されています。
マイグレーションを実行するrailsコマンドの筆頭といえば、rails db:migrateでしょう。このタスクは基本的に、まだ実行されていないchangeまたはupメソッドを実行します。未実行のマイグレーションがない場合は何もせずに終了します。マイグレーションの実行順序は、マイグレーションの日付が基準になります。
db:migrateタスクを実行すると、db:schema:dumpコマンドも同時に呼び出されます。このコマンドはdb/schema.rbスキーマファイルを更新し、スキーマがデータベースの構造に一致するようにします。
マイグレーションの特定バージョンを指定すると、Active Recordは指定されたマイグレーションに達するまでマイグレーション（change・up・down）を実行します。マイグレーションのバージョンは、マイグレーションファイル名冒頭の数字で表されます。たとえば、20080906120000というバージョンまでマイグレーションしたい場合は、以下を実行します。
$ bin/rails db:migrate VERSION=20080906120000
20080906120000というバージョンが現在のバージョンより大きい場合（新しい方に進む通常のマイグレーションなど）、20080906120000に到達するまで（このマイグレーション自身も実行対象に含まれます）のすべてのマイグレーションのchange（またはup）メソッドを実行し、その先のマイグレーションは行いません。過去に遡るマイグレーションの場合、20080906120000に到達するまでのすべてのマイグレーションのdownメソッドを実行しますが、上と異なり、20080906120000自身は含まれない点にご注意ください。
直前に行ったマイグレーションをロールバックする作業はよく発生します（マイグレーションに誤りがあって訂正したい場合など）。この場合、バージョン番号を調べて明示的にロールバックを実行しなくても、以下を実行するだけで済みます。
$ bin/rails db:rollback
これにより、changeメソッドを逆転実行するかdownメソッドを実行する形で直前のマイグレーションにロールバックします。マイグレーションを2つ以上ロールバックしたい場合は、STEPパラメータを指定できます。
$ bin/rails db:rollback STEP=3
これにより、最後に行った3つのマイグレーションがロールバックされます。
db:migrate:redoコマンドは、ロールバックと再マイグレーションを一度に実行できるショートカットです。複数バージョンに対してこれを行いたい場合は、db:rollbackコマンドの場合と同様にSTEPパラメータも指定できます。
$ bin/rails db:migrate:redo STEP=3
ただし、これらのコマンドでできるのは、db:migrateでできることのみです。これらのコマンドは、バージョンを明示的に指定しなくて済むようにdb:migrateタスクを使いやすくした単なるショートカットです。
bin/rails db:setupコマンドは、「データベースの作成」「スキーマの読み込み」「seedデータを用いたデータベースの初期化」をまとめて実行します。
bin/rails db:prepareコマンドはbin/rails db:setupと似ていますが、冪等に動作する点が異なります。
bin/rails db:setupと同様に動作します。データベースの作成、テーブルの作成、seedデータの読み込みがすべて完了した後は、読み込み済みのseedデータや既存のseedファイルを変更または削除しても、このコマンドではseedデータの再読み込みは行われません。seedデータを再度読み込むには、bin/rails db:seedを手動で実行してください。
bin/rails db:resetコマンドは、データベースをdropして再度設定します。このコマンドはrails db:drop db:setupと同等です。
このコマンドは、すべてのマイグレーションを実行することと等価ではありません。このコマンドは単に現在のschema.rbの内容をそのまま使い回します。マイグレーションをロールバックできなくなると、rails db:resetを実行しても復旧できないことがあります。スキーマダンプについて詳しくは、スキーマダンプの意義セクションを参照してください。
特定のマイグレーションをupまたはdown方向に実行する必要がある場合は、db:migrate:upまたはdb:migrate:downタスクを使います。以下に示したように、適切なバージョン番号を指定するだけで、該当するマイグレーションに含まれるchange、up、downメソッドのいずれかが呼び出されます。
$ bin/rails db:migrate:up VERSION=20080906120000
上を実行すると、バージョン番号が20080906120000のマイグレーションに含まれるchangeメソッド（またはupメソッド）が実行されます。
このコマンドは、最初にそのマイグレーションが実行済みであるかどうかをチェックし、Active Recordによって実行済みであると認定された場合は何も行いません。
指定のバージョンが存在しない場合は、以下のように例外を発生します。
$ bin/rails db:migrate VERSION=zomg rails aborted! ActiveRecord::UnknownMigrationVersionError: No migration with version number zomg.
デフォルトでは、rails db:migrateはdevelopment環境で実行されます。
他の環境に対してマイグレーションを行いたい場合は、コマンド実行時にRAILS_ENV環境変数を指定します。たとえば、test環境でマイグレーションを実行する場合は以下のようにします。
$ bin/rails db:migrate RAILS_ENV=test
デフォルトでは、マイグレーション実行後に正確な実行内容とそれぞれの所要時間が出力されます。 たとえば、テーブル作成とインデックス追加を行なうと次のような出力が得られます。
== CreateProducts: migrating ================================================= -- create_table(:products) -> 0.0028s == CreateProducts: migrated (0.0028s) ========================================
マイグレーションには、これらの出力方法を制御するためのメソッドが提供されています。
| メソッド | 目的 |
|---|---|
suppress_messages |
ブロックを渡すと、そのブロック内で生成される出力をすべて抑制する。 |
say |
第1引数で渡したメッセージをそのまま出力する。第2引数には、出力をインデントするかどうかをboolean値で指定できる。 |
say_with_time |
受け取ったブロックを実行するのに要した時間を示すテキストを出力する。ブロックが整数を1つ返す場合、影響を受けた行数であるとみなす。 |
以下のマイグレーションを例に説明します。
class CreateProducts < ActiveRecord::Migration[7.1] def change suppress_messages do create_table :products do |t| t.string :name t.text :description t.timestamps end end say "Created a table" suppress_messages { add_index :products, :name } say "and an index!", true say_with_time 'Waiting for a while' do sleep 10 250 end end end
上によって以下の出力が得られます。
== CreateProducts: migrating ================================================= -- Created a table -> and an index! -- Waiting for a while -> 10.0013s -> 250 rows == CreateProducts: migrated (10.0054s) =======================================
Active Recordから何も出力したくない場合は、bin/rails db:migrate VERBOSE=falseで出力を完全に抑制できます。
マイグレーションを自作していると、ときにはミスしてしまうこともあります。いったんマイグレーションを実行してしまった後では、既存のマイグレーションを単に編集してもう一度マイグレーションをやり直しても意味がありません。Railsはマイグレーションが既に実行済みであると認識しているので、rails db:migrateを実行しても何も変更されません。このような場合には、マイグレーションをいったんロールバック（rails db:rollbackなど）してからマイグレーションを修正し、それからbin/rails db:migrateを実行して修正済みバージョンのマイグレーションを実行する必要があります。
一般に、既存のマイグレーションを直接変更するのはよくありません。既存のマイグレーションを変更すると、自分自身はもちろん、共同作業者も余分な作業を強いられます。さらに、既存のマイグレーションがproduction環境で実行中の場合、ひどい頭痛の種になるでしょう。
既存のマイグレーションを直接修正するのではなく、修正用のマイグレーションを新たに作成してそれを実行するのが正しい方法です。これまでコミットされてない（より一般的に言えば、これまでdevelopment環境以外にデプロイされたことのない）マイグレーションを新たに生成し、それを編集するのが害の少ない方法です。
revertメソッドは、以前のマイグレーション全体またはその一部を逆進させるためのマイグレーションを新たに書くときにも便利です（上述の以前のマイグレーションに戻すを参照してください）。
Railsのマイグレーションは強力ではありますが、データベースのスキーマを作成するための信頼できる情報源ではありません。信頼できる情報源は、やはりデータベースです。
Railsは、デフォルトでdb/schema.rbファイルを生成してデータベーススキーマの最新の状態のキャプチャを試みます。
アプリケーションのデータベースの新しいインスタンスを作成する場合、マイグレーションの全履歴を最初から繰り返すよりも、単にrails db:schema:loadでスキーマファイルを読み込む方が、高速かつエラーが起きにくい傾向があります。
マイグレーション内の外部依存性が変更されたり、マイグレーションと異なる進化を遂げたアプリケーションコードに依存していたりすると、古いマイグレーションを正しく適用できなくなる可能性があります。
スキーマファイルは、Active Recordの現在のオブジェクトにある属性を手軽にチェックするときにも便利です。スキーマ情報はモデルのコードにはありません。スキーマ情報は多くのマイグレーションに分かれて存在しており、そのままでは非常に探しにくいものですが、こうした情報はスキーマファイルにコンパクトな形で保存されています。
Railsで生成されるスキーマダンプのフォーマットは、config/application.rbで定義されるconfig.active_record.schema_format設定で制御されます。デフォルトのフォーマットは:rubyですが、:sqlも指定できます。
:rubyスキーマを利用する場合:rubyを選択すると、スキーマはdb/schema.rbに保存されます。このファイルを開いてみると、1つの巨大なマイグレーションのように見えます。
ActiveRecord::Schema[7.1].define(version: 2008_09_06_171750) do create_table "authors", force: true do |t| t.string "name" t.datetime "created_at" t.datetime "updated_at" end create_table "products", force: true do |t| t.string "name" t.text "description" t.datetime "created_at" t.datetime "updated_at" t.string "part_number" end end
このスキーマ情報は、見てのとおりその内容を単刀直入に表しています。このファイルは、データベースを詳細に検査し、create_tableやadd_indexなどでその構造を表現することで作成されています。
:sqlスキーマダンプを利用する場合しかし、db/schema.rbでは、「トリガ」「シーケンス」「ストアドプロシージャ」「チェック制約」などのデータベース固有の項目を表現できません。
マイグレーションでexecuteを用いれば、RubyマイグレーションDSLでサポートされないデータベース構造も作成できますが、そうしたステートメントはスキーマダンプで再構成されない点にご注意ください。
これらの機能が必要な場合は、新しいデータベースインスタンスの作成に有用なスキーマファイルを正確に得るために、スキーマのフォーマットに:sqlを指定する必要があります。
スキーマフォーマットを:sqlにすると、データベース固有のツールを用いてデータベースの構造をdb/structure.sqlにダンプします。たとえばPostgreSQLの場合はpg_dumpユーティリティが使われます。MySQLやMariaDBの場合は、多くのテーブルでSHOW CREATE TABLEの出力結果がファイルに含まれます。
スキーマをdb/structure.sqlから読み込む場合、bin/rails db:schema:loadを実行します。これにより、含まれているSQL文が実行されてファイルが読み込まれます。定義上、これによって作成されるデータベース構造は元の完全なコピーとなります。
スキーマダンプは一般にデータベースの作成に使われるものなので、スキーマファイルはGitなどのソースコード管理の対象に加えておくことを強く推奨します。
複数のブランチでスキーマを変更すると、マージしたときにスキーマファイルがコンフリクトする可能性があります。
コンフリクトを解決するには、bin/rails db:migrateを実行してスキーマファイルを再生成してください。
新規生成されたRailsアプリでは、既にmigrationsフォルダがgitツリーに含まれているので、必要な作業は、新たに追加するマイグレーションを常にgitに追加してコミットすることだけです。
Active Recordは「高度な機能はデータベースではなくモデルに属する」というコンセプトを主張しています。そのため、トリガーや制約などのような、高度な機能の一部をデータベースに戻すような機能はActive Recordでは推奨されていません。
validates :foreign_key, uniqueness: trueのようなデータベースバリデーション機能は、データ整合性をモデルが強制している方法の1つです。モデルで関連付けの:dependentオプションを指定すると、親オブジェクトが削除されたときに子オブジェクトも自動的に削除されます。アプリケーションレベルで実行される他の機能と同様、モデルのこうした機能だけでは参照整合性を維持できないため、開発者によってはデータベースの外部キー制約機能を用いて参照整合性を補強することもあります。
Active Recordだけではこうした外部機能を扱うツールをすべて提供しているわけではありませんが、executeメソッドを使えば任意のSQLを実行できます。
Railsのマイグレーション機能の主要な目的は、スキーマ変更のコマンドを一貫した手順で発行できるようにすることですが、データの追加や変更にも利用できます。これは、productionのデータベースのような削除や再作成を行えない既存データベースで便利です。
class AddInitialProducts < ActiveRecord::Migration[7.1] def up 5.times do |i| Product.create(name: "Product ##{i}", description: "A product.") end end def down Product.delete_all end end
Railsには、データベース作成後に初期データを素早く簡単に追加するシード（seed）機能があります。seedは、development環境やtest環境で頻繁にデータを再読み込みする場合に特に便利です。
seed機能を使うには、db/seeds.rbを開いてRubyコードを記述し、rails db:seedを実行します。
ここで記述するコードは、いつ、どの環境でも実行できるように冪等にしておくべきです。
["Action", "Comedy", "Drama", "Horror"].each do |genre_name| MovieGenre.find_or_create_by!(name: genre_name) end
この方法なら、マイグレーションよりもずっとクリーンに空のアプリケーションのデータベースをセットアップできます。
db/schema.rbやdb/structure.sqlは、使っているデータベースの最新ステートのスナップショットであり、そのデータベースを再構築するための情報源として信頼できます。これを手がかりにして、古いマイグレーションファイルを削除・削減できます。
db/migrate/ディレクトリ内のマイグレーションファイルを削除しても、マイグレーションファイルが存在していたときにrails db:migrateが実行されたあらゆる環境は、Rails内部のschema_migrationsという名前のデータベース内に保存されている（マイグレーションファイル固有の）マイグレーションタイムスタンプへの参照を保持し続けます。このテーブルは、特定の環境でマイグレーションが実行されたことがあるかどうかをトラッキングするのに用いられます。
マイグレーションファイルを削除した状態でrails db:migrate:statusコマンド（本来マイグレーションのステータス（upまたはdown）を表示する）を実行すると、削除したマイグレーションファイルの後に********** NO FILE **********と表示されるでしょう。これは、そのマイグレーションファイルが特定の環境で一度実行されたが、db/migrate/ディレクトリの下に見当たらない場合に表示されます。
ただし1つ注意点があります。Railsエンジンからマイグレーションをインストールするrakeタスクは「冪等」です（すなわち、2回以上実行しても結果が変わりません）。
親アプリケーションに存在するマイグレーションは、以前のインストールによってスキップされ、マイグレーションが見つからない場合は最新のタイムスタンプでコピーされます。
古いエンジンのマイグレーションを削除してからインストールタスクを再実行すると、新しいタイムスタンプを持つ新しいファイルが作成され、db:migrateはそれらの新しいファイルを再実行しようとします。
したがって、一般にエンジン由来のマイグレーションは変更されないよう保護しておきましょう。そのようなマイグレーションには以下のような特殊なコメントがあります。
# This migration comes from blorgh (originally 20210621082949)
Railsガイドは GitHub の yasslab/railsguides.jp で管理・公開されております。本ガイドを読んで気になる文章や間違ったコードを見かけたら、気軽に Pull Request を出して頂けると嬉しいです。Pull Request の送り方については GitHub の README をご参照ください。
原著における間違いを見つけたら『Rails のドキュメントに貢献する』を参考にしながらぜひ Rails コミュニティに貢献してみてください 🛠💨✨
本ガイドの品質向上に向けて、皆さまのご協力が得られれば嬉しいです。
Railsガイド運営チーム (@RailsGuidesJP)
Railsガイドは下記の協賛企業から継続的な支援を受けています。支援・協賛にご興味あれば協賛プランからお問い合わせいただけると嬉しいです。
