online_migrations 0.21.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ecf0ad3b1c2bc1992e9ec205018212b4d3c663f2a3040271a0cce45d4b9f60c
-  data.tar.gz: fcc3a3ac5b96fc3bd893f251949969794ebde738e5f663eb367fd191fa50784d
+  metadata.gz: 1052d2cc58898bc561b5e755daccc137d7d6e1d35afa3af5968c2b655ebe5805
+  data.tar.gz: ad72d601c36ea9192f192fb8941d30a2cfbcf0ed87e0717fb5d4ebf47b20f169
 SHA512:
-  metadata.gz: c5a92bde9892d9f7bf545248d359527c9fac1a41b31e6eabf34f0da0a1342fdfc9e54ccc853aba6e35414d368328979d7b445246f71e72e0ac09cce80ad8a02f
-  data.tar.gz: d244cb531e3e2f58d140e75af1f8fc571a272d9d188d87f0e52d89b7efbc7233eb4c1df7bac63fe32d1e7b79643e1202872b951f1fcfc2b8ca5fa9c3abdc7746
+  metadata.gz: 697ac61bcb41e00744cfa87965910a3e1d68eaa571ad5c6dc3b3d8a4d14deb16ae0cbc0d9771d8d57668be8529f200736a14c1769d7d8cf6c64fc083060ff74c
+  data.tar.gz: 7b4e383f7628ba5cc74c2bb86f4460890b70f3052738f0f20db3571ee770e22c49bc548f5c0ef3fd47caa456a84eb4174f031742869612ee3b27505faf49ecec

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 ## master (unreleased)
 
+## 0.23.0 (2025-01-13)
+
+- Prevent multiple instances of schedulers from being running simultaneously
+
+- Reduce default batch sizes for background data migrations
+
+    `batch_size` was 20_000, now 1_000; `sub_batch_size` was 1_000, now 100
+
+- Remove deprecated code
+- Drop support for PostgreSQL < 12
+- Drop support for Ruby < 3.0 and Rails < 7.0
+
+## 0.22.0 (2025-01-03)
+
+- Make background data migrations scheduler run a single migration at a time
+
+    This is similar to background schema migrations scheduler's behavior.
+    Running multiple migrations at a time can cause unneeded database load and other bad effects.
+
+- Add `#pausable?`, `#can_be_cancelled?` and `#can_be_paused?` helpers to background migrations
+
 ## 0.21.0 (2024-12-09)
 
 - Fix `add_foreign_key` when referencing same table via different columns

data/README.md

