Class: Sequel::MigrationDSL

Inherits:
BasicObject
Defined in:
lib/sequel/extensions/migration.rb

Overview

Internal class used by the Sequel.migration DSL, part of the migration extension.

Constant Summary

Constants inherited from BasicObject

BasicObject::KEEP_METHODS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BasicObject

const_missing, remove_methods!

Constructor Details

#initialize(&block) ⇒ MigrationDSL

Create a new migration class, and instance_eval the block.


115
116
117
118
119
# File 'lib/sequel/extensions/migration.rb', line 115

def initialize(&block)
  @migration = SimpleMigration.new
  Migration.descendants << migration
  instance_eval(&block)
end

Instance Attribute Details

#migrationObject (readonly)

The underlying Migration instance


108
109
110
# File 'lib/sequel/extensions/migration.rb', line 108

def migration
  @migration
end

Class Method Details

.create(&block) ⇒ Object


110
111
112
# File 'lib/sequel/extensions/migration.rb', line 110

def self.create(&block)
  new(&block).migration
end

Instance Method Details

#change(&block) ⇒ Object

Creates a reversible migration. This is the same as creating the same block with up, but it also calls the block and attempts to create a down block that will reverse the changes made by the block.

There are no guarantees that this will work perfectly in all cases, but it should work for most common cases.


148
149
150
151
# File 'lib/sequel/extensions/migration.rb', line 148

def change(&block)
  migration.up = block
  migration.down = MigrationReverser.new.reverse(&block)
end

#down(&block) ⇒ Object

Defines the migration's down action.


122
123
124
# File 'lib/sequel/extensions/migration.rb', line 122

def down(&block)
  migration.down = block
end

#no_transactionObject

Disable the use of transactions for the related migration


127
128
129
# File 'lib/sequel/extensions/migration.rb', line 127

def no_transaction
  migration.use_transactions = false
end

#transactionObject

Enable the use of transactions for the related migration


132
133
134
# File 'lib/sequel/extensions/migration.rb', line 132

def transaction
  migration.use_transactions = true
end

#up(&block) ⇒ Object

Defines the migration's up action.


137
138
139
# File 'lib/sequel/extensions/migration.rb', line 137

def up(&block)
  migration.up = block
end