Миграции Active Record

Миграции могут управлять эволюцией схемы, используемой несколькими физическими базами данных. Это решение распространенной проблемы добавления поля для работы новой функции в локальной базе данных, но при этом отсутствует уверенность в том, как внести это изменение для других разработчиков и на сервер в продакшен. С помощью миграций вы можете описать преобразования в автономных классах, которые можно включить в системы управления версиями и выполнить на другой базе данных, которая может отставать на одну, две или пять версий.

Пример простой миграции:

class AddSsl < ActiveRecord::Migration[7.2]
  def up
    add_column :accounts, :ssl_enabled, :boolean, default: true
  end

  def down
    remove_column :accounts, :ssl_enabled
  end
end

Эта миграция добавит булево поле в таблицу accounts и удалит его, если вы отменяете миграцию. Она демонстрирует, как все миграции имеют два метода up и down, которые описывают преобразования, необходимые для реализации или удаления миграции. Эти методы могут содержать как специфичные для миграции методы, такие как add_column и remove_column, так и обычный код Ruby для генерации данных, необходимых для преобразований.

Пример более сложной миграции, которая также требует инициализации данных:

class AddSystemSettings < ActiveRecord::Migration[7.2]
  def up
    create_table :system_settings do |t|
      t.string  :name
      t.string  :label
      t.text    :value
      t.string  :type
      t.integer :position
    end

    SystemSetting.create  name:  'notice',
                          label: 'Use notice?',
                          value: 1
  end

  def down
    drop_table :system_settings
  end
end

Эта миграция сначала добавляет таблицу system_settings, затем создаёт первую строку в ней, используя модель Active Record, которая опирается на таблицу. Она также использует расширенный синтаксис create_table, где вы можете указать полную схему таблицы в одном вызове блока.

Доступные преобразования

Создание

• create_join_table(table_1, table_2, options): Создаёт таблицу связи, имя которой соответствует лексикографическому порядку первых двух аргументов. Подробности см. в ActiveRecord::ConnectionAdapters::SchemaStatements#create_join_table.

• create_table(name, options): Создаёт таблицу под названием name и делает объект таблицы доступным в блоке, который затем может добавить столбцы к ней, следуя тому же формату, что и add_column. См. пример выше. Хэш опций предназначен для фрагментов, таких как “DEFAULT CHARSET=UTF-8”, которые добавляются к определению создания таблицы.

• add_column(table_name, column_name, type, options): Добавляет новый столбец в таблицу под названием table_name с именем column_name, заданным как один из следующих типов: :string, :text, :integer, :float, :decimal, :datetime, :timestamp, :time, :date, :binary, :boolean . Значение по умолчанию может быть указано путём передачи хэша options как { default: 11 }. Другие опции включают :limit и :null (например, { limit: 50, null: false }) – см. ActiveRecord::ConnectionAdapters::TableDefinition#column для подробностей.

• add_foreign_key(from_table, to_table, options): Добавляет новую внешнюю ссылку. from_table — таблица со столбцом ключа, to_table содержит ссылаемый первичный ключ.

• add_index(table_name, column_names, options): Добавляет новый индекс с именем столбца. Другие опции включают :name, :unique (например, { name: 'users_name_index', unique: true }) и :order (например, { order: { name: :desc } }).

• add_reference(:table_name, :reference_name): Добавляет новый столбец reference_name_id, по умолчанию целого типа. Подробности см. в ActiveRecord::ConnectionAdapters::SchemaStatements#add_reference.

• add_timestamps(table_name, options): Добавляет столбцы со временем создания (created_at и updated_at) в таблицу table_name.

Модификация

• change_column(table_name, column_name, type, options): Изменяет столбец на другой тип, используя те же параметры, что и add_column.

• change_column_default(table_name, column_name, default_or_changes): Устанавливает значение по умолчанию для column_name, определённое default_or_changes в table_name. Передача хэша, содержащего :from и :to в качестве default_or_changes, сделает это изменение обратимым в миграции.

• change_column_null(table_name, column_name, null, default = nil): Устанавливает или удаляет ограничение NOT NULL для column_name. Флаг null указывает, может ли значение быть NULL. Подробности см. в ActiveRecord::ConnectionAdapters::SchemaStatements#change_column_null.

• change_table(name, options): Позволяет вносить изменения в столбцы в таблице с именем name. Это делает объект таблицы доступным в блоке, который может добавлять/удалять столбцы, индексы или внешние ключи к ней.

• rename_column(table_name, column_name, new_column_name): Переименовывает столбец, сохраняя тип и содержимое.

• rename_index(table_name, old_name, new_name): Переименовывает индекс.

• rename_table(old_name, new_name): Переименовывает таблицу с именем old_name в new_name.

Удаление

• drop_table(name): Удаляет таблицу с именем name.

• drop_join_table(table_1, table_2, options): Удаляет таблицу связи, заданную предоставленными аргументами.

• remove_column(table_name, column_name, type, options): Удаляет столбец с именем column_name из таблицы с именем table_name.

• remove_columns(table_name, *column_names): Удаляет указанные столбцы из определения таблицы.

• remove_foreign_key(from_table, to_table = nil, **options): Удаляет указанный внешний ключ из таблицы с именем table_name.

• remove_index(table_name, column: column_names): Удаляет индекс, указанный column_names.

• remove_index(table_name, name: index_name): Удаляет индекс, указанный index_name.

• remove_reference(table_name, ref_name, options): Удаляет ссылку(и) на table_name, указанную ref_name.

• remove_timestamps(table_name, options): Удаляет столбцы со временем создания (created_at и updated_at ) из определения таблицы.

Необратимые преобразования

Некоторые преобразования являются деструктивными и необратимыми. Миграции такого рода должны вызывать исключение ActiveRecord::IrreversibleMigration в методе down.

Выполнение миграций изнутри Rails

Пакет Rails имеет несколько инструментов для создания и применения миграций.

Для генерации новой миграции можно использовать

$ bin/rails generate migration MyNewMigration

где MyNewMigration — имя вашей миграции. Генератор создаст пустой файл миграции timestamp_my_new_migration.rb в каталоге db/migrate/, где timestamp — отформатированная в UTC дата и время создания миграции.

Существует специальное синтаксическое сокращение для генерации миграций, добавляющих поля в таблицу.

$ bin/rails generate migration add_fieldname_to_tablename fieldname:string

Это сгенерирует файл timestamp_add_fieldname_to_tablename.rb, который будет выглядеть так:

class AddFieldnameToTablename < ActiveRecord::Migration[7.2]
  def change
    add_column :tablenames, :fieldname, :string
  end
end

Для выполнения миграций в текущей конфигурированной базе данных используйте bin/rails db:migrate. Это обновит базу данных, выполнив все ожидающие миграции, создав таблицу schema_migrations (см. раздел «О таблице schema_migrations»), если она отсутствует. Также будет вызван команда db:schema:dump, которая обновит файл db/schema.rb, чтобы он соответствовал структуре вашей базы данных.

Для отката базы данных к предыдущей версии миграции используйте bin/rails db:rollback VERSION=X , где X — версия, до которой вы хотите откатить. В качестве альтернативы, вы также можете использовать опцию STEP, если хотите откатить несколько последних миграций. bin/rails db:rollback STEP=2 откатит две последние миграции.

Если какая-либо из миграций вызывает исключение ActiveRecord::IrreversibleMigration, этот шаг завершится неудачей, и вам придётся выполнить некоторые ручные действия.

Дополнительные примеры

Не все миграции изменяют схему. Некоторые просто исправляют данные:

class RemoveEmptyTags < ActiveRecord::Migration[7.2]
  def up
    Tag.all.each { |tag| tag.destroy if tag.pages.empty? }
  end

  def down
    # not much we can do to restore deleted data
    raise ActiveRecord::IrreversibleMigration, "Can't recover the deleted tags"
  end
end

Другие удаляют столбцы при миграции вверх, а не вниз:

class RemoveUnnecessaryItemAttributes < ActiveRecord::Migration[7.2]
  def up
    remove_column :items, :incomplete_items_count
    remove_column :items, :completed_items_count
  end

  def down
    add_column :items, :incomplete_items_count
    add_column :items, :completed_items_count
  end
end

И иногда вам нужно сделать что-то в SQL, не абстрагируясь непосредственно через миграции:

class MakeJoinUnique < ActiveRecord::Migration[7.2]
  def up
    execute "ALTER TABLE `pages_linked_pages` ADD UNIQUE `page_id_linked_page_id` (`page_id`,`linked_page_id`)"
  end

  def down
    execute "ALTER TABLE `pages_linked_pages` DROP INDEX `page_id_linked_page_id`"
  end
end

Использование модели после изменения её таблицы

Иногда вам нужно добавить столбец в миграцию и заполнить его сразу после этого. В этом случае вам необходимо выполнить вызов Base#reset_column_information для того, чтобы убедиться, что модель имеет последние данные столбца после добавления нового столбца. Пример:

class AddPeopleSalary < ActiveRecord::Migration[7.2]
  def up
    add_column :people, :salary, :integer
    Person.reset_column_information
    Person.all.each do |p|
      p.update_attribute :salary, SalaryCalculator.compute(p)
    end
  end
end

Управление подробностью вывода

По умолчанию миграции будут описывать выполняемые действия, выводя их в консоль по мере выполнения, вместе с показателями времени каждого шага.

Вы можете уменьшить подробность, установив ActiveRecord::Migration.verbose = false.

Вы также можете вставить свои сообщения и показатели времени, используя метод say_with_time:

def up
  ...
  say_with_time "Updating salaries..." do
    Person.all.each do |p|
      p.update_attribute :salary, SalaryCalculator.compute(p)
    end
  end
  ...
end

Фраза «Обновление зарплат…» будет затем выведена, вместе с показателем времени для блока по завершении блока.

Миграции со временем создания

По умолчанию Rails генерирует миграции, которые выглядят так:

20080717013526_your_migration_name.rb

Префикс — это отметка времени генерации (в UTC). Отметки времени не следует изменять вручную. Чтобы проверить, что отметки времени миграций соответствуют формату, ожидаемому Active Record, вы можете использовать следующий параметр конфигурации:

config.active_record.validate_migration_timestamps = true

Если вы предпочитаете использовать числовые префиксы, вы можете отключить миграции со временем создания, установив:

config.active_record.timestamped_migrations = false

В файле application.rb.

Обратимые миграции

Обратимые миграции — это миграции, которые знают, как выполнить обратное преобразование для вас. Вам просто нужно предоставить логику up, и система Migration сама определит, как выполнить команды вниз.

Чтобы определить обратимую миграцию, определите метод change в вашей миграции так:

class TenderloveMigration < ActiveRecord::Migration[7.2]
  def change
    create_table(:horses) do |t|
      t.column :content, :text
      t.column :remind_at, :datetime
    end
  end
end

Эта миграция создаст таблицу horses для вас при движении вверх и автоматически определит, как удалить таблицу при движении вниз.

Некоторые команды не могут быть обращены вспять. Если вам нужно определить, как двигаться вверх и вниз в этих случаях, вы должны определить методы up и down как и раньше.

Если команда не может быть обращена вспять, при движении миграции вниз будет вызвано исключение ActiveRecord::IrreversibleMigration.

Список команд, которые могут быть обращены вспять, см. в ActiveRecord::Migration::CommandRecorder.

Транзакционные миграции

Если адаптер базы данных поддерживает транзакции DDL, все миграции будут автоматически заключены в транзакцию. Однако есть запросы, которые нельзя выполнить внутри транзакции, и в таких ситуациях вы можете отключить автоматические транзакции.

class ChangeEnum < ActiveRecord::Migration[7.2]
  disable_ddl_transaction!

  def up
    execute "ALTER TYPE model_size ADD VALUE 'new_value'"
  end
end

Помните, что вы по-прежнему можете открывать свои собственные транзакции, даже если вы находитесь в Migration с self.disable_ddl_transaction!.