pg_online_schema_change 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01d9f8568b13763a56446a47e4d1c9f8d04b4d29cfd5eec3f6bdafd4355ce163
-  data.tar.gz: c14d2ce856b0023484864559a8d39de9f05510b7123125df12028be5d4a280ea
+  metadata.gz: b4b544005274743fc18f3147204997861e3ac55e7c619a6859849049eff42324
+  data.tar.gz: a4123844149ed79c7e8781588ca055f49954afa245a7a63c50886e076be9562e
 SHA512:
-  metadata.gz: bcf50ee7f529ce49c922ad5ff514233992ef5b3dcbe58fea8766efcb5ee0cce24798448e5d825a9b24a5f97a8e8864cd423dbb81898ebf3ab165a8e905745c58
-  data.tar.gz: 045a92a13bebe1e4ebdc8a09411b5c7536f12df800a1a66f4ad4709fdb1ec31a57ef98db136643042d87bda13945d46a52c228b3e9650e3a0a63efb4f2e1c186
+  metadata.gz: d5b08b1f26c9d3f3c19d819cf65d0787bbbd6221845ce44bcf2aaf13a0389f8824139d3034507cb8118751b2e09713ec4116322e8b86b8988276d6ab8f4a2390
+  data.tar.gz: e5e589f58797e28fbe15fd355367a61c2673f6d90ccadb67c9b43427ea0a5b86afba9da4ec5199dd4656397f4c7a5e8b27a3805876915d7eddb8366a19892a4b

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.9.4] - 2023-09-17
+
+- Resolving gem push and sync glitch in 0.9.3
+
+## [0.9.3] - 2023-09-17
+
+- Dependency updates
+- Adding support for showing the gem version with -v or --version by @brycethornton #101
+- Fix for INSERT's failing for long table names by @ahilmer #116
+- Get view definition of a view from dedicated schema by @shayonj #117
+
 ## [0.9.2] - 2023-07-03
 
 - Dependency updates

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pg_online_schema_change (0.9.4)
+    pg_online_schema_change (0.9.5)
       ougai (~> 2.0.0)
       pg (>= 1.3.2, < 1.6.0)
       pg_query (>= 2.1.3, < 4.3.0)
@@ -14,8 +14,8 @@ GEM
     base64 (0.1.1)
     coderay (1.1.3)
     diff-lcs (1.5.0)
-    google-protobuf (3.24.3-arm64-darwin)
-    google-protobuf (3.24.3-x86_64-linux)
+    google-protobuf (3.24.4-arm64-darwin)
+    google-protobuf (3.24.4-x86_64-linux)
     haml (6.1.1)
       temple (>= 0.8.2)
       thor
@@ -56,7 +56,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.56.3)
+    rubocop (1.56.4)
       base64 (~> 0.1.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -76,7 +76,7 @@ GEM
       rubocop (~> 1.33)
     rubocop-packaging (0.5.2)
       rubocop (>= 1.33, < 2.0)
-    rubocop-performance (1.19.0)
+    rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
@@ -86,7 +86,7 @@ GEM
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
-    syntax_tree (6.1.1)
+    syntax_tree (6.2.0)
       prettier_print (>= 1.2.0)
     syntax_tree-haml (4.0.3)
       haml (>= 5.2)
@@ -99,7 +99,7 @@ GEM
     temple (0.10.0)
     thor (1.2.2)
     tilt (2.1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   arm64-darwin-20

data/README.md

@@ -11,8 +11,6 @@ pg-online-schema-change (`pg-osc`) is a tool for making schema changes (any `ALT
 
 `pg-osc` is inspired by the design and workings of tools like `pg_repack` and `pt-online-schema-change` (MySQL). Read more below on [how does it work](#how-does-it-work), [prominent features](#prominent-features), the [caveats](#caveats) and [examples](#examples)
 
-⚠️ Proceed with caution when using this on production like workloads. Best to try on similar setup or staging like environment first. Read on below for some examples and caveats.
-
 ## Table of Contents
 
 - [Installation](#installation)
@@ -70,28 +68,29 @@ https://hub.docker.com/r/shayonj/pg-osc
 pg-online-schema-change help perform
 
 Usage:
-  pg-online-schema-change perform -a, --alter-statement=ALTER_STATEMENT -d, --dbname=DBNAME -h, --host=HOST -p, --port=N -s, --schema=SCHEMA -u, --username=USERNAME -w, --password=PASSWORD
+  pg-online-schema-change perform -a, --alter-statement=ALTER_STATEMENT -d, --dbname=DBNAME -h, --host=HOST -p, --port=N -s, --schema=SCHEMA -u, --username=USERNAME
 
 Options:
-  -a, --alter-statement=ALTER_STATEMENT        # The ALTER statement to perform the schema change
-  -s, --schema=SCHEMA                          # The schema in which the table is
-                                               # Default: public
-  -d, --dbname=DBNAME                          # Name of the database
-  -h, --host=HOST                              # Server host where the Database is located
-  -u, --username=USERNAME                      # Username for the Database
-  -p, --port=N                                 # Port for the Database
-                                               # Default: 5432
-  -w, --password=PASSWORD                      # DEPRECATED: Password for the Database. Please pass PGPASSWORD environment variable instead.
-  -v, [--verbose], [--no-verbose]              # Emit logs in debug mode
-  -f, [--drop], [--no-drop]                    # Drop the original table in the end after the swap
-  -k, [--kill-backends], [--no-kill-backends]  # Kill other competing queries/backends when trying to acquire lock for the shadow table creation and swap. It will wait for --wait-time-for-lock duration before killing backends and try upto 3 times.
-  -w, [--wait-time-for-lock=N]                 # Time to wait before killing backends to acquire lock and/or retrying upto 3 times. It will kill backends if --kill-backends is true, otherwise try upto 3 times and exit if it cannot acquire a lock.
-                                               # Default: 10
-  -c, [--copy-statement=COPY_STATEMENT]        # Takes a .sql file location where you can provide a custom query to be played (ex: backfills) when pgosc copies data from the primary to the shadow table. More examples in README.
-  -b, [--pull-batch-count=N]                   # Number of rows to be replayed on each iteration after copy. This can be tuned for faster catch up and swap. Best used with delta-count.
-                                               # Default: 1000
-  -e, [--delta-count=N]                        # Indicates how many rows should be remaining before a swap should be performed. This can be tuned for faster catch up and swap, especially on highly volume tables. Best used with pull-batch-count.
-                                               # Default: 20
+  -a, --alter-statement=ALTER_STATEMENT                                    # The ALTER statement to perform the schema change
+  -s, --schema=SCHEMA                                                      # The schema in which the table is
+                                                                           # Default: public
+  -d, --dbname=DBNAME                                                      # Name of the database
+  -h, --host=HOST                                                          # Server host where the Database is located
+  -u, --username=USERNAME                                                  # Username for the Database
+  -p, --port=N                                                             # Port for the Database
+                                                                           # Default: 5432
+  -w, [--password=PASSWORD]                                                # DEPRECATED: Password for the Database. Please pass PGPASSWORD environment variable instead.
+  -v, [--verbose], [--no-verbose]                                          # Emit logs in debug mode
+  -f, [--drop], [--no-drop]                                                # Drop the original table in the end after the swap
+  -k, [--kill-backends], [--no-kill-backends]                              # Kill other competing queries/backends when trying to acquire lock for the shadow table creation and swap. It will wait for --wait-time-for-lock duration before killing backends and try upto 3 times.
+  -w, [--wait-time-for-lock=N]                                             # Time to wait before killing backends to acquire lock and/or retrying upto 3 times. It will kill backends if --kill-backends is true, otherwise try upto 3 times and exit if it cannot acquire a lock.
+                                                                           # Default: 10
+  -c, [--copy-statement=COPY_STATEMENT]                                    # Takes a .sql file location where you can provide a custom query to be played (ex: backfills) when pgosc copies data from the primary to the shadow table. More examples in README.
+  -b, [--pull-batch-count=N]                                               # Number of rows to be replayed on each iteration after copy. This can be tuned for faster catch up and swap. Best used with delta-count.
+                                                                           # Default: 1000
+  -e, [--delta-count=N]                                                    # Indicates how many rows should be remaining before a swap should be performed. This can be tuned for faster catch up and swap, especially on highly volume tables. Best used with pull-batch-count.
+                                                                           # Default: 20
+  -o, [--skip-foreign-key-validation], [--no-skip-foreign-key-validation]  # Skip foreign key validation after swap. You shouldn't need this unless you have a very specific use case, like manually validating foreign key constraints after swap.
 ```
 
 ```

data/lib/pg_online_schema_change/cli.rb

@@ -89,6 +89,13 @@ module PgOnlineSchemaChange
                   default: DELTA_COUNT,
                   desc:
                     "Indicates how many rows should be remaining before a swap should be performed. This can be tuned for faster catch up and swap, especially on highly volume tables. Best used with pull-batch-count."
+    method_option :skip_foreign_key_validation,
+                  aliases: "-o",
+                  type: :boolean,
+                  required: false,
+                  default: false,
+                  desc:
+                    "Skip foreign key validation after swap. You shouldn't need this unless you have a very specific use case, like manually validating foreign key constraints after swap."
 
     def perform
       client_options = Struct.new(*options.keys.map(&:to_sym)).new(*options.values)

data/lib/pg_online_schema_change/client.rb

@@ -19,7 +19,8 @@ module PgOnlineSchemaChange
                   :wait_time_for_lock,
                   :copy_statement,
                   :pull_batch_count,
-                  :delta_count
+                  :delta_count,
+                  :skip_foreign_key_validation
 
     def initialize(options)
       @alter_statement = options.alter_statement
@@ -34,6 +35,7 @@ module PgOnlineSchemaChange
       @wait_time_for_lock = options.wait_time_for_lock
       @pull_batch_count = options.pull_batch_count
       @delta_count = options.delta_count
+      @skip_foreign_key_validation = options.skip_foreign_key_validation
 
       handle_copy_statement(options.copy_statement)
       handle_validations
@@ -54,7 +56,7 @@ module PgOnlineSchemaChange
 
       return if Query.same_table?(@alter_statement)
 
-      raise Error("All statements should belong to the same table: #{@alter_statement}")
+      raise Error, "All statements should belong to the same table: #{@alter_statement}"
     end
 
     def handle_copy_statement(statement)

data/lib/pg_online_schema_change/orchestrate.rb

@@ -36,7 +36,10 @@ module PgOnlineSchemaChange
         Store.set(:trigger_time_column, "trigger_time_#{pgosc_identifier}")
         Store.set(:audit_table_pk, "at_#{pgosc_identifier}_id")
         Store.set(:shadow_table, "pgosc_st_#{client.table.downcase}_#{pgosc_identifier}")
-        Store.set(:primary_table_storage_parameters, Query.storage_parameters_for(client, client.table_name, true) || "")
+        Store.set(
+          :primary_table_storage_parameters,
+          Query.storage_parameters_for(client, client.table_name, true) || "",
+        )
 
         Store.set(
           :referential_foreign_key_statements,
@@ -109,7 +112,10 @@ module PgOnlineSchemaChange
 
         Query.run(client.connection, sql)
 
-        Store.set(:audit_table_pk_sequence, Query.get_sequence_name(client, audit_table, audit_table_pk))
+        Store.set(
+          :audit_table_pk_sequence,
+          Query.get_sequence_name(client, audit_table, audit_table_pk),
+        )
       end
 
       def setup_trigger!
@@ -270,11 +276,14 @@ module PgOnlineSchemaChange
       end
 
       def validate_constraints!
-        logger.info("Validating constraints!")
-
-        validate_statements = Query.get_foreign_keys_to_validate(client, client.table_name)
+        return if client.skip_foreign_key_validation
 
-        Query.run(client.connection, validate_statements)
+        Query
+          .get_foreign_keys_to_validate(client, client.table_name)
+          .each do |statement|
+            logger.info("Validating constraints!", statement: statement)
+            Query.run(client.connection, statement)
+          end
       end
 
       def replace_views!

data/lib/pg_online_schema_change/query.rb

@@ -140,10 +140,9 @@ module PgOnlineSchemaChange
           SELECT pg_get_serial_sequence('#{table}', '#{column}');
         SQL
 
-        run(client.connection, query) { |result| result.map { |row|
-          row["pg_get_serial_sequence"]
-        }
-        }.first
+        run(client.connection, query) do |result|
+          result.map { |row| row["pg_get_serial_sequence"] }
+        end.first
       end
 
       def get_triggers_for(client, table)
@@ -238,11 +237,9 @@ module PgOnlineSchemaChange
         self_foreign_keys =
           constraints.select { |row| row["table_on"] == table && row["constraint_type"] == "f" }
 
-        [referential_foreign_keys, self_foreign_keys].flatten
-          .map do |row|
-            "ALTER TABLE #{row["table_on"]} VALIDATE CONSTRAINT #{row["constraint_name"]};"
-          end
-          .join
+        [referential_foreign_keys, self_foreign_keys].flatten.map do |row|
+          "ALTER TABLE #{row["table_on"]} VALIDATE CONSTRAINT #{row["constraint_name"]};"
+        end
       end
 
       def dropped_columns(client)
@@ -327,7 +324,7 @@ module PgOnlineSchemaChange
 
         definitions = []
         run(client.connection, query) do |result|
-          definitions = result.map { |row| {row["view_name"] => row["view_definition"].strip} }
+          definitions = result.map { |row| { row["view_name"] => row["view_definition"].strip } }
         end
 
         definitions

data/lib/pg_online_schema_change/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgOnlineSchemaChange
-  VERSION = "0.9.4"
+  VERSION = "0.9.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_online_schema_change
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Shayon Mukherjee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-17 00:00:00.000000000 Z
+date: 2023-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ougai