класс ActiveRecord::Migration::CommandRecorder

Родитель:: Объект

Запись команд миграции

ActiveRecord::Migration::CommandRecorder записывает команды, выполненные во время миграции, и знает, как отменить эти команды. CommandRecorder знает, как инвертировать следующие команды:

add_column
add_foreign_key
add_check_constraint
add_exclusion_constraint
add_unique_constraint
add_index
add_reference
add_timestamps
change_column_default (необходимо указать :from и :to опции)
change_column_null
change_column_comment (необходимо указать :from и :to опции)
change_table_comment (необходимо указать :from и :to опции)
create_enum
create_join_table
create_table
disable_extension
drop_enum (необходимо указать список значений)
drop_join_table
drop_table (необходимо указать блок)
enable_extension
remove_column (необходимо указать тип)
remove_columns (необходимо указать :type опцию)
remove_foreign_key (необходимо указать вторую таблицу)
remove_check_constraint
remove_exclusion_constraint
remove_unique_constraint
remove_index
remove_reference
remove_timestamps
rename_column
rename_enum (необходимо указать :to опцию)
rename_enum_value (необходимо указать :from и :to опции)
rename_index
rename_table

Постоянные значения

ReversibleAndIrreversibleMethods

Атрибуты

commands[RW]

delegate[RW]

reverting[RW]

Публичные методы класса

new(delegate = nil) Показать исходный код

# File activerecord/lib/active_record/migration/command_recorder.rb, line 63
def initialize(delegate = nil)
  @commands = []
  @delegate = delegate
  @reverting = false
end

Публичные методы экземпляра

inverse_of(command, args, &block) Показать исходный код

# File activerecord/lib/active_record/migration/command_recorder.rb, line 110
      def inverse_of(command, args, &block)
        method = :"invert_#{command}"
        raise IrreversibleMigration, <<~MSG unless respond_to?(method, true)
          This migration uses #{command}, which is not automatically reversible.
          To make the migration reversible you can either:
          1. Define #up and #down methods in place of the #change method.
          2. Use the #reversible method to define reversible behavior.
        MSG
        send(method, args, &block)
      end

Возвращает обратную операцию для данной команды. Например:

recorder.inverse_of(:rename_table, [:old, :new])
# => [:rename_table, [:new, :old]]

Если для инверсии команды требуются несколько команд, возвращает массив команд.

recorder.inverse_of(:remove_columns, [:some_table, :foo, :bar, type: :string])
# => [[:add_column, :some_table, :foo, :string], [:add_column, :some_table, :bar, :string]]

Этот метод вызовет исключение IrreversibleMigration, если не сможет инвертировать command.

record(*command, &block) Показать исходный код

# File activerecord/lib/active_record/migration/command_recorder.rb, line 90
def record(*command, &block)
  if @reverting
    @commands << inverse_of(*command, &block)
  else
    @commands << (command << block)
  end
end

Запись command. command должно быть именем метода и аргументами. Например:

recorder.record(:method_name, [:arg1, :arg2])

replay(migration) Показать исходный код

# File activerecord/lib/active_record/migration/command_recorder.rb, line 144
def replay(migration)
  commands.each do |cmd, args, block|
    migration.send(cmd, *args, &block)
  end
end

revert() { || ... } Показать исходный код

# File activerecord/lib/active_record/migration/command_recorder.rb, line 76
def revert
  @reverting = !@reverting
  previous = @commands
  @commands = []
  yield
ensure
  @commands = previous.concat(@commands.reverse)
  @reverting = !@reverting
end

При выполнении данного блока, запись будет находиться в режиме отмены. Все записанные команды будут в итоге записаны в обратном порядке. Например:

recorder.revert{ recorder.record(:rename_table, [:old, :new]) }
# same effect as recorder.record(:rename_table, [:new, :old])