@@ -16,11 +16,11 @@ See [comparison to `strong_migrations`](#comparison-to-strong_migrations)
 
 ## Requirements
 
-- Ruby 2.7+
-- Rails 6.1+
-- PostgreSQL 9.6+
+- Ruby 3.0+
+- Rails 7.0+
+- PostgreSQL 12+
 
-For older Ruby and Rails versions you can use '< 0.11' version of this gem.
+For older Ruby and Rails versions you can use older versions of this gem.
 
 **Note**: Since some migration helpers use database `VIEW`s to implement their logic, it is recommended to use `structure.sql` schema format, or otherwise add some gem (like [scenic](https://github.com/scenic-views/scenic)) to be able to dump them into the `schema.rb`.
 

data/lib/generators/online_migrations/templates/initializer.rb.tt

@@ -4,11 +4,13 @@ OnlineMigrations.configure do |config|
   # Configure the migration version starting after which checks are performed.
   # config.start_after = <%= start_after %>
 
-  # Configure statement timeout used for migrations.
+  # Configure statement timeout for migrations (in seconds).
+  # Note: Background data migrations use application specific timeouts and
+  # background schema migrations use their custom timeouts.
   config.statement_timeout = 1.hour
 
   # Set the version of the production database so the right checks are run in development.
-  # config.target_version = 10
+  # config.target_version = 17
 
   # Configure whether to perform checks when migrating down.
   config.check_down = false
@@ -19,7 +21,7 @@ OnlineMigrations.configure do |config|
 
   # Maximum allowed lock timeout value (in seconds).
   # If set lock timeout is greater than this value, the migration will fail.
-  # config.lock_timeout_limit = 10.seconds
+  config.lock_timeout_limit = 10.seconds
 
   # Configure list of tables with permanently small number of records.
   # This tables are usually tables like "settings", "prices", "plans" etc.
@@ -28,10 +30,10 @@ OnlineMigrations.configure do |config|
 
   # Analyze tables after indexes are added.
   # Outdated statistics can sometimes hurt performance.
-  # config.auto_analyze = true
+  config.auto_analyze = false
 
   # Alphabetize table columns when dumping the schema.
-  # config.alphabetize_schema = true
+  config.alphabetize_schema = false
 
   # Disable specific checks.
   # For the list of available checks look at the `error_messages.rb` file inside
@@ -92,29 +94,29 @@ OnlineMigrations.configure do |config|
 
   # ==> Background data migrations configuration
   # The path where generated background migrations will be placed.
-  # config.background_migrations.migrations_path = "lib"
+  config.background_migrations.migrations_path = "lib"
 
   # The module in which background migrations will be placed.
-  # config.background_migrations.migrations_module = "OnlineMigrations::BackgroundMigrations"
+  config.background_migrations.migrations_module = "OnlineMigrations::BackgroundMigrations"
 
   # The number of rows to process in a single background migration run.
-  # config.background_migrations.batch_size = 20_000
+  config.background_migrations.batch_size = 1_000
 
   # The smaller batches size that the batches will be divided into.
-  # config.background_migrations.sub_batch_size = 1000
+  config.background_migrations.sub_batch_size = 100
 
   # The pause interval between each background migration job's execution (in seconds).
-  # config.background_migrations.batch_pause = 0.seconds
+  config.background_migrations.batch_pause = 0.seconds
 
   # The number of milliseconds to sleep between each sub_batch execution.
-  # config.background_migrations.sub_batch_pause_ms = 100
+  config.background_migrations.sub_batch_pause_ms = 100
 
   # Maximum number of batch run attempts.
   # When attempts are exhausted, the individual batch is marked as failed.
-  # config.background_migrations.batch_max_attempts = 5
+  config.background_migrations.batch_max_attempts = 5
 
   # The number of seconds that must pass before the running job is considered stuck.
-  # config.background_migrations.stuck_jobs_timeout = 1.hour
+  config.background_migrations.stuck_jobs_timeout = 1.hour
 
   # The callback to perform when an error occurs in the migration job.
   # config.background_migrations.error_handler = ->(error, errored_job) do
@@ -125,10 +127,10 @@ OnlineMigrations.configure do |config|
 
   # ==> Background schema migrations configuration
   # When attempts are exhausted, the failing migration stops to be retried.
-  # config.background_schema_migrations.max_attempts = 5
+  config.background_schema_migrations.max_attempts = 5
 
   # Statement timeout value used when running background schema migration.
-  # config.background_schema_migrations.statement_timeout = 1.hour
+  config.background_schema_migrations.statement_timeout = 1.hour
 
   # The callback to perform when an error occurs during the background schema migration.
   # config.background_schema_migrations.error_handler = ->(error, errored_migration) do

data/lib/online_migrations/advisory_lock.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "zlib"
+
+module OnlineMigrations
+  # @private
+  class AdvisoryLock
+    attr_reader :name, :connection
+
+    def initialize(name:, connection: ApplicationRecord.connection)
+      @name = name
+      @connection = connection
+    end
+
+    def try_lock
+      locked = connection.select_value("SELECT pg_try_advisory_lock(#{lock_key})")
+      Utils.to_bool(locked)
+    end
+
+    def unlock
+      connection.select_value("SELECT pg_advisory_unlock(#{lock_key})")
+    end
+
+    # Runs the given block if an advisory lock is able to be acquired.
+    def try_with_lock
+      if try_lock
+        begin
+          yield
+        ensure
+          unlock
+        end
+      end
+    end
+
+    def active?
+      objid = lock_key & 0xffffffff
+      classid = lock_key >> 32
+
+      active = connection.select_value(<<~SQL)
+        SELECT granted
+        FROM pg_locks
+        WHERE locktype = 'advisory'
+          AND pid = pg_backend_pid()
+          AND mode = 'ExclusiveLock'
+          AND classid = #{classid}
+          AND objid = #{objid}
+      SQL
+
+      Utils.to_bool(active)
+    end
+
+    private
+      SALT = 936723412
+
+      def lock_key
+        name_hash = Zlib.crc32(name)
+        SALT * name_hash
+      end
+  end
+end

data/lib/online_migrations/background_migrations/config.rb

@@ -13,12 +13,12 @@ module OnlineMigrations
       attr_accessor :migrations_module
 
       # The number of rows to process in a single background migration run
-      # @return [Integer] defaults to 20_000
+      # @return [Integer] defaults to 1_000
       #
       attr_accessor :batch_size
 
       # The smaller batches size that the batches will be divided into
-      # @return [Integer] defaults to 1000
+      # @return [Integer] defaults to 100
       #
       attr_accessor :sub_batch_size
 
@@ -39,36 +39,12 @@ module OnlineMigrations
       #
       attr_accessor :batch_max_attempts
 
-      def throttler
-        OnlineMigrations.deprecator.warn(<<~MSG)
-          `config.background_migrations.throttler` is deprecated and will be removed.
-          Use `config.throttler` instead.
-        MSG
-        OnlineMigrations.config.throttler
-      end
-
       # The number of seconds that must pass before the running job is considered stuck
       #
       # @return [Integer] defaults to 1 hour
       #
       attr_accessor :stuck_jobs_timeout
 
-      def backtrace_cleaner
-        OnlineMigrations.deprecator.warn(<<~MSG)
-          `config.background_migrations.backtrace_cleaner` is deprecated and will be removed.
-          Use `config.backtrace_cleaner` instead.
-        MSG
-        OnlineMigrations.config.backtrace_cleaner
-      end
-
-      def backtrace_cleaner=(value)
-        OnlineMigrations.deprecator.warn(<<~MSG)
-          `config.background_migrations.backtrace_cleaner=` is deprecated and will be removed.
-          Use `config.backtrace_cleaner=` instead.
-        MSG
-        OnlineMigrations.config.backtrace_cleaner = value
-      end
-
       # The callback to perform when an error occurs in the migration job.
       #
       # @example
@@ -85,22 +61,14 @@ module OnlineMigrations
       def initialize
         @migrations_path = "lib"
         @migrations_module = "OnlineMigrations::BackgroundMigrations"
-        @batch_size = 20_000
-        @sub_batch_size = 1000
+        @batch_size = 1_000
+        @sub_batch_size = 100
         @batch_pause = 0.seconds
         @sub_batch_pause_ms = 100
         @batch_max_attempts = 5
         @stuck_jobs_timeout = 1.hour
         @error_handler = ->(error, errored_job) {}
       end
-
-      def throttler=(value)
-        OnlineMigrations.deprecator.warn(<<~MSG)
-          `config.background_migrations.throttler=` is deprecated and will be removed.
-          Use `config.throttler=` instead.
-        MSG
-        OnlineMigrations.config.throttler = value
-      end
     end
   end
 end

data/lib/online_migrations/background_migrations/migration.rb

@@ -32,12 +32,7 @@ module OnlineMigrations
 
       alias_attribute :name, :migration_name
 
-      # Avoid deprecation warnings.
-      if Utils.ar_version >= 7
-        enum :status, STATUSES.index_with(&:to_s)
-      else
-        enum status: STATUSES.index_with(&:to_s)
-      end
+      enum :status, STATUSES.index_with(&:to_s)
 
       belongs_to :parent, class_name: name, optional: true, inverse_of: :children
       has_many :children, class_name: name, foreign_key: :parent_id, dependent: :delete_all, inverse_of: :parent
@@ -110,6 +105,18 @@ module OnlineMigrations
       end
       alias cancel cancelled!
 
+      def pausable?
+        true
+      end
+
+      def can_be_paused?
+        enqueued? || running?
+      end
+
+      def can_be_cancelled?
+        !succeeded? && !cancelled?
+      end
+
       def last_job
         migration_jobs.order(:max_value).last
       end

data/lib/online_migrations/background_migrations/migration_helpers.rb

@@ -335,8 +335,8 @@ module OnlineMigrations
       #     defaults to `SELECT MIN(batch_column_name)`
       # @option options [Integer] :max_value Value in the column the batching will end at,
       #     defaults to `SELECT MAX(batch_column_name)`
-      # @option options [Integer] :batch_size (20_000) Number of rows to process in a single background migration run
-      # @option options [Integer] :sub_batch_size (1000) Smaller batches size that the batches will be divided into
+      # @option options [Integer] :batch_size (1_000) Number of rows to process in a single background migration run
+      # @option options [Integer] :sub_batch_size (100) Smaller batches size that the batches will be divided into
       # @option options [Integer] :batch_pause (0) Pause interval between each background migration job's execution (in seconds)
       # @option options [Integer] :sub_batch_pause_ms (100) Number of milliseconds to sleep between each sub_batch execution
       # @option options [Integer] :batch_max_attempts (5) Maximum number of batch run attempts

data/lib/online_migrations/background_migrations/migration_job.rb

@@ -38,12 +38,7 @@ module OnlineMigrations
       scope :except_succeeded, -> { where.not(status: :succeeded) }
       scope :attempts_exceeded, -> { where("attempts >= max_attempts") }
 
-      # Avoid deprecation warnings.
-      if Utils.ar_version >= 7
-        enum :status, STATUSES.index_with(&:to_s)
-      else
-        enum status: STATUSES.index_with(&:to_s)
-      end
+      enum :status, STATUSES.index_with(&:to_s)
 
       delegate :migration_name, :migration_class, :migration_object, :migration_relation, :batch_column_name,
         :arguments, :batch_pause, to: :migration

data/lib/online_migrations/background_migrations/scheduler.rb

@@ -3,9 +3,10 @@
 module OnlineMigrations
   module BackgroundMigrations
     # Class responsible for scheduling background migrations.
-    # It selects runnable background migrations and runs them one step (one batch) at a time.
+    #
+    # It selects a single runnable background migration and runs it one step (one batch) at a time.
     # A migration is considered runnable if it is not completed and the time interval between
-    #   successive runs has passed.
+    # successive runs has passed.
     #
     # Scheduler should be configured to run periodically, for example, via cron.
     # @example Run via whenever
@@ -22,17 +23,21 @@ module OnlineMigrations
       # Runs Scheduler
       def run
         active_migrations = Migration.runnable.active.queue_order
-        runnable_migrations = active_migrations.select(&:interval_elapsed?)
+        runnable_migration = active_migrations.select(&:interval_elapsed?).first
+
+        if runnable_migration
+          runner = MigrationRunner.new(runnable_migration)
 
-        runnable_migrations.each do |migration|
-          run_migration_job(migration)
+          try_with_lock do
+            runner.run_migration_job
+          end
         end
       end
 
       private
-        def run_migration_job(migration)
-          runner = MigrationRunner.new(migration)
-          runner.run_migration_job
+        def try_with_lock(&block)
+          lock = AdvisoryLock.new(name: "online_migrations_data_scheduler")
+          lock.try_with_lock(&block)
         end
     end
   end

data/lib/online_migrations/background_schema_migrations/migration.rb

@@ -49,12 +49,7 @@ module OnlineMigrations
 
       alias_attribute :name, :migration_name
 
-      # Avoid deprecation warnings.
-      if Utils.ar_version >= 7
-        enum :status, STATUSES.index_with(&:to_s)
-      else
-        enum status: STATUSES.index_with(&:to_s)
-      end
+      enum :status, STATUSES.index_with(&:to_s)
 
       belongs_to :parent, class_name: name, optional: true, inverse_of: :children
       has_many :children, class_name: name, foreign_key: :parent_id, inverse_of: :parent
@@ -94,6 +89,18 @@ module OnlineMigrations
       end
       alias cancel cancelled!
 
+      def pausable?
+        false
+      end
+
+      def can_be_paused?
+        false
+      end
+
+      def can_be_cancelled?
+        !succeeded? && !cancelled?
+      end
+
       # Returns the progress of the background schema migration.
       #
       # @return [Float] value in range from 0.0 to 100.0

data/lib/online_migrations/background_schema_migrations/scheduler.rb

@@ -23,7 +23,10 @@ module OnlineMigrations
         migration = find_migration
         if migration
           runner = MigrationRunner.new(migration)
-          runner.run
+
+          try_with_lock do
+            runner.run
+          end
         end
       end
 
@@ -40,6 +43,11 @@ module OnlineMigrations
             end
           end
         end
+
+        def try_with_lock(&block)
+          lock = AdvisoryLock.new(name: "online_migrations_schema_scheduler")
+          lock.try_with_lock(&block)
+        end
     end
   end
 end

data/lib/online_migrations/change_column_type_helpers.rb

@@ -118,24 +118,19 @@ module OnlineMigrations
           type_cast_functions[column_name] = type_cast_function if type_cast_function
           tmp_column_name = conversions[column_name]
 
-          if database_version >= 11_00_00
-            if primary_key(table_name) == column_name.to_s && old_col.type == :integer
-              # For PG < 11 and Primary Key conversions, setting a column as the PK
-              # converts even check constraints to NOT NULL column constraints
-              # and forces an inline re-verification of the whole table.
-              # To avoid this, we instead set it to `NOT NULL DEFAULT 0` and we'll
-              # copy the correct values when backfilling.
-              add_column(table_name, tmp_column_name, new_type,
-                **old_col_options, **column_options, default: old_col.default || 0, null: false)
-            else
-              if !old_col.default.nil?
-                old_col_options = old_col_options.merge(default: old_col.default, null: old_col.null)
-              end
-              add_column(table_name, tmp_column_name, new_type, **old_col_options, **column_options)
-            end
+          if primary_key(table_name) == column_name.to_s && old_col.type == :integer
+            # For PG < 11 and Primary Key conversions, setting a column as the PK
+            # converts even check constraints to NOT NULL column constraints
+            # and forces an inline re-verification of the whole table.
+            # To avoid this, we instead set it to `NOT NULL DEFAULT 0` and we'll
+            # copy the correct values when backfilling.
+            add_column(table_name, tmp_column_name, new_type,
+              **old_col_options, **column_options, default: old_col.default || 0, null: false)
           else
+            if !old_col.default.nil?
+              old_col_options = old_col_options.merge(default: old_col.default, null: old_col.null)
+            end
             add_column(table_name, tmp_column_name, new_type, **old_col_options, **column_options)
-            change_column_default(table_name, tmp_column_name, old_col.default) if !old_col.default.nil?
           end
         end
 
@@ -264,7 +259,7 @@ module OnlineMigrations
 
           # At this point we are sure there are no NULLs in this column
           transaction do
-            __set_not_null(table_name, tmp_column_name)
+            change_column_null(table_name, tmp_column_name, false)
             remove_not_null_constraint(table_name, tmp_column_name)
           end
         end
@@ -494,29 +489,6 @@ module OnlineMigrations
         end
       end
 
-      def __set_not_null(table_name, column_name)
-        # For PG >= 12 we can "promote" CHECK constraint to NOT NULL constraint:
-        # https://github.com/postgres/postgres/commit/bbb96c3704c041d139181c6601e5bc770e045d26
-        if database_version >= 12_00_00
-          execute(<<~SQL)
-            ALTER TABLE #{quote_table_name(table_name)}
-            ALTER #{quote_column_name(column_name)}
-            SET NOT NULL
-          SQL
-        else
-          # For older versions we can set attribute as NOT NULL directly
-          # through PG internal tables.
-          # In-depth analysis of implications of this was made, so this approach
-          # is considered safe - https://habr.com/ru/company/haulmont/blog/493954/  (in russian).
-          execute(<<~SQL)
-            UPDATE pg_catalog.pg_attribute
-            SET attnotnull = true
-            WHERE attrelid = #{quote(table_name)}::regclass
-              AND attname = #{quote(column_name)}
-          SQL
-        end
-      end
-
       def __rename_constraint(table_name, old_name, new_name)
         execute(<<~SQL)
           ALTER TABLE #{quote_table_name(table_name)}

data/lib/online_migrations/command_checker.rb

@@ -59,7 +59,6 @@ module OnlineMigrations
         short_primary_key_type: "using-primary-key-with-short-integer-type",
         drop_table_multiple_foreign_keys: "removing-a-table-with-multiple-foreign-keys",
         rename_table: "renaming-a-table",
-        add_column_with_default_null: "adding-a-column-with-a-default-value",
         add_column_with_default: "adding-a-column-with-a-default-value",
         add_column_generated_stored: "adding-a-stored-generated-column",
         add_column_json: "adding-a-json-column",
@@ -69,7 +68,6 @@ module OnlineMigrations
         change_column_null: "setting-not-null-on-an-existing-column",
         remove_column: "removing-a-column",
         add_timestamps_with_default: "adding-a-column-with-a-default-value",
-        add_hash_index: "hash-indexes",
         add_reference: "adding-a-reference",
         add_index: "adding-an-index-non-concurrently",
         replace_index: "replacing-an-index",
@@ -89,8 +87,8 @@ module OnlineMigrations
         adapter = connection.adapter_name
         case adapter
         when /postg/i
-          if postgresql_version < Gem::Version.new("9.6")
-            raise "#{adapter} < 9.6 is not supported"
+          if postgresql_version < Gem::Version.new("12")
+            raise "#{adapter} < 12 is not supported"
           end
         else
           raise "#{adapter} is not supported"
@@ -101,9 +99,12 @@ module OnlineMigrations
 
       def set_statement_timeout
         if !defined?(@statement_timeout_set)
-          if (statement_timeout = OnlineMigrations.config.statement_timeout)
-            # TODO: inline this method call after deprecated `disable_statement_timeout` method removal.
-            connection.__set_statement_timeout(statement_timeout)
+          if (timeout = OnlineMigrations.config.statement_timeout)
+            # use ceil to prevent no timeout for values under 1 ms
+            timeout = (timeout * 1000).ceil if !timeout.is_a?(String)
+
+            # Can't use `execute`, because command checker marks it as a dangerous operation.
+            connection.select_value("SET statement_timeout TO #{connection.quote(timeout)}")
           end
           @statement_timeout_set = true
         end
@@ -181,11 +182,7 @@ module OnlineMigrations
         # But I think this check is enough for now.
         raise_error :short_primary_key_type if short_primary_key_type?(options)
 
-        if block
-          collect_foreign_keys(&block)
-          check_for_hash_indexes(&block) if postgresql_version < Gem::Version.new("10")
-        end
-
+        collect_foreign_keys(&block) if block
         @new_tables << table_name.to_s
       end
 
@@ -230,18 +227,11 @@ module OnlineMigrations
         @new_columns << [table_name.to_s, column_name.to_s]
 
         if !new_or_small_table?(table_name)
-          if options.key?(:default) &&
-             (postgresql_version < Gem::Version.new("11") || (!default.nil? && (volatile_default = Utils.volatile_default?(connection, type, default))))
-
-            if default.nil?
-              raise_error :add_column_with_default_null,
-                code: command_str(:add_column, table_name, column_name, type, options.except(:default))
-            else
-              raise_error :add_column_with_default,
-                code: command_str(:add_column_with_default, table_name, column_name, type, options),
-                not_null: options[:null] == false,
-                volatile_default: volatile_default
-            end
+          if options.key?(:default) && !default.nil? && (volatile_default = Utils.volatile_default?(connection, type, default))
+            raise_error :add_column_with_default,
+              code: command_str(:add_column_with_default, table_name, column_name, type, options),
+              not_null: options[:null] == false,
+              volatile_default: volatile_default
           end
 
           if type == :virtual && options[:stored]
@@ -280,10 +270,7 @@ module OnlineMigrations
             table_name: table_name,
             column_name: column_name,
             new_column: new_column,
-            model: table_name.to_s.classify,
-            partial_writes: Utils.ar_partial_writes?,
-            partial_writes_setting: Utils.ar_partial_writes_setting,
-            enumerate_columns_in_select_statements: Utils.ar_enumerate_columns_in_select_statements
+            model: table_name.to_s.classify
         end
       end
 
@@ -360,9 +347,7 @@ module OnlineMigrations
 
               [:datetime, :timestamp, :timestamptz].include?(existing_type) &&
               precision >= existing_precision &&
-              (type == existing_type ||
-                (postgresql_version >= Gem::Version.new("12") &&
-                connection.select_value("SHOW timezone") == "UTC"))
+              (type == existing_type || connection.select_value("SHOW timezone") == "UTC")
             when :interval
               precision = options[:precision] || options[:limit] || 6
               existing_precision = existing_column.precision || existing_column.limit || 6
@@ -394,22 +379,18 @@ module OnlineMigrations
       end
 
       def change_column_default(table_name, column_name, _default_or_changes)
-        if Utils.ar_partial_writes? && !new_column?(table_name, column_name)
-          raise_error :change_column_default,
-            config: Utils.ar_partial_writes_setting
+        if ActiveRecord::Base.partial_inserts && !new_column?(table_name, column_name)
+          raise_error :change_column_default
         end
       end
 
       def change_column_null(table_name, column_name, allow_null, default = nil, **)
         if !allow_null && !new_or_small_table?(table_name)
-          safe = false
           # In PostgreSQL 12+ you can add a check constraint to the table
           # and then "promote" it to NOT NULL for the column.
-          if postgresql_version >= Gem::Version.new("12")
-            safe = check_constraints(table_name).any? do |c|
-              c["def"] == "CHECK ((#{column_name} IS NOT NULL))" ||
-                c["def"] == "CHECK ((#{connection.quote_column_name(column_name)} IS NOT NULL))"
-            end
+          safe = check_constraints(table_name).any? do |c|
+            c["def"] == "CHECK ((#{column_name} IS NOT NULL))" ||
+              c["def"] == "CHECK ((#{connection.quote_column_name(column_name)} IS NOT NULL))"
           end
 
           if !safe
@@ -417,17 +398,13 @@ module OnlineMigrations
             vars = {
               add_constraint_code: command_str(:add_not_null_constraint, table_name, column_name, name: constraint_name, validate: false),
               validate_constraint_code: command_str(:validate_not_null_constraint, table_name, column_name, name: constraint_name),
-              remove_constraint_code: nil,
               table_name: table_name,
               column_name: column_name,
               default: default,
+              remove_constraint_code: command_str(:remove_check_constraint, table_name, name: constraint_name),
+              change_column_null_code: command_str(:change_column_null, table_name, column_name, false),
             }
 
-            if postgresql_version >= Gem::Version.new("12")
-              vars[:remove_constraint_code] = command_str(:remove_check_constraint, table_name, name: constraint_name)
-              vars[:change_column_null_code] = command_str(:change_column_null, table_name, column_name, false)
-            end
-
             raise_error :change_column_null, **vars
           end
         end
@@ -470,15 +447,13 @@ module OnlineMigrations
         @new_columns << [table_name.to_s, "created_at"]
         @new_columns << [table_name.to_s, "updated_at"]
 
-        volatile_default = false
         if !new_or_small_table?(table_name) && !options[:default].nil? &&
-           (postgresql_version < Gem::Version.new("11") || (volatile_default = Utils.volatile_default?(connection, :datetime, options[:default])))
+           Utils.volatile_default?(connection, :datetime, options[:default])
 
           raise_error :add_timestamps_with_default,
             code: [command_str(:add_column_with_default, table_name, :created_at, :datetime, options),
                    command_str(:add_column_with_default, table_name, :updated_at, :datetime, options)].join("\n    "),
-            not_null: options[:null] == false,
-            volatile_default: volatile_default
+            not_null: options[:null] == false
         end
       end
 
@@ -486,10 +461,6 @@ module OnlineMigrations
         # Always added by default in 5.0+
         index = options.fetch(:index, true)
 
-        if index.is_a?(Hash) && index[:using].to_s == "hash" && postgresql_version < Gem::Version.new("10")
-          raise_error :add_hash_index
-        end
-
         concurrently_set = index.is_a?(Hash) && index[:algorithm] == :concurrently
         bad_index = index && !concurrently_set
 
@@ -522,13 +493,6 @@ module OnlineMigrations
       alias add_belongs_to add_reference
 
       def add_reference_concurrently(table_name, ref_name, **options)
-        # Always added by default in 5.0+
-        index = options.fetch(:index, true)
-
-        if index.is_a?(Hash) && index[:using].to_s == "hash" && postgresql_version < Gem::Version.new("10")
-          raise_error :add_hash_index
-        end
-
         foreign_key = options.fetch(:foreign_key, false)
 
         if foreign_key
@@ -546,10 +510,6 @@ module OnlineMigrations
       end
 
       def add_index(table_name, column_name, **options)
-        if options[:using].to_s == "hash" && postgresql_version < Gem::Version.new("10")
-          raise_error :add_hash_index
-        end
-
         if !new_or_small_table?(table_name)
           if options[:algorithm] != :concurrently
             raise_error :add_index,
@@ -702,19 +662,6 @@ module OnlineMigrations
         @foreign_key_tables |= collector.referenced_tables
       end
 
-      def check_for_hash_indexes(&block)
-        indexes = collect_indexes(&block)
-        if indexes.any? { |index| index.using == "hash" }
-          raise_error :add_hash_index
-        end
-      end
-
-      def collect_indexes(&block)
-        collector = IndexesCollector.new
-        collector.collect(&block)
-        collector.indexes
-      end
-
       def new_or_small_table?(table_name)
         new_table?(table_name) || small_table?(table_name)
       end
@@ -736,7 +683,7 @@ module OnlineMigrations
           if Utils.developer_env? && (target_version = OnlineMigrations.config.target_version)
             target_version.to_s
           else
-            database_version = connection.select_value("SHOW server_version_num").to_i
+            database_version = connection.database_version
             major = database_version / 10000
             if database_version >= 100000
               minor = database_version % 10000

data/lib/online_migrations/error_messages.rb

@@ -128,12 +128,12 @@ migration_helpers provides a safer approach to do this:
       <%= column_name.to_s.inspect %> => <%= new_column.to_s.inspect %>
     }
   }
-<% unless partial_writes %>
+<% unless ActiveRecord::Base.partial_inserts %>
 
   NOTE: You also need to temporarily enable partial writes (is disabled by default in Active Record >= 7)
   until the process of column rename is fully done.
   # config/application.rb
-  config.active_record.<%= partial_writes_setting %> = true
+  config.active_record.partial_inserts = true
 <% end %>
 
 2. Deploy
@@ -148,7 +148,7 @@ It will use a combination of a VIEW and column aliasing to work with both column
   end
 
 4. Replace usages of the old column with a new column in the codebase
-<% if enumerate_columns_in_select_statements %>
+<% if ActiveRecord::Base.enumerate_columns_in_select_statements %>
 5. Ignore old column
 
   self.ignored_columns += [:<%= column_name %>]
@@ -247,7 +247,7 @@ during writes works automatically). For most column type changes, this does not
 to be inserted when changing the default value of a column.
 Disable partial writes in config/application.rb:
 
