Class: Sequel::TimestampMigrator

Inherits:
Migrator show all
Defined in:
lib/sequel/extensions/migration.rb

Overview

The migrator used if any migration file version is greater than 20000101. Stores filenames of migration files, and can figure out which migrations have not been applied and apply them, even if earlier migrations are added after later migrations. If you plan to do that, the responsibility is on you to make sure the migrations don’t conflict. Part of the migration extension.

Constant Summary collapse

Error = 
Migrator::Error

Constants inherited from Migrator

Migrator::MIGRATION_FILE_PATTERN, Migrator::MUTEX

Instance Attribute Summary collapse

Attributes inherited from Migrator

#column, #db, #directory, #ds, #files, #table, #target

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Migrator

apply, check_current, is_current?, migrator_class, run

Constructor Details

#initialize(db, directory, opts = OPTS) ⇒ TimestampMigrator

Set up all state for the migrator instance



689
690
691
692
693
694
 
# File 'lib/sequel/extensions/migration.rb', line 689

def initialize(db, directory, opts=OPTS)
  super
  @target = opts[:target]
  @applied_migrations = get_applied_migrations
  @migration_tuples = get_migration_tuples
end

Instance Attribute Details

#applied_migrations ⇒ Object (readonly)

Array of strings of applied migration filenames



683
684
685
 
# File 'lib/sequel/extensions/migration.rb', line 683

def applied_migrations
  @applied_migrations
end

#migration_tuples ⇒ Object (readonly)

Get tuples of migrations, filenames, and actions for each migration



686
687
688
 
# File 'lib/sequel/extensions/migration.rb', line 686

def migration_tuples
  @migration_tuples
end

Class Method Details

.run_single(db, path, opts = OPTS) ⇒ Object

Apply the migration in the given file path. See Migrator.run for the available options. Additionally, this method supports the :direction option for whether to run the migration up (default) or down.



699
700
701
 
# File 'lib/sequel/extensions/migration.rb', line 699

def self.run_single(db, path, opts=OPTS)
  new(db, File.dirname(path), opts).run_single(path, opts[:direction] || :up)
end

Instance Method Details

#is_current? ⇒ Boolean

The timestamp migrator is current if there are no migrations to apply in either direction.

Returns:

  • (Boolean) 


705
706
707
 
# File 'lib/sequel/extensions/migration.rb', line 705

def is_current?
  migration_tuples.empty?
end

#run ⇒ Object

Apply all migration tuples on the database



710
711
712
713
714
715
 
# File 'lib/sequel/extensions/migration.rb', line 710

def run
  migration_tuples.each do |m, f, direction|
    apply_migration(m, f, direction)
  end
  nil
end

#run_single(path, direction) ⇒ Object

Apply single migration tuple at the given path with the given direction on the database.



719
720
721
722
723
724
725
726
727
728
 
# File 'lib/sequel/extensions/migration.rb', line 719

def run_single(path, direction)
  migration = load_migration_file(path)
  file_name = File.basename(path)
  already_applied = applied_migrations.include?(file_name.downcase)

  return if direction == :up ? already_applied : !already_applied

  apply_migration(migration, file_name, direction)
  nil
end