Class | Sequel::Migrator
In: | lib/sequel/extensions/migration.rb
Parent: | Object

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.apply(DB, '.')

For example, to migrate the database all the way down:

      Sequel::Migrator.apply(DB, '.', 0)

For example, to migrate the database to version 4:

      Sequel::Migrator.apply(DB, '.', 4)

To migrate the database from version 1 to version 5:

      Sequel::Migrator.apply(DB, '.', 5, 1)

Part of the `migration` extension.

### Methods

apply check_current is_current? new run

### Classes and Modules

Class Sequel::Migrator::Error
Class Sequel::Migrator::NotCurrentError

### Constants

MIGRATION_FILE_PATTERN | = | /\A(\d+)_.+\.rb\z/i.freeze
MIGRATION_SPLITTER | = | '_'.freeze
MINIMUM_TIMESTAMP | = | 20000101

### Attributes

column | [R] | 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)
db | [R] | The database related to this migrator
directory | [R] | The directory for this migrator‘s files
ds | [R] | The dataset for this migrator, representing the `schema_info` table for integer migrations and the `schema_migrations` table for timestamp migrations
files | [R] | All migration files in this migrator‘s directory
table | [R] | The table to use to hold the applied migration data (defaults to :schema_info for integer migrations and :schema_migrations for timestamp migrations)
target | [R] | The target version for this migrator

### Public Class methods

apply(db, directory, target = nil, current = nil)

Wrapper for `run`, maintaining backwards API compatibility

[Source]

         # File lib/sequel/extensions/migration.rb, line 352
    352:     def self.apply(db, directory, target = nil, current = nil)
    353:       run(db, directory, :target => target, :current => current)
    354:     end

check_current(*args)

Raise a NotCurrentError unless the migrator is current, takes the same arguments as run.

[Source]

         # File lib/sequel/extensions/migration.rb, line 358
    358:     def self.check_current(*args)
    359:       raise(NotCurrentError, 'migrator is not current') unless is_current?(*args)
    360:     end

is_current?(db, directory, opts={})

Return whether the migrator is current (i.e. it does not need to make any changes). Takes the same arguments as run.

[Source]

         # File lib/sequel/extensions/migration.rb, line 364
    364:     def self.is_current?(db, directory, opts={})
    365:       migrator_class(directory).new(db, directory, opts).is_current?
    366:     end

new(db, directory, opts={})

Setup the state for the migrator

[Source]

         # File lib/sequel/extensions/migration.rb, line 426
    426:     def initialize(db, directory, opts={})
    427:       raise(Error, "Must supply a valid migration path") unless File.directory?(directory)
    428:       @db = db
    429:       @directory = directory
    430:       @files = get_migration_files
    431:       schema, table = @db.send(:schema_and_table, opts[:table]  || self.class.const_get(:DEFAULT_SCHEMA_TABLE))
    432:       @table = schema ? Sequel::SQL::QualifiedIdentifier.new(schema, table) : table
    433:       @column = opts[:column] || self.class.const_get(:DEFAULT_SCHEMA_COLUMN)
    434:       @ds = schema_dataset
    435:       @use_transactions = opts[:use_transactions]
    436:     end

run(db, directory, opts={})

Migrates the supplied database using the migration files in the the specified directory. Options:

- :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.

- :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)

[Source]

         # File lib/sequel/extensions/migration.rb, line 380
    380:     def self.run(db, directory, opts={})
    381:       migrator_class(directory).new(db, directory, opts).run
    382:     end

[Validate]