-config.active_record.<%= config %> = false",
+config.active_record.partial_inserts = false",
 
       change_column_null:
 "Setting NOT NULL on an existing column blocks reads and writes while every row is checked.
@@ -317,7 +317,7 @@ A safer approach is to:
 <% end %>",
 
       add_timestamps_with_default:
-"Adding timestamps columns with non-null defaults blocks reads and writes while the entire table is rewritten.
+"Adding timestamp columns with volatile defaults blocks reads and writes while the entire table is rewritten.
 
 A safer approach is to, for both timestamps columns:
 1. add the column without a default value
@@ -327,7 +327,6 @@ A safer approach is to, for both timestamps columns:
 4. add the NOT NULL constraint
 <% end %>
 
-<% unless volatile_default %>
 add_column_with_default takes care of all this steps:
 
 class <%= migration_name %> < <%= migration_parent %>
@@ -336,8 +335,7 @@ class <%= migration_name %> < <%= migration_parent %>
   def change
     <%= code %>
   end
-end
-<% end %>",
+end",
 
       add_reference:
 "<% if bad_foreign_key %>
@@ -356,13 +354,6 @@ class <%= migration_name %> < <%= migration_parent %>
   end
 end",
 
-      add_hash_index:
-"Hash index operations are not WAL-logged, so hash indexes might need to be rebuilt with REINDEX
-after a database crash if there were unwritten changes. Also, changes to hash indexes are not replicated
-over streaming or file-based replication after the initial base backup, so they give wrong answers
-to queries that subsequently use them. For these reasons, hash index use is discouraged.
-Use B-tree indexes instead.",
-
       add_index:
 "Adding an index non-concurrently blocks writes. Instead, use:
 

data/lib/online_migrations/schema_statements.rb

@@ -12,7 +12,7 @@ module OnlineMigrations
     # @param column_name [String, Symbol]
     # @param value value for the column. It is typically a literal. To perform a computed
     #     update, an Arel literal can be used instead
-    # @option options [Integer] :batch_size (1000) size of the batch
+    # @option options [Integer] :batch_size (1_000) size of the batch
     # @option options [String, Symbol] :batch_column_name (primary key) option is for tables without primary key, in this
     #     case another unique integer column can be used. Example: `:user_id`
     # @option options [Proc, Boolean] :progress (false) whether to show progress while running.
@@ -439,9 +439,7 @@ module OnlineMigrations
     def add_column_with_default(table_name, column_name, type, **options)
       default = options.fetch(:default)
 
-      if database_version >= 11_00_00 && !Utils.volatile_default?(self, type, default)
-        add_column(table_name, column_name, type, **options)
-      else
+      if Utils.volatile_default?(self, type, default)
         __ensure_not_in_transaction!
 
         batch_options = options.extract!(:batch_size, :batch_column_name, :progress, :pause_ms)
@@ -465,12 +463,12 @@ module OnlineMigrations
           add_not_null_constraint(table_name, column_name, validate: false)
           validate_not_null_constraint(table_name, column_name)
 
-          if database_version >= 12_00_00
-            # In PostgreSQL 12+ it is safe to "promote" a CHECK constraint to `NOT NULL` for the column
-            change_column_null(table_name, column_name, false)
-            remove_not_null_constraint(table_name, column_name)
-          end
+          # In PostgreSQL 12+ it is safe to "promote" a CHECK constraint to `NOT NULL` for the column
+          change_column_null(table_name, column_name, false)
+          remove_not_null_constraint(table_name, column_name)
         end
+      else
+        add_column(table_name, column_name, type, **options)
       end
     end
 
@@ -729,23 +727,10 @@ module OnlineMigrations
         end
       end
 
-      if OnlineMigrations.config.statement_timeout
-        # "CREATE INDEX CONCURRENTLY" requires a "SHARE UPDATE EXCLUSIVE" lock.
-        # It only conflicts with constraint validations, creating/removing indexes,
-        # and some other "ALTER TABLE"s.
-        super
-      else
-        OnlineMigrations.deprecator.warn(<<~MSG)
-          Running `add_index` without a statement timeout is deprecated.
-          Configure an explicit statement timeout in the initializer file via `config.statement_timeout`
-          or the default database statement timeout will be used.
-          Example, `config.statement_timeout = 1.hour`.
-        MSG
-
-        disable_statement_timeout do
-          super
-        end
-      end
+      # "CREATE INDEX CONCURRENTLY" requires a "SHARE UPDATE EXCLUSIVE" lock.
+      # It only conflicts with constraint validations, creating/removing indexes,
+      # and some other "ALTER TABLE"s.
+      super
     end
 
     # Extends default method to be idempotent.
@@ -770,23 +755,10 @@ module OnlineMigrations
         end
 
       if index_exists
-        if OnlineMigrations.config.statement_timeout
-          # "DROP INDEX CONCURRENTLY" requires a "SHARE UPDATE EXCLUSIVE" lock.
-          # It only conflicts with constraint validations, other creating/removing indexes,
-          # and some "ALTER TABLE"s.
-          super
-        else
-          OnlineMigrations.deprecator.warn(<<~MSG)
-            Running `remove_index` without a statement timeout is deprecated.
-            Configure an explicit statement timeout in the initializer file via `config.statement_timeout`
-            or the default database statement timeout will be used.
-            Example, `config.statement_timeout = 1.hour`.
-          MSG
-
-          disable_statement_timeout do
-            super
-          end
-        end
+        # "DROP INDEX CONCURRENTLY" requires a "SHARE UPDATE EXCLUSIVE" lock.
+        # It only conflicts with constraint validations, other creating/removing indexes,
+        # and some "ALTER TABLE"s.
+        super
       else
         Utils.say("Index was not removed because it does not exist.")
       end
@@ -835,23 +807,10 @@ module OnlineMigrations
       # Skip costly operation if already validated.
       return if foreign_key.validated?
 
-      if OnlineMigrations.config.statement_timeout
-        # "VALIDATE CONSTRAINT" requires a "SHARE UPDATE EXCLUSIVE" lock.
-        # It only conflicts with other validations, creating/removing indexes,
-        # and some other "ALTER TABLE"s.
-        super
-      else
-        OnlineMigrations.deprecator.warn(<<~MSG)
-          Running `validate_foreign_key` without a statement timeout is deprecated.
-          Configure an explicit statement timeout in the initializer file via `config.statement_timeout`
-          or the default database statement timeout will be used.
-          Example, `config.statement_timeout = 1.hour`.
-        MSG
-
-        disable_statement_timeout do
-          super
-        end
-      end
+      # "VALIDATE CONSTRAINT" requires a "SHARE UPDATE EXCLUSIVE" lock.
+      # It only conflicts with other validations, creating/removing indexes,
+      # and some other "ALTER TABLE"s.
+      super
     end
 
     # Extends default method to be idempotent.
