Class: ActiveRecord::MigrationContext
- Defined in:
- activerecord/lib/active_record/migration.rb
Overview
MigrationContext sets the context in which a migration is run.
A migration context requires the path to the migrations is set in the migrations_paths
parameter. Optionally a schema_migration
class can be provided. For most applications, SchemaMigration
is sufficient. Multiple database applications need a SchemaMigration
per primary database.
Instance Attribute Summary collapse
-
#migrations_paths ⇒ Object
readonly
Returns the value of attribute migrations_paths.
-
#schema_migration ⇒ Object
readonly
Returns the value of attribute schema_migration.
Instance Method Summary collapse
-
#current_environment ⇒ Object
:nodoc:.
-
#current_version ⇒ Object
:nodoc:.
-
#down(target_version = nil, &block) ⇒ Object
:nodoc:.
-
#forward(steps = 1) ⇒ Object
:nodoc:.
-
#get_all_versions ⇒ Object
:nodoc:.
-
#initialize(migrations_paths, schema_migration = SchemaMigration) ⇒ MigrationContext
constructor
A new instance of MigrationContext.
-
#last_stored_environment ⇒ Object
:nodoc:.
-
#migrate(target_version = nil, &block) ⇒ Object
Runs the migrations in the
migrations_path
. -
#migrations ⇒ Object
:nodoc:.
-
#migrations_status ⇒ Object
:nodoc:.
-
#needs_migration? ⇒ Boolean
:nodoc:.
-
#open ⇒ Object
:nodoc:.
-
#pending_migration_versions ⇒ Object
:nodoc:.
-
#protected_environment? ⇒ Boolean
:nodoc:.
-
#rollback(steps = 1) ⇒ Object
:nodoc:.
-
#run(direction, target_version) ⇒ Object
:nodoc:.
-
#up(target_version = nil, &block) ⇒ Object
:nodoc:.
Constructor Details
#initialize(migrations_paths, schema_migration = SchemaMigration) ⇒ MigrationContext
Returns a new instance of MigrationContext.
1078 1079 1080 1081 |
# File 'activerecord/lib/active_record/migration.rb', line 1078 def initialize(migrations_paths, schema_migration = SchemaMigration) @migrations_paths = migrations_paths @schema_migration = schema_migration end |
Instance Attribute Details
#migrations_paths ⇒ Object (readonly)
Returns the value of attribute migrations_paths.
1076 1077 1078 |
# File 'activerecord/lib/active_record/migration.rb', line 1076 def migrations_paths @migrations_paths end |
#schema_migration ⇒ Object (readonly)
Returns the value of attribute schema_migration.
1076 1077 1078 |
# File 'activerecord/lib/active_record/migration.rb', line 1076 def schema_migration @schema_migration end |
Instance Method Details
#current_environment ⇒ Object
:nodoc:
1197 1198 1199 |
# File 'activerecord/lib/active_record/migration.rb', line 1197 def current_environment # :nodoc: ActiveRecord::ConnectionHandling::DEFAULT_ENV.call end |
#current_version ⇒ Object
:nodoc:
1153 1154 1155 1156 |
# File 'activerecord/lib/active_record/migration.rb', line 1153 def current_version # :nodoc: get_all_versions.max || 0 rescue ActiveRecord::NoDatabaseError end |
#down(target_version = nil, &block) ⇒ Object
:nodoc:
1127 1128 1129 1130 1131 1132 1133 1134 1135 |
# File 'activerecord/lib/active_record/migration.rb', line 1127 def down(target_version = nil, &block) # :nodoc: selected_migrations = if block_given? migrations.select(&block) else migrations end Migrator.new(:down, selected_migrations, schema_migration, target_version).migrate end |
#forward(steps = 1) ⇒ Object
:nodoc:
1113 1114 1115 |
# File 'activerecord/lib/active_record/migration.rb', line 1113 def forward(steps = 1) # :nodoc: move(:up, steps) end |
#get_all_versions ⇒ Object
:nodoc:
1145 1146 1147 1148 1149 1150 1151 |
# File 'activerecord/lib/active_record/migration.rb', line 1145 def get_all_versions # :nodoc: if schema_migration.table_exists? schema_migration.all_versions.map(&:to_i) else [] end end |
#last_stored_environment ⇒ Object
:nodoc:
1205 1206 1207 1208 1209 1210 1211 1212 1213 |
# File 'activerecord/lib/active_record/migration.rb', line 1205 def last_stored_environment # :nodoc: return nil unless ActiveRecord::InternalMetadata.enabled? return nil if current_version == 0 raise NoEnvironmentInSchemaError unless ActiveRecord::InternalMetadata.table_exists? environment = ActiveRecord::InternalMetadata[:environment] raise NoEnvironmentInSchemaError unless environment environment end |
#migrate(target_version = nil, &block) ⇒ Object
Runs the migrations in the migrations_path
.
If target_version
is nil
, migrate
will run up
.
If the current_version
and target_version
are both 0 then an empty array will be returned and no migrations will be run.
If the current_version
in the schema is greater than the target_version
, then down
will be run.
If none of the conditions are met, up
will be run with the target_version
.
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 |
# File 'activerecord/lib/active_record/migration.rb', line 1096 def migrate(target_version = nil, &block) case when target_version.nil? up(target_version, &block) when current_version == 0 && target_version == 0 [] when current_version > target_version down(target_version, &block) else up(target_version, &block) end end |
#migrations ⇒ Object
:nodoc:
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 |
# File 'activerecord/lib/active_record/migration.rb', line 1166 def migrations # :nodoc: migrations = migration_files.map do |file| version, name, scope = parse_migration_filename(file) raise IllegalMigrationNameError.new(file) unless version version = version.to_i name = name.camelize MigrationProxy.new(name, version, file, scope) end migrations.sort_by(&:version) end |
#migrations_status ⇒ Object
:nodoc:
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 |
# File 'activerecord/lib/active_record/migration.rb', line 1179 def migrations_status # :nodoc: db_list = schema_migration.normalized_versions file_list = migration_files.filter_map do |file| version, name, scope = parse_migration_filename(file) raise IllegalMigrationNameError.new(file) unless version version = schema_migration.normalize_migration_number(version) status = db_list.delete(version) ? "up" : "down" [status, version, (name + scope).humanize] end db_list.map! do |version| ["up", version, "********** NO FILE **********"] end (db_list + file_list).sort_by { |_, version, _| version.to_i } end |
#needs_migration? ⇒ Boolean
:nodoc:
1158 1159 1160 |
# File 'activerecord/lib/active_record/migration.rb', line 1158 def needs_migration? # :nodoc: pending_migration_versions.size > 0 end |
#open ⇒ Object
:nodoc:
1141 1142 1143 |
# File 'activerecord/lib/active_record/migration.rb', line 1141 def open # :nodoc: Migrator.new(:up, migrations, schema_migration) end |
#pending_migration_versions ⇒ Object
:nodoc:
1162 1163 1164 |
# File 'activerecord/lib/active_record/migration.rb', line 1162 def pending_migration_versions # :nodoc: migrations.collect(&:version) - get_all_versions end |
#protected_environment? ⇒ Boolean
:nodoc:
1201 1202 1203 |
# File 'activerecord/lib/active_record/migration.rb', line 1201 def protected_environment? # :nodoc: ActiveRecord::Base.protected_environments.include?(last_stored_environment) if last_stored_environment end |
#rollback(steps = 1) ⇒ Object
:nodoc:
1109 1110 1111 |
# File 'activerecord/lib/active_record/migration.rb', line 1109 def rollback(steps = 1) # :nodoc: move(:down, steps) end |
#run(direction, target_version) ⇒ Object
:nodoc:
1137 1138 1139 |
# File 'activerecord/lib/active_record/migration.rb', line 1137 def run(direction, target_version) # :nodoc: Migrator.new(direction, migrations, schema_migration, target_version).run end |
#up(target_version = nil, &block) ⇒ Object
:nodoc:
1117 1118 1119 1120 1121 1122 1123 1124 1125 |
# File 'activerecord/lib/active_record/migration.rb', line 1117 def up(target_version = nil, &block) # :nodoc: selected_migrations = if block_given? migrations.select(&block) else migrations end Migrator.new(:up, selected_migrations, schema_migration, target_version).migrate end |