Class: ActiveRecord::Migrator
- Inherits:
-
Object
- Object
- ActiveRecord::Migrator
- Defined in:
- lib/active_record/migration.rb
Overview
:nodoc:
Class Attribute Summary collapse
Class Method Summary collapse
- .any_migrations? ⇒ Boolean
- .current_version(connection = Base.connection) ⇒ Object
- .down(migrations_paths, target_version = nil, &block) ⇒ Object
- .forward(migrations_paths, steps = 1) ⇒ Object
- .get_all_versions(connection = Base.connection) ⇒ Object
-
.last_migration ⇒ Object
:nodoc:.
- .last_version ⇒ Object
- .migrate(migrations_paths, target_version = nil, &block) ⇒ Object
- .migrations(paths) ⇒ Object
- .migrations_path ⇒ Object
- .needs_migration?(connection = Base.connection) ⇒ Boolean
- .open(migrations_paths) ⇒ Object
- .rollback(migrations_paths, steps = 1) ⇒ Object
- .run(direction, migrations_paths, target_version) ⇒ Object
- .schema_migrations_table_name ⇒ Object
- .up(migrations_paths, target_version = nil) ⇒ Object
Instance Method Summary collapse
- #current_migration ⇒ Object (also: #current)
- #current_version ⇒ Object
-
#initialize(direction, migrations, target_version = nil) ⇒ Migrator
constructor
A new instance of Migrator.
- #migrate ⇒ Object
- #migrated ⇒ Object
- #migrations ⇒ Object
- #pending_migrations ⇒ Object
- #run ⇒ Object
- #runnable ⇒ Object
Constructor Details
#initialize(direction, migrations, target_version = nil) ⇒ Migrator
Returns a new instance of Migrator.
915 916 917 918 919 920 921 922 923 924 925 926 |
# File 'lib/active_record/migration.rb', line 915 def initialize(direction, migrations, target_version = nil) raise StandardError.new("This database does not yet support migrations") unless Base.connection.supports_migrations? @direction = direction @target_version = target_version @migrated_versions = nil @migrations = migrations validate(@migrations) Base.connection.initialize_schema_migrations_table end |
Class Attribute Details
.migrations_paths ⇒ Object
873 874 875 876 877 |
# File 'lib/active_record/migration.rb', line 873 def migrations_paths @migrations_paths ||= ['db/migrate'] # just to not break things if someone uses: migration_path = some_string Array(@migrations_paths) end |
Class Method Details
.any_migrations? ⇒ Boolean
861 862 863 |
# File 'lib/active_record/migration.rb', line 861 def any_migrations? migrations(migrations_paths).any? end |
.current_version(connection = Base.connection) ⇒ Object
853 854 855 |
# File 'lib/active_record/migration.rb', line 853 def current_version(connection = Base.connection) get_all_versions(connection).max || 0 end |
.down(migrations_paths, target_version = nil, &block) ⇒ Object
826 827 828 829 830 831 |
# File 'lib/active_record/migration.rb', line 826 def down(migrations_paths, target_version = nil, &block) migrations = migrations(migrations_paths) migrations.select! { |m| yield m } if block_given? new(:down, migrations, target_version).migrate end |
.forward(migrations_paths, steps = 1) ⇒ Object
815 816 817 |
# File 'lib/active_record/migration.rb', line 815 def forward(migrations_paths, steps=1) move(:up, migrations_paths, steps) end |
.get_all_versions(connection = Base.connection) ⇒ Object
845 846 847 848 849 850 851 |
# File 'lib/active_record/migration.rb', line 845 def get_all_versions(connection = Base.connection) if connection.table_exists?(schema_migrations_table_name) SchemaMigration.all.map { |x| x.version.to_i }.sort else [] end end |
.last_migration ⇒ Object
:nodoc:
869 870 871 |
# File 'lib/active_record/migration.rb', line 869 def last_migration #:nodoc: migrations(migrations_paths).last || NullMigration.new end |
.last_version ⇒ Object
865 866 867 |
# File 'lib/active_record/migration.rb', line 865 def last_version last_migration.version end |
.migrate(migrations_paths, target_version = nil, &block) ⇒ Object
798 799 800 801 802 803 804 805 806 807 808 809 |
# File 'lib/active_record/migration.rb', line 798 def migrate(migrations_paths, target_version = nil, &block) case when target_version.nil? up(migrations_paths, target_version, &block) when current_version == 0 && target_version == 0 [] when current_version > target_version down(migrations_paths, target_version, &block) else up(migrations_paths, target_version, &block) end end |
.migrations(paths) ⇒ Object
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 |
# File 'lib/active_record/migration.rb', line 883 def migrations(paths) paths = Array(paths) files = Dir[*paths.map { |p| "#{p}/**/[0-9]*_*.rb" }] migrations = files.map do |file| version, name, scope = file.scan(/([0-9]+)_([_a-z0-9]*)\.?([_a-z0-9]*)?\.rb\z/).first 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_path ⇒ Object
879 880 881 |
# File 'lib/active_record/migration.rb', line 879 def migrations_path migrations_paths.first end |
.needs_migration?(connection = Base.connection) ⇒ Boolean
857 858 859 |
# File 'lib/active_record/migration.rb', line 857 def needs_migration?(connection = Base.connection) (migrations(migrations_paths).collect(&:version) - get_all_versions(connection)).size > 0 end |
.open(migrations_paths) ⇒ Object
837 838 839 |
# File 'lib/active_record/migration.rb', line 837 def open(migrations_paths) new(:up, migrations(migrations_paths), nil) end |
.rollback(migrations_paths, steps = 1) ⇒ Object
811 812 813 |
# File 'lib/active_record/migration.rb', line 811 def rollback(migrations_paths, steps=1) move(:down, migrations_paths, steps) end |
.run(direction, migrations_paths, target_version) ⇒ Object
833 834 835 |
# File 'lib/active_record/migration.rb', line 833 def run(direction, migrations_paths, target_version) new(direction, migrations(migrations_paths), target_version).run end |
.schema_migrations_table_name ⇒ Object
841 842 843 |
# File 'lib/active_record/migration.rb', line 841 def schema_migrations_table_name SchemaMigration.table_name end |
.up(migrations_paths, target_version = nil) ⇒ Object
819 820 821 822 823 824 |
# File 'lib/active_record/migration.rb', line 819 def up(migrations_paths, target_version = nil) migrations = migrations(migrations_paths) migrations.select! { |m| yield m } if block_given? new(:up, migrations, target_version).migrate end |
Instance Method Details
#current_migration ⇒ Object Also known as: current
932 933 934 |
# File 'lib/active_record/migration.rb', line 932 def current_migration migrations.detect { |m| m.version == current_version } end |
#current_version ⇒ Object
928 929 930 |
# File 'lib/active_record/migration.rb', line 928 def current_version migrated.max || 0 end |
#migrate ⇒ Object
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 |
# File 'lib/active_record/migration.rb', line 950 def migrate if !target && @target_version && @target_version > 0 raise UnknownMigrationVersionError.new(@target_version) end runnable.each do |migration| Base.logger.info "Migrating to #{migration.name} (#{migration.version})" if Base.logger begin execute_migration_in_transaction(migration, @direction) rescue => e canceled_msg = use_transaction?(migration) ? "this and " : "" raise StandardError, "An error has occurred, #{canceled_msg}all later migrations canceled:\n\n#{e}", e.backtrace end end end |
#migrated ⇒ Object
987 988 989 |
# File 'lib/active_record/migration.rb', line 987 def migrated @migrated_versions ||= Set.new(self.class.get_all_versions) end |
#migrations ⇒ Object
978 979 980 |
# File 'lib/active_record/migration.rb', line 978 def migrations down? ? @migrations.reverse : @migrations.sort_by(&:version) end |
#pending_migrations ⇒ Object
982 983 984 985 |
# File 'lib/active_record/migration.rb', line 982 def pending_migrations already_migrated = migrated migrations.reject { |m| already_migrated.include?(m.version) } end |
#run ⇒ Object
937 938 939 940 941 942 943 944 945 946 947 948 |
# File 'lib/active_record/migration.rb', line 937 def run migration = migrations.detect { |m| m.version == @target_version } raise UnknownMigrationVersionError.new(@target_version) if migration.nil? unless (up? && migrated.include?(migration.version.to_i)) || (down? && !migrated.include?(migration.version.to_i)) begin execute_migration_in_transaction(migration, @direction) rescue => e canceled_msg = use_transaction?(migration) ? ", this migration was canceled" : "" raise StandardError, "An error has occurred#{canceled_msg}:\n\n#{e}", e.backtrace end end end |
#runnable ⇒ Object
967 968 969 970 971 972 973 974 975 976 |
# File 'lib/active_record/migration.rb', line 967 def runnable runnable = migrations[start..finish] if up? runnable.reject { |m| ran?(m) } else # skip the last migration if we're headed down, but not ALL the way down runnable.pop if target runnable.find_all { |m| ran?(m) } end end |