@@ -894,23 +853,10 @@ module OnlineMigrations
       # Skip costly operation if already validated.
       return if check_constraint.validated?
 
-      if OnlineMigrations.config.statement_timeout
-        # "VALIDATE CONSTRAINT" requires a "SHARE UPDATE EXCLUSIVE" lock.
-        # It only conflicts with other validations, creating/removing indexes,
-        # and some other "ALTER TABLE"s.
-        super
-      else
-        OnlineMigrations.deprecator.warn(<<~MSG)
-          Running `validate_check_constraint` without a statement timeout is deprecated.
-          Configure an explicit statement timeout in the initializer file via `config.statement_timeout`
-          or the default database statement timeout will be used.
-          Example, `config.statement_timeout = 1.hour`.
-        MSG
-
-        disable_statement_timeout do
-          super
-        end
-      end
+      # "VALIDATE CONSTRAINT" requires a "SHARE UPDATE EXCLUSIVE" lock.
+      # It only conflicts with other validations, creating/removing indexes,
+      # and some other "ALTER TABLE"s.
+      super
     end
 
     # Extends default method to be idempotent
@@ -965,28 +911,6 @@ module OnlineMigrations
       end
     end
 
-    # @private
-    def disable_statement_timeout
-      OnlineMigrations.deprecator.warn(<<~MSG)
-        `disable_statement_timeout` is deprecated and will be removed. Configure an explicit
-        statement timeout in the initializer file via `config.statement_timeout` or the default
-        database statement timeout will be used. Example, `config.statement_timeout = 1.hour`.
-      MSG
-
-      prev_value = select_value("SHOW statement_timeout")
-      __set_statement_timeout(0)
-      yield
-    ensure
-      __set_statement_timeout(prev_value)
-    end
-
-    # @private
-    def __set_statement_timeout(timeout)
-      # use ceil to prevent no timeout for values under 1 ms
-      timeout = (timeout.to_f * 1000).ceil if !timeout.is_a?(String)
-      execute("SET statement_timeout TO #{quote(timeout)}")
-    end
-
     # @private
     # Executes the block with a retry mechanism that alters the `lock_timeout`
     # and sleep time between attempts.

