pg_ha_migrations 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e104b78dae3bcbec72dc3f81c403d4c70935e43f67ef43d5363fe39de4e4139f
-  data.tar.gz: fe17e6f106fff9507d9ad62e2a6953d33aad1335005bd43c4b6ed2a7d6d1271d
+  metadata.gz: b7db2dcf4e9c5703c49b53e785ec06df44f3dc94fa190c81fe30e2426ed588d9
+  data.tar.gz: 6b763dbe8f8126bf26c2682ab69e50ea54df505ba099bf0f981e11a5831dee11
 SHA512:
-  metadata.gz: a2b274232130fec7807eced8199dc19fa6c0e9eda29990ffe86815e942d1967ed5105c420bad89c7811a3223fcbedf372bdb6bccb292d27f274674e5e1df879d
-  data.tar.gz: 5bbc97af919639056e152186dc5eebfd90ee19fe445732d064774cdf132dd303bed41afae80ab9f39d88a392d5c1edede948db87189d4f59c87f0fe9a2861071
+  metadata.gz: a92e9ba724c5d8faf39b0314430ea4848e2081926c1f02902e4bffb947cde09ccc2de1c4db74b5cb54ee3fb6b8db3072b88dab2ed10432965fbd612ec3d0c0c2
+  data.tar.gz: 5bf9858b2f1dc84936dae0128f4ddc43f7ae4961ae2564c5b23afdb9f9f8dbad1b9abe527aabe48bd0afca74e6f8d3a457a412f89ab54ef210dcceeaf5ba60ef

data/README.md

