サンプルコード：usersテーブルのbirthday列をDate型からDateTime型へ変更

2024-04-20

Rails マイグレーションにおける Date 型から DateTime 型への列変更

Rails アプリケーションにおいて、データベーススキーマの変更はマイグレーションファイルを用いて行われます。本記事では、マイグレーションファイルを用いて、Date 型から DateTime 型への列変更を解説します。

対象

Ruby on Rails 経験者
マイグレーションファイルの書き方に慣れている方

前提

データベースに Date 型の列が存在する
列を DateTime 型に変更したい

手順

マイグレーションファイルの作成

rails generate migration ChangeColumnToDateTime

class ChangeColumnToDateTime < ActiveRecord::Migration[5.2]
  def up
    change_column :table_name, :column_name, :datetime
  end

  def down
    change_column :table_name, :column_name, :date
  end
end

上記コードは以下の動作を行います。

up メソッド内にて、table_name テーブルの column_name 列の型を date から datetime に変更します。
down メソッド内にて、up メソッドで実施した変更を元に戻します。

補足

change_column メソッドは、列の型変更以外にも、列名の変更やデフォルト値の設定などに使用できます。
マイグレーションファイルを実行する前に、データベースのバックアップを取ることを推奨します。

例

class ChangeBirthdayToDateTime < ActiveRecord::Migration[5.2]
  def up
    change_column :users, :birthday, :datetime
  end

  def down
    change_column :users, :birthday, :date
  end
end

上記コードは、users テーブルの birthday 列の型を date から datetime に変更します。

注意事項

Date 型から DateTime 型への変更は、データ型が大きくなるため、パフォーマンスに影響を与える可能性があります。
データベースによっては、Date 型から DateTime 型への直接的な変更ができない場合があります。その場合は、一時的な列を追加してデータを移行してから、元の列を削除するなどの方法が必要となります。

class ChangeBirthdayToDateTime < ActiveRecord::Migration[5.2]
  def up
    change_column :users, :birthday, :datetime
  end

  def down
    change_column :users, :birthday, :date
  end
end

説明

change_column メソッドを使用して、列の型変更を行います。
up メソッド内にて変更を行い、down メソッド内にて変更を元に戻します。

Rails マイグレーションにおける列の型変更：その他の方法

本記事では、Rails マイグレーションにおける Date 型から DateTime 型への列変更について、標準的な方法に加え、以下の2つの方法について解説します。

временная列を使用する方法
change_column_type メソッドを使用する方法

新しい DateTime 型の列を作成する
古い Date 型の列から新しい列にデータを移行する

class ChangeBirthdayToDateTime < ActiveRecord::Migration[5.2]
  def up
    add_column :users, :birthday_tmp, :datetime

    User.all.each do |user|
      user.birthday_tmp = user.birthday
      user.save
    end

    remove_column :users, :birthday
    rename_column :users, :birthday_tmp, :birthday
  end

  def down
    add_column :users, :birthday_tmp, :date

    User.all.each do |user|
      user.birthday = user.birthday_tmp
      user.save
    end

    remove_column :users, :birthday_tmp
    rename_column :users, :birthday, :birthday_tmp
  end
end

その後、既存の birthday 列のデータから birthday_tmp 列にデータを移行します。
既存の birthday 列を削除し、birthday_tmp 列の名前を birthday に変更します。

利点

データの損失リスクが少ない

欠点

コードが複雑になる
処理時間が長くなる可能性がある

Rails 6.0以降で使用可能

class ChangeBirthdayToDateTime < ActiveRecord::Migration[6.0]
  def up
    change_column_type :users, :birthday, :datetime
  end

  def down
    change_column_type :users, :birthday, :date
  end
end