Class: Sequel::Migration

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

Overview

Sequel's older migration class, available for backward compatibility. Uses subclasses with up and down instance methods for each migration:

Class.new(Sequel::Migration) do
  def up
    create_table(:artists) do
      primary_key :id
      String :name
    end
  end

  def down
    drop_table(:artists)
  end
end

Part of the migration extension.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(db) ⇒ Migration

Set the database associated with this migration.



30
31
32
# File 'lib/sequel/extensions/migration.rb', line 30

def initialize(db)
  @db = db
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_sym, *args, &block) ⇒ Object

Intercepts method calls intended for the database and sends them along.



61
62
63
# File 'lib/sequel/extensions/migration.rb', line 61

def method_missing(method_sym, *args, &block)
  @db.send(method_sym, *args, &block)
end

Class Method Details

.apply(db, direction) ⇒ Object

Applies the migration to the supplied database in the specified direction.

Raises:

  • (ArgumentError)


36
37
38
39
# File 'lib/sequel/extensions/migration.rb', line 36

def self.apply(db, direction)
  raise(ArgumentError, "Invalid migration direction specified (#{direction.inspect})") unless [:up, :down].include?(direction)
  new(db).send(direction)
end

.descendantsObject

Returns the list of Migration descendants.



42
43
44
# File 'lib/sequel/extensions/migration.rb', line 42

def self.descendants
  @descendants ||= []
end

.inherited(base) ⇒ Object

Adds the new migration class to the list of Migration descendants.



47
48
49
# File 'lib/sequel/extensions/migration.rb', line 47

def self.inherited(base)
  descendants << base
end

.use_transactionsObject

Don't allow transaction overriding in old migrations.



52
53
54
# File 'lib/sequel/extensions/migration.rb', line 52

def self.use_transactions
  nil
end

Instance Method Details

#downObject

The default down action does nothing



57
58
# File 'lib/sequel/extensions/migration.rb', line 57

def down
end

#respond_to_missing?(meth, include_private) ⇒ Boolean

This object responds to all methods the database responds to.

Returns:

  • (Boolean)


66
67
68
# File 'lib/sequel/extensions/migration.rb', line 66

def respond_to_missing?(meth, include_private)
  @db.respond_to?(meth, include_private)
end

#upObject

The default up action does nothing



71
72
# File 'lib/sequel/extensions/migration.rb', line 71

def up
end