class Sequel::Migrator
The Migrator
class performs migrations based on migration files in a specified directory. The migration files should be named using the following pattern:
<version>_<title>.rb
For example, the following files are considered migration files:
001_create_sessions.rb 002_add_data_column.rb
You can also use timestamps as version numbers:
1273253850_create_sessions.rb 1273257248_add_data_column.rb
If any migration filenames use timestamps as version numbers, Sequel
uses the TimestampMigrator
to migrate, otherwise it uses the IntegerMigrator
. The TimestampMigrator
can handle migrations that are run out of order as well as migrations with the same timestamp, while the IntegerMigrator
is more strict and raises exceptions for missing or duplicate migration files.
The migration files should contain either one Migration
subclass or one Sequel.migration
call.
Migrations are generally run via the sequel command line tool, using the -m and -M switches. The -m switch specifies the migration directory, and the -M switch specifies the version to which to migrate.
You can apply migrations using the Migrator
API, as well (this is necessary if you want to specify the version from which to migrate in addition to the version to which to migrate). To apply a migrator, the apply
method must be invoked with the database instance, the directory of migration files and the target version. If no current version is supplied, it is read from the database. The migrator automatically creates a table (schema_info for integer migrations and schema_migrations for timestamped migrations). in the database to keep track of the current migration version. If no migration version is stored in the database, the version is considered to be 0. If no target version is specified, the database is migrated to the latest version available in the migration directory.
For example, to migrate the database to the latest version:
Sequel::Migrator.run(DB, '.')
For example, to migrate the database all the way down:
Sequel::Migrator.run(DB, '.', target: 0)
For example, to migrate the database to version 4:
Sequel::Migrator.run(DB, '.', target: 4)
To migrate the database from version 1 to version 5:
Sequel::Migrator.run(DB, '.', target: 5, current: 1)
Part of the migration
extension.
Constants
- MIGRATION_FILE_PATTERN
- MUTEX
Mutex used around migration file loading
Attributes
The column to use to hold the migration version number for integer migrations or filename for timestamp migrations (defaults to :version for integer migrations and :filename for timestamp migrations)
The database related to this migrator
The directory for this migrator's files
The dataset for this migrator, representing the schema_info
table for integer migrations and the schema_migrations
table for timestamp migrations
All migration files in this migrator's directory
The table to use to hold the applied migration data (defaults to :schema_info for integer migrations and :schema_migrations for timestamp migrations)
The target version for this migrator
Public Class Methods
Wrapper for run
, maintaining backwards API compatibility
# File lib/sequel/extensions/migration.rb 369 def self.apply(db, directory, target = nil, current = nil) 370 run(db, directory, :target => target, :current => current) 371 end
Raise a NotCurrentError
unless the migrator is current, takes the same arguments as run.
# File lib/sequel/extensions/migration.rb 375 def self.check_current(*args) 376 raise(NotCurrentError, 'migrator is not current') unless is_current?(*args) 377 end
Return whether the migrator is current (i.e. it does not need to make any changes). Takes the same arguments as run.
# File lib/sequel/extensions/migration.rb 381 def self.is_current?(db, directory, opts=OPTS) 382 migrator_class(directory).new(db, directory, opts).is_current? 383 end
Choose the Migrator
subclass to use. Uses the TimestampMigrator
if the version number is greater than 20000101, otherwise uses the IntegerMigrator
.
# File lib/sequel/extensions/migration.rb 406 def self.migrator_class(directory) 407 if self.equal?(Migrator) 408 Dir.new(directory).each do |file| 409 next unless MIGRATION_FILE_PATTERN.match(file) 410 return TimestampMigrator if file.split('_', 2).first.to_i > 20000101 411 end 412 IntegerMigrator 413 else 414 self 415 end 416 end
Setup the state for the migrator
# File lib/sequel/extensions/migration.rb 444 def initialize(db, directory, opts=OPTS) 445 raise(Error, "Must supply a valid migration path") unless File.directory?(directory) 446 @db = db 447 @directory = directory 448 @allow_missing_migration_files = opts[:allow_missing_migration_files] 449 @files = get_migration_files 450 schema, table = @db.send(:schema_and_table, opts[:table] || default_schema_table) 451 @table = schema ? Sequel::SQL::QualifiedIdentifier.new(schema, table) : table 452 @column = opts[:column] || default_schema_column 453 @ds = schema_dataset 454 @use_transactions = opts[:use_transactions] 455 end
Migrates the supplied database using the migration files in the specified directory. Options:
- :allow_missing_migration_files
-
Don't raise an error if there are missing migration files.
- :column
-
The column in the :table argument storing the migration version (default: :version).
- :current
-
The current version of the database. If not given, it is retrieved from the database using the :table and :column options.
- :relative
-
Run the given number of migrations, with a positive number being migrations to migrate up, and a negative number being migrations to migrate down (IntegerMigrator only).
- :table
-
The table containing the schema version (default: :schema_info).
- :target
-
The target version to which to migrate. If not given, migrates to the maximum version.
Examples:
Sequel::Migrator.run(DB, "migrations") Sequel::Migrator.run(DB, "migrations", target: 15, current: 10) Sequel::Migrator.run(DB, "app1/migrations", column: :app2_version) Sequel::Migrator.run(DB, "app2/migrations", column: :app2_version, table: :schema_info2)
# File lib/sequel/extensions/migration.rb 400 def self.run(db, directory, opts=OPTS) 401 migrator_class(directory).new(db, directory, opts).run 402 end
Private Instance Methods
If transactions should be used for the migration, yield to the block inside a transaction. Otherwise, just yield to the block.
# File lib/sequel/extensions/migration.rb 461 def checked_transaction(migration, &block) 462 use_trans = if @use_transactions.nil? 463 if migration.use_transactions.nil? 464 @db.supports_transactional_ddl? 465 else 466 migration.use_transactions 467 end 468 else 469 @use_transactions 470 end 471 472 if use_trans 473 db.transaction(&block) 474 else 475 yield 476 end 477 end
Load the migration file, raising an exception if the file does not define a single migration.
# File lib/sequel/extensions/migration.rb 481 def load_migration_file(file) 482 MUTEX.synchronize do 483 n = Migration.descendants.length 484 load(file) 485 raise Error, "Migration file #{file.inspect} not containing a single migration detected" unless n + 1 == Migration.descendants.length 486 c = Migration.descendants.pop 487 if c.is_a?(Class) && !c.name.to_s.empty? && Object.const_defined?(c.name) 488 Object.send(:remove_const, c.name) 489 end 490 c 491 end 492 end
Return the integer migration version based on the filename.
# File lib/sequel/extensions/migration.rb 495 def migration_version_from_file(filename) 496 filename.split('_', 2).first.to_i 497 end