online_migrations 0.36.1 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d28d3f9893b7c26240f94069032fa65ede6b14a1fb79b8c205111b8eedd934
-  data.tar.gz: da807a14d87705650c05bb7d3151129c534a3c50344b60d0e8e865cdecaa04b5
+  metadata.gz: cdad1569af01bacbaa092898b51ba64ad8f6c9746c091441af38b11921bbe2cc
+  data.tar.gz: 7f3d23f9e0d5b78fb958322e852bcc274e73ef9c035e05e2e072bec1ebcca086
 SHA512:
-  metadata.gz: e8101340c889e837247992f15201b6d1065ae9ea00493f245aad1fe092a7dd2def02965882a5cd29acb9af21504959fd8bbfd95c0f48f911af284ae8fa87baee
-  data.tar.gz: 916c40fec0d7bfe7d08d7402e13ad2b56989921074f566474aeef0280579064ea92377a5b621c427b64205ecf098f3868c104be5772e3a5dd76b68a76f1a16e0
+  metadata.gz: 2fce7817c096a2ca24fed7f8f4984a28bb12a5b4992dd395da4b6ae843ed39684f0917ad0f112c81d7b46ee178a2f3424d7ac9426d32b8ed4a1a83251398985f
+  data.tar.gz: e2cd67a8215dbb287ebdd306c574cbbbfaaafcd5c55b0fb2ec2f393f363870ad3e228dd83fedca3b44287baf148504edf2ca191103e179b63e92675636328c4b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## master (unreleased)
 
+## 0.37.0 (2026-09-23)
+
+- Add ability to restart background migrations
+- Fix collecting referenced tables when using `foreign_key: { to_table: ... }`
+
 ## 0.36.1 (2026-09-23)
 
 - Fix compatibility with future Rails 8.2

data/docs/background_data_migrations.md

@@ -354,6 +354,18 @@ migration.retry # => `true` if scheduled to be retried, `false` - if not
 
 The migration will be retried on the next Scheduler run.
 
+## Restarting a migration
+
+To restart a migration, run:
+
+```ruby
+migration = OnlineMigrations::DataMigrations::Migration.find(id)
+migration.force_restart
+```
+
+It ignores any previous status and marks the migration for the restart. Can be useful if the migration is stuck or
+you need to rerun an already finished migration etc.
+
 ## Configuring
 
 There are a few configurable options for the data migrations. Custom configurations should be placed in a `online_migrations.rb` initializer.

data/docs/background_schema_migrations.md

@@ -77,7 +77,7 @@ You shouldn't depend on the schema until the background schema migration is fini
 To retry a failed migration, run:
 
 ```ruby
-migration = OnlineMigrations::BackgroundSchemaMigrations::Migration.find(id)
+migration = OnlineMigrations::SchemaMigrations::Migration.find(id)
 migration.retry # => `true` if scheduled to be retried, `false` - if not
 ```
 
@@ -88,10 +88,22 @@ The migration will be retried on the next Scheduler run.
 To cancel an existing migration from future performing, run:
 
 ```ruby
-migration = OnlineMigrations::BackgroundSchemaMigrations::Migration.find(id)
+migration = OnlineMigrations::SchemaMigrations::Migration.find(id)
 migration.cancel
 ```
 
+## Restarting a migration
+
+To restart a migration, run:
+
+```ruby
+migration = OnlineMigrations::SchemaMigrations::Migration.find(id)
+migration.force_restart
+```
+
+It ignores any previous status and marks the migration for the restart. Can be useful if the migration is stuck or
+you need to rerun a cancelled migration.
+
 ## Instrumentation
 
 Background schema migrations use the [ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html) API.
@@ -156,7 +168,7 @@ Check the [source code](https://github.com/fatkodima/online_migrations/blob/mast
 **Note**: You can dynamically change certain migration parameters while the migration is run.
 For example,
 ```ruby
-migration = OnlineMigrations::BackgroundSchemaMigrations::Migration.find(id)
+migration = OnlineMigrations::SchemaMigrations::Migration.find(id)
 migration.update!(
   statement_timeout: 2.hours,  # The statement timeout value used when running the migration
   max_attempts: 10             # The # of attempts the failing migration will be retried
@@ -182,7 +194,7 @@ end
 The error handler should be a lambda that accepts 2 arguments:
 
 * `error`: The exception that was raised.
-* `errored_migration`: An `OnlineMigrations::BackgroundSchemaMigrations::Migration` object that represents a failed migration.
+* `errored_migration`: An `OnlineMigrations::SchemaMigrations::Migration` object that represents a failed migration.
 
 ### Multiple databases and sharding
 

data/lib/online_migrations/background_data_migrations/migration.rb

@@ -240,6 +240,24 @@ module OnlineMigrations
         true
       end
 
+      # Force restart this data migration.
+      #
+      def force_restart
+        update_columns(
+          status: :pending,
+          cursor: nil,
+          jid: nil,
+          started_at: nil,
+          finished_at: nil,
+          tick_total: nil,
+          tick_count: 0,
+          time_running: 0.0,
+          error_class: nil,
+          error_message: nil,
+          backtrace: nil
+        )
+      end
+
       # @private
       def persist_progress(cursor, number_of_ticks, duration)
         update!(

data/lib/online_migrations/background_schema_migrations/migration.rb

@@ -135,6 +135,20 @@ module OnlineMigrations
         end
       end
 
+      # Force restart this schema migration.
+      #
+      def force_restart
+        update_columns(
+          status: :pending,
+          started_at: nil,
+          finished_at: nil,
+          attempts: 0,
+          error_class: nil,
+          error_message: nil,
+          backtrace: nil
+        )
+      end
+
       def index_addition?
         definition.match?(/create (unique )?index/i)
       end

data/lib/online_migrations/command_checker.rb

@@ -490,9 +490,10 @@ module OnlineMigrations
         bad_index = index && !concurrently_set
 
         foreign_key = options.fetch(:foreign_key, false)
+        foreign_key_options = foreign_key.is_a?(Hash) ? foreign_key : {}
 
         if foreign_key
-          foreign_table_name = Utils.foreign_table_name(ref_name, options)
+          foreign_table_name = Utils.foreign_table_name(ref_name, foreign_key_options)
           @foreign_key_tables << foreign_table_name.to_s
         end
 
@@ -519,9 +520,10 @@ module OnlineMigrations
 
       def add_reference_concurrently(table_name, ref_name, **options)
         foreign_key = options.fetch(:foreign_key, false)
+        foreign_key_options = foreign_key.is_a?(Hash) ? foreign_key : {}
 
         if foreign_key
-          foreign_table_name = Utils.foreign_table_name(ref_name, options)
+          foreign_table_name = Utils.foreign_table_name(ref_name, foreign_key_options)
           @foreign_key_tables << foreign_table_name.to_s
         end
 
@@ -529,7 +531,6 @@ module OnlineMigrations
           type = (options[:type] || :bigint).to_sym
           column_name = "#{ref_name}_id"
 
-          foreign_key_options = foreign_key.is_a?(Hash) ? foreign_key : {}
           check_mismatched_foreign_key_type(table_name, column_name, type, **foreign_key_options)
         end
       end

data/lib/online_migrations/foreign_keys_collector.rb

@@ -18,9 +18,12 @@ module OnlineMigrations
     end
 
     def references(*ref_names, **options)
-      if options[:foreign_key]
+      foreign_key = options[:foreign_key]
+
+      if foreign_key
+        foreign_key_options = foreign_key.is_a?(Hash) ? foreign_key : {}
         ref_names.each do |ref_name|
-          @referenced_tables << Utils.foreign_table_name(ref_name, options)
+          @referenced_tables << Utils.foreign_table_name(ref_name, foreign_key_options)
         end
       end
     end

data/lib/online_migrations/schema_cache.rb

@@ -79,6 +79,14 @@ module OnlineMigrations
         new_column = old_column.dup
         # Active Record defines only reader for :name
         new_column.instance_variable_set(:@name, new_column_name)
+
+        # https://github.com/rails/rails/commit/0c5b92705960ceff44324e69a921e760f1646503
+        # New in Active Record 8.2+.
+        if new_column.respond_to?(:slot)
+          max_slot = columns.map(&:slot).max
+          new_column.instance_variable_set(:@slot, max_slot + 1)
+        end
+
         # Correspond to the Active Record freezing of each column
         columns << new_column.freeze
       end

data/lib/online_migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OnlineMigrations
-  VERSION = "0.36.1"
+  VERSION = "0.37.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.36.1
+  version: 0.37.0
 platform: ruby
 authors:
 - fatkodima
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Catch unsafe PostgreSQL migrations in development and run them easier in
   production