data/lib/online_migrations/utils.rb

@@ -86,26 +86,6 @@ module OnlineMigrations
         "#{short_name}#{hashed_identifier}"
       end
 
-      def ar_partial_writes?
-        ActiveRecord::Base.public_send(ar_partial_writes_setting)
-      end
-
-      def ar_partial_writes_setting
-        if Utils.ar_version >= 7.0
-          "partial_inserts"
-        else
-          "partial_writes"
-        end
-      end
-
-      def ar_enumerate_columns_in_select_statements
-        if ar_version >= 7
-          ActiveRecord::Base.enumerate_columns_in_select_statements
-        else
-          false
-        end
-      end
-
       # Returns estimated rows count for a table.
       # https://www.citusdata.com/blog/2016/10/12/count-performance/
       def estimated_count(connection, table_name)

data/lib/online_migrations/verbose_sql_logs.rb

@@ -6,7 +6,7 @@ module OnlineMigrations
     class << self
       def enable
         @activerecord_logger_was = ActiveRecord::Base.logger
-        @verbose_query_logs_was = verbose_query_logs
+        @verbose_query_logs_was = ActiveRecord.verbose_query_logs
         return if @activerecord_logger_was.nil?
 
         stdout_logger = ActiveSupport::Logger.new($stdout)
@@ -23,30 +23,13 @@ module OnlineMigrations
           end
 
         ActiveRecord::Base.logger = combined_logger
-        set_verbose_query_logs(false)
+        ActiveRecord.verbose_query_logs = false
       end
 
       def disable
         ActiveRecord::Base.logger = @activerecord_logger_was
-        set_verbose_query_logs(@verbose_query_logs_was)
+        ActiveRecord.verbose_query_logs = @verbose_query_logs_was
       end
-
-      private
-        def verbose_query_logs
-          if Utils.ar_version >= 7.0
-            ActiveRecord.verbose_query_logs
-          else
-            ActiveRecord::Base.verbose_query_logs
-          end
-        end
-
-        def set_verbose_query_logs(value) # rubocop:disable Naming/AccessorMethodName
-          if Utils.ar_version >= 7.0
-            ActiveRecord.verbose_query_logs = value
-          else
-            ActiveRecord::Base.verbose_query_logs = value
-          end
-        end
     end
   end
 end

data/lib/online_migrations/version.rb

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

data/lib/online_migrations.rb

@@ -23,12 +23,12 @@ module OnlineMigrations
 
   extend ActiveSupport::Autoload
 
+  autoload :AdvisoryLock
   autoload :ApplicationRecord
   autoload :BatchIterator
   autoload :VerboseSqlLogs
   autoload :ForeignKeysCollector
   autoload :IndexDefinition
-  autoload :IndexesCollector
   autoload :CommandChecker
   autoload :BackgroundMigration
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.23.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 description:
 email:
 - fatkodima123@gmail.com
@@ -48,6 +48,7 @@ files:
 - lib/generators/online_migrations/templates/migration.rb.tt
 - lib/generators/online_migrations/upgrade_generator.rb
 - lib/online_migrations.rb
+- lib/online_migrations/advisory_lock.rb
 - lib/online_migrations/application_record.rb
 - lib/online_migrations/background_migration.rb
 - lib/online_migrations/background_migrations/backfill_column.rb
@@ -82,7 +83,6 @@ files:
 - lib/online_migrations/error_messages.rb
 - lib/online_migrations/foreign_keys_collector.rb
 - lib/online_migrations/index_definition.rb
-- lib/online_migrations/indexes_collector.rb
 - lib/online_migrations/lock_retrier.rb
 - lib/online_migrations/migration.rb
 - lib/online_migrations/migrator.rb
@@ -107,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/online_migrations/indexes_collector.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module OnlineMigrations
-  # @private
-  class IndexesCollector
-    COLUMN_TYPES = [:bigint, :binary, :boolean, :date, :datetime, :decimal,
-                    :float, :integer, :json, :string, :text, :time, :timestamp, :virtual]
-
-    attr_reader :indexes
-
-    def initialize
-      @indexes = []
-    end
-
-    def collect
-      yield self
-    end
-
-    def index(_column_name, **options)
-      @indexes << IndexDefinition.new(using: options[:using].to_s)
-    end
-
-    def references(*_ref_names, **options)
-      index = options.fetch(:index, true)
-
-      if index
-        using = index.is_a?(Hash) ? index[:using].to_s : nil
-        @indexes << IndexDefinition.new(using: using)
-      end
-    end
-    alias belongs_to references
-
-    def method_missing(method_name, *_args, **options)
-      # Check for type-based methods, where we can also specify an index:
-      # t.string :email, index: true
-      if COLUMN_TYPES.include?(method_name)
-        index = options.fetch(:index, false)
-
-        if index
-          using = index.is_a?(Hash) ? index[:using].to_s : nil
-          @indexes << IndexDefinition.new(using: using)
-        end
-      end
-    end
-  end
-end