Class: ActiveRecord::Migrator

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record/migration.rb

Overview

:nodoc:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(direction, migrations_path, target_version = nil) ⇒ Migrator

Returns a new instance of Migrator.

Raises:

  • (StandardError) 


316
317
318
319
320
 
# File 'lib/active_record/migration.rb', line 316

def initialize(direction, migrations_path, target_version = nil)
  raise StandardError.new("This database does not yet support migrations") unless Base.connection.supports_migrations?
  @direction, @migrations_path, @target_version = direction, migrations_path, target_version
  Base.connection.initialize_schema_information
end

Class Method Details

.current_version ⇒ Object 



305
306
307
 
# File 'lib/active_record/migration.rb', line 305

def current_version
  (Base.connection.select_one("SELECT version FROM #{schema_info_table_name}") || {"version" => 0})["version"].to_i
end

.down(migrations_path, target_version = nil) ⇒ Object 



297
298
299
 
# File 'lib/active_record/migration.rb', line 297

def down(migrations_path, target_version = nil)
  self.new(:down, migrations_path, target_version).migrate
end

.migrate(migrations_path, target_version = nil) ⇒ Object 



280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/active_record/migration.rb', line 280

def migrate(migrations_path, target_version = nil)
  Base.connection.initialize_schema_information

  case
    when target_version.nil?, current_version < target_version
      up(migrations_path, target_version)
    when current_version > target_version
      down(migrations_path, target_version)
    when current_version == target_version
      return # You're on the right version
  end
end

.proper_table_name(name) ⇒ Object 



309
310
311
312
 
# File 'lib/active_record/migration.rb', line 309

def proper_table_name(name)
  # Use the ActiveRecord objects own table_name, or pre/suffix from ActiveRecord::Base if name is a symbol/string
  name.table_name rescue "#{ActiveRecord::Base.table_name_prefix}#{name}#{ActiveRecord::Base.table_name_suffix}"
end

.schema_info_table_name ⇒ Object 



301
302
303
 
# File 'lib/active_record/migration.rb', line 301

def schema_info_table_name
  Base.table_name_prefix + "schema_info" + Base.table_name_suffix
end

.up(migrations_path, target_version = nil) ⇒ Object 



293
294
295
 
# File 'lib/active_record/migration.rb', line 293

def up(migrations_path, target_version = nil)
  self.new(:up, migrations_path, target_version).migrate
end

Instance Method Details

#current_version ⇒ Object 



322
323
324
 
# File 'lib/active_record/migration.rb', line 322

def current_version
  self.class.current_version
end

#migrate ⇒ Object 



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/active_record/migration.rb', line 326

def migrate
  migration_classes.each do |(version, migration_class)|
    Base.logger.info("Reached target version: #{@target_version}") and break if reached_target_version?(version)
    next if irrelevant_migration?(version)

    Base.logger.info "Migrating to #{migration_class} (#{version})"
    migration_class.migrate(@direction)
    set_schema_version(version)
  end
end