@@ -304,6 +304,25 @@ Safely validate (without acquiring an exclusive lock) existing rows for a newly
 safe_validate_check_constraint :table, name: :constraint_table_on_column_like_example
 ```
 
+#### safe\_add\_foreign\_key
+
+Safely add a foreign key constraint. The constraint is first added as `NOT VALID` (to avoid blocking writes while the table is scanned) and then validated in a separate step that allows concurrent reads and writes.
+
+```ruby
+safe_add_foreign_key :orders, :customers
+```
+
+With custom options:
+
+```ruby
+safe_add_foreign_key :orders, :customers,
+  column: :buyer_id,
+  name: :fk_orders_buyer,
+  on_delete: :cascade
+```
+
+> **Note:** This method runs multiple DDL statements non-transactionally. The validation step performs a full table scan to verify existing rows satisfy the constraint. While no exclusive lock is held during validation, the scan may take a long time on large tables.
+
 #### safe\_rename\_constraint
 
 Safely rename any (not just `CHECK`) constraint.

data/lib/pg_ha_migrations/safe_statements.rb

@@ -270,7 +270,21 @@ module PgHaMigrations::SafeStatements
     unless ActiveRecord::Base.connection.postgresql_version >= 9_06_00
       raise PgHaMigrations::InvalidMigrationError, "Removing an index concurrently is not supported on Postgres 9.1 databases"
     end
-    index_size = select_value("SELECT pg_size_pretty(pg_relation_size('#{options[:name]}'))")
+
+    index_exists = select_value(
+      "SELECT EXISTS(SELECT 1 FROM pg_class WHERE relname = #{connection.quote(options[:name].to_s)} AND relkind = 'i')"
+    )
+
+    unless index_exists
+      if options[:if_exists]
+        say "Index #{options[:name]} does not exist, skipping removal"
+        return
+      else
+        raise ArgumentError, "Index #{options[:name]} does not exist"
+      end
+    end
+
+    index_size = select_value("SELECT pg_size_pretty(pg_relation_size(#{connection.quote(options[:name].to_s)}))")
     say "Preparing to drop index #{options[:name]} which is #{index_size} on disk..."
     unsafe_remove_index(table, **options.merge(:algorithm => :concurrently))
   end
@@ -383,6 +397,17 @@ module PgHaMigrations::SafeStatements
     end
   end
 
+  def safe_add_foreign_key(from_table, to_table, **options)
+    # Rails convention for determining the foreign key column
+    column = options.fetch(:column) { "#{to_table.to_s.singularize}_id" }
+
+    # Rails convention for generating FK name: fk_rails_<10 char hash of column>
+    fk_name = options.fetch(:name) { "fk_rails_#{OpenSSL::Digest::SHA256.hexdigest(column.to_s).first(10)}" }
+
+    unsafe_add_foreign_key(from_table, to_table, validate: false, **options.merge(name: fk_name))
+    safe_validate_check_constraint(from_table, name: fk_name)
+  end
+
   def safe_rename_constraint(table, from:, to:)
     raise ArgumentError, "Expected <from> to be present" unless from.present?
     raise ArgumentError, "Expected <to> to be present" unless to.present?
@@ -683,13 +708,15 @@ module PgHaMigrations::SafeStatements
 
   def adjust_lock_timeout(timeout_seconds = PgHaMigrations::LOCK_TIMEOUT_SECONDS, &block)
     _check_postgres_adapter!
-    original_timeout = ActiveRecord::Base.value_from_sql("SHOW lock_timeout").sub(/s\Z/, '').to_i * 1000
+    original_timeout_ms = ActiveRecord::Base.value_from_sql(
+      "SELECT setting::integer FROM pg_settings WHERE name = 'lock_timeout'"
+    )
     begin
       connection.execute("SET lock_timeout = #{PG::Connection.escape_string((timeout_seconds * 1000).to_s)};")
       block.call
     ensure
       begin
-        connection.execute("SET lock_timeout = #{original_timeout};")
+        connection.execute("SET lock_timeout = #{original_timeout_ms};")
       rescue ActiveRecord::StatementInvalid => e
         if e.message =~ /PG::InFailedSqlTransaction/
           # If we're in a failed transaction the `SET lock_timeout` will be rolled back,
@@ -703,16 +730,18 @@ module PgHaMigrations::SafeStatements
 
   def adjust_statement_timeout(timeout_seconds, &block)
     _check_postgres_adapter!
-    original_timeout = ActiveRecord::Base.value_from_sql("SHOW statement_timeout").sub(/s\Z/, '').to_i * 1000
+    original_timeout_ms = ActiveRecord::Base.value_from_sql(
+      "SELECT setting::integer FROM pg_settings WHERE name = 'statement_timeout'"
+    )
     begin
       connection.execute("SET statement_timeout = #{PG::Connection.escape_string((timeout_seconds * 1000).to_s)};")
       block.call
     ensure
       begin
-        connection.execute("SET statement_timeout = #{original_timeout};")
+        connection.execute("SET statement_timeout = #{original_timeout_ms};")
       rescue ActiveRecord::StatementInvalid => e
         if e.message =~ /PG::InFailedSqlTransaction/
-          # If we're in a failed transaction the `SET lock_timeout` will be rolled back,
+          # If we're in a failed transaction the `SET statement_timeout` will be rolled back,
           # so we don't need to worry about cleaning up, and we can't execute SQL anyway.
         else
           raise e

data/lib/pg_ha_migrations/unsafe_statements.rb

@@ -77,7 +77,7 @@ module PgHaMigrations::UnsafeStatements
   # Otherwise, direct dispatch to underlying Rails method without dependent object check / locking
   disable_or_delegate_default_method :add_check_constraint, ":add_check_constraint is NOT SAFE! Use :safe_add_unvalidated_check_constraint and then :safe_validate_check_constraint instead"
   disable_or_delegate_default_method :add_column, ":add_column is NOT SAFE! Use safe_add_column instead"
-  disable_or_delegate_default_method :add_foreign_key, ":add_foreign_key is NOT SAFE! Explicitly call :unsafe_add_foreign_key"
+  disable_or_delegate_default_method :add_foreign_key, ":add_foreign_key is NOT SAFE! Use safe_add_foreign_key instead"
   disable_or_delegate_default_method :add_index, ":add_index is NOT SAFE! Use safe_add_concurrent_index instead"
   disable_or_delegate_default_method :change_column, ":change_column is NOT SAFE! Use a combination of safe and explicit unsafe migration methods instead"
   disable_or_delegate_default_method :change_column_default, ":change_column_default is NOT SAFE! Use safe_change_column_default instead"

data/lib/pg_ha_migrations/version.rb

@@ -1,3 +1,3 @@
 module PgHaMigrations
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_ha_migrations
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - celeen
@@ -13,7 +13,7 @@ authors:
 - redneckbeard
 bindir: exe
 cert_chain: []
-date: 2025-11-18 00:00:00.000000000 Z
+date: 2026-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake