Method: Lhm#change_table

Defined in:
lib/lhm.rb

#change_table(table_name, options = {}) {|Migrator| ... } ⇒ Boolean

Alters a table with the changes described in the block

Parameters:

  • table_name (String, Symbol) —

    Name of the table

  • options (Hash) (defaults to: {}) —

    Optional options to alter the chunk / switch behavior

Options Hash (options):

  • :stride (Fixnum) —

    Size of a chunk (defaults to: 40,000)

  • :throttle (Fixnum) —

    Time to wait between chunks in milliseconds (defaults to: 100)

  • :start (Fixnum) —

    Primary Key position at which to start copying chunks

  • :limit (Fixnum) —

    Primary Key position at which to stop copying chunks

  • :atomic_switch (Boolean) —

    Use atomic switch to rename tables (defaults to: true) If using a version of mysql affected by atomic switch bug, LHM forces user to set this option (see SqlHelper#supports_atomic_switch?)

Yields:

  • (Migrator) —

    Yielded Migrator object records the changes

Returns:

  • (Boolean) —

    Returns true if the migration finishes

Raises:

  • (Error) —

    Raises Lhm::Error in case of a error and aborts the migration



46
47
48
49
50
51
52
 
# File 'lib/lhm.rb', line 46

def change_table(table_name, options = {}, &block)
  origin = Table.parse(table_name, connection)
  invoker = Invoker.new(origin, connection)
  block.call(invoker.migrator)
  invoker.run(options)
  true
end