pg_easy_replicate 0.3.4 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b424ab33e443af6e89404c847e98b8a531a7d88ef94f355db5f71c2990ac1bd
-  data.tar.gz: b03802794dbc2a9feebd6ce5bfcc7681f36a76b7d7963dae52052f6cb67e0092
+  metadata.gz: e7291bb160de0db280d2e11a7b5e46d89bdd6b259ea2acf070ab302a80b27579
+  data.tar.gz: 7b5f1df7f16a833ce6f9fc2bdac7765e0d8835b6b271d029834a06a0f21bd3b7
 SHA512:
-  metadata.gz: 5fd050a7c1850a382ff9811f7184e6cb3fdb07d25f668f99ad59bda2c9e8109f9800229bae5948a9ed7290c10974841dfcb640c6fa7daee2f023e2e77536b4ac
-  data.tar.gz: a80d002b8510045d91b8f5cb3f16df2370aa5e8003877ba4538537b2be13fe6301f45d1383bf84992bcaa62ceb5cb488eb5b73177285ccb36e44d4edf58c3c01
+  metadata.gz: a066f7421b3be12ad1aa28017c9c680652f18477a37390fdaaf58efe2dc31aca28abc40715f15e33afbf628c973c2d8786d6d2818e22ea59e9ee6ca9c74dccd8
+  data.tar.gz: 45b5cfa989e4209ceddacc2582088ff712e45a17d34bfff423c30d3d350635cc894cc0f6c84dc5a68cb96ec4f0280d16cc8a2d4b108296543cde095b752312d6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pg_easy_replicate (0.3.4)
+    pg_easy_replicate (0.3.6)
       ougai (~> 2.0.0)
       pg (~> 1.5.3)
       pg_query (~> 5.1.0)
@@ -25,21 +25,21 @@ GEM
       temple (>= 0.8.2)
       thor
       tilt
-    json (2.7.2)
+    json (2.8.2)
     language_server-protocol (3.17.0.3)
-    method_source (1.0.0)
+    method_source (1.1.0)
     oj (3.14.3)
     ougai (2.0.0)
       oj (~> 3.10)
     parallel (1.26.3)
-    parser (3.3.5.0)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
     pg (1.5.9)
     pg_query (5.1.0)
       google-protobuf (>= 3.22.3)
     prettier_print (1.2.1)
-    pry (0.14.2)
+    pry (0.15.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
     racc (1.8.1)
@@ -72,7 +72,7 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.3)
+    rubocop-ast (1.36.1)
       parser (>= 3.3.1.0)
     rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
@@ -80,7 +80,7 @@ GEM
       rubocop (~> 1.41)
     rubocop-packaging (0.5.2)
       rubocop (>= 1.33, < 2.0)
-    rubocop-performance (1.22.1)
+    rubocop-performance (1.23.0)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)

data/README.md

@@ -191,7 +191,7 @@ $ pg_easy_replicate start_sync --group-name database-cluster-1 [-d <track-ddl>]
 
 ### DDL Changes Management
 
-`pg_easy_replicate` now supports tracking and applying DDL (Data Definition Language) changes between the source and target databases. To track DDLs you can pass `-track-ddl` to `start_sync`.
+`pg_easy_replicate` now supports tracking and applying DDL (Data Definition Language) changes between the source and target databases. To track DDLs you can pass `--track-ddl` to `start_sync`.
 
 This feature ensures that most schema changes made to the source database tables that are being replicated during the replication process are tracked, so that you can apply them at your will before or after switchover.
 
@@ -310,12 +310,12 @@ By default all tables are added for replication but you can create multiple grou
 ```bash
 
 $ pg_easy_replicate bootstrap --group-name database-cluster-1 --copy-schema
-$ pg_easy_replicate start_sync --group-name database-cluster-1 --schema-name public --tables "users, posts, events"
+$ pg_easy_replicate start_sync --group-name database-cluster-1 --schema-name public --tables "users,posts,events"
 
 ...
 
 $ pg_easy_replicate bootstrap --group-name database-cluster-2 --copy-schema
-$ pg_easy_replicate start_sync --group-name database-cluster-2 --schema-name public --tables "comments, views"
+$ pg_easy_replicate start_sync --group-name database-cluster-2 --schema-name public --tables "comments,views"
 
 ...
 $ pg_easy_replicate switchover  --group-name database-cluster-1

data/lib/pg_easy_replicate/cli.rb

@@ -78,6 +78,11 @@ module PgEasyReplicate
                   aliases: "-s",
                   desc:
                     "Cleans up the publication and subscription for the respective group"
+    method_option :restore_connection_on_source_db,
+                  aliases: "-r",
+                  type: :boolean,
+                  default: false,
+                  desc: "Restore connection on source db after switchover"
     def cleanup
       PgEasyReplicate.cleanup(options)
     end
@@ -163,14 +168,34 @@ module PgEasyReplicate
       end
     end
 
-    desc "notify", "Sends a notification with replication status to a specified url"
-    method_option :group_name, aliases: "-g", required: true, desc: "Name of the group previously provisioned"
-    method_option :url, aliases: "-u", required: true, desc: "URL for notification"
-    method_option :frequency, aliases: "-f", type: :numeric, default: 10, desc: "Frequency for sending stats to the endpoint provided"
-    method_option :timeout, aliases: "-t", type: :numeric, default: 10, desc: "Timeout for the notify request"
+    desc "notify",
+         "Sends a notification with replication status to a specified url"
+    method_option :group_name,
+                  aliases: "-g",
+                  required: true,
+                  desc: "Name of the group previously provisioned"
+    method_option :url,
+                  aliases: "-u",
+                  required: true,
+                  desc: "URL for notification"
+    method_option :frequency,
+                  aliases: "-f",
+                  type: :numeric,
+                  default: 10,
+                  desc: "Frequency for sending stats to the endpoint provided"
+    method_option :timeout,
+                  aliases: "-t",
+                  type: :numeric,
+                  default: 10,
+                  desc: "Timeout for the notify request"
 
     def notify
-      PgEasyReplicate::Stats.notify(options[:group_name], options[:url], options[:frequency], options[:timeout])
+      PgEasyReplicate::Stats.notify(
+        options[:group_name],
+        options[:url],
+        options[:frequency],
+        options[:timeout],
+      )
     end
 
     desc "list_ddl_changes", "Lists recent DDL changes in the source database"

data/lib/pg_easy_replicate/group.rb

@@ -20,7 +20,7 @@ module PgEasyReplicate
           column(:updated_at, Time, default: Sequel::CURRENT_TIMESTAMP)
           column(:started_at, Time)
           column(:failed_at, Time)
-          column(:recreate_indices_post_copy, TrueClass, default: true)
+          column(:recreate_indices_post_copy, TrueClass, default: false)
           column(:switchover_completed_at, Time)
         end
       ensure
@@ -44,6 +44,7 @@ module PgEasyReplicate
           schema_name: options[:schema_name],
           started_at: options[:started_at],
           failed_at: options[:failed_at],
+          recreate_indices_post_copy: options[:recreate_indices_post_copy],
         )
       rescue => e
         abort_with("Adding group entry failed: #{e.message}")

data/lib/pg_easy_replicate/helper.rb

@@ -75,7 +75,7 @@ module PgEasyReplicate
 
     def determine_tables(conn_string:, list: "", exclude_list: "", schema: nil)
       schema ||= "public"
-      
+
       tables = convert_to_array(list)
       exclude_tables = convert_to_array(exclude_list)
       validate_table_lists(tables, exclude_tables, schema)
@@ -115,14 +115,25 @@ module PgEasyReplicate
       exclude_table_list = convert_to_array(exclude_tables)
 
       if !table_list.empty? && !exclude_table_list.empty?
-        abort_with("Options --tables(-t) and --exclude-tables(-e) cannot be used together.")
+        abort_with(
+          "Options --tables(-t) and --exclude-tables(-e) cannot be used together.",
+        )
       elsif !table_list.empty?
         if table_list.size > 0 && (schema_name.nil? || schema_name == "")
           abort_with("Schema name is required if tables are passed")
         end
-      elsif exclude_table_list.size > 0 && (schema_name.nil? || schema_name == "")
+      elsif exclude_table_list.size > 0 &&
+            (schema_name.nil? || schema_name == "")
         abort_with("Schema name is required if exclude tables are passed")
       end
     end
+
+    def restore_connections_on_source_db
+      logger.info("Restoring connections")
+
+      alter_sql =
+        "ALTER USER #{quote_ident(db_user(source_db_url))} set default_transaction_read_only = false"
+      Query.run(query: alter_sql, connection_url: source_db_url)
+    end
   end
 end

data/lib/pg_easy_replicate/orchestrate.rb

@@ -60,6 +60,7 @@ module PgEasyReplicate
             schema: schema_name,
           )
         end
+        logger.info("Starting sync completed successfully")
       rescue => e
         stop_sync(group_name: options[:group_name])
         if Group.find(options[:group_name])
@@ -166,6 +167,7 @@ module PgEasyReplicate
         Query.run(
           query: "DROP SUBSCRIPTION IF EXISTS #{subscription_name(group_name)}",
           connection_url: target_conn_string,
+          user: db_user(target_conn_string),
           transaction: false,
         )
       rescue => e
@@ -192,6 +194,7 @@ module PgEasyReplicate
           group_name: group_name,
           target_conn_string: target_conn_string || target_db_url,
         )
+        logger.info("Stopping sync completed successfully")
       rescue => e
         abort_with("Unable to stop sync: #{e.message}")
       end
@@ -236,6 +239,11 @@ module PgEasyReplicate
         revoke_connections_on_source_db(group_name)
         wait_for_remaining_catchup(group_name)
         refresh_sequences(conn_string: target_conn, schema: group[:schema_name])
+
+        drop_subscription(
+          group_name: group_name,
+          target_conn_string: target_conn,
+        )
         mark_switchover_complete(group_name)
 
         unless skip_vacuum_analyze
@@ -245,13 +253,8 @@ module PgEasyReplicate
             schema: group[:schema_name],
           )
         end
-
-        drop_subscription(
-          group_name: group_name,
-          target_conn_string: target_conn,
-        )
       rescue => e
-        restore_connections_on_source_db(group_name)
+        restore_connections_on_source_db
         abort_with("Switchover failed: #{e.message}")
       end
 
@@ -311,14 +314,6 @@ module PgEasyReplicate
         raise "Unable to revoke connections on source db: #{e.message}"
       end
 
-      def restore_connections_on_source_db(group_name)
-        logger.info("Restoring connections")
-
-        alter_sql =
-          "ALTER USER #{quote_ident(db_user(source_db_url))} set default_transaction_read_only = false"
-        Query.run(query: alter_sql, connection_url: source_db_url)
-      end
-
       def refresh_sequences(conn_string:, schema: nil)
         logger.info("Refreshing sequences")
         sql = <<~SQL

data/lib/pg_easy_replicate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgEasyReplicate
-  VERSION = "0.3.4"
+  VERSION = "0.3.6"
 end

data/lib/pg_easy_replicate.rb

@@ -158,6 +158,7 @@ module PgEasyReplicate
 
       logger.info("Setting up groups tables")
       Group.setup
+      logger.info("Bootstrap completed successfully")
     rescue => e
       abort_with("Unable to bootstrap: #{e.message}")
     end
@@ -212,6 +213,11 @@ module PgEasyReplicate
             end
           end
         end,
+        -> do
+          if options[:restore_connection_on_source_db]
+            restore_connections_on_source_db
+          end
+        end,
       ]
 
       cleanup_steps.each do |step|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_easy_replicate
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.6
 platform: ruby
 authors:
 - Shayon Mukherjee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ougai
@@ -274,7 +274,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile

data/CHANGELOG.md

@@ -1,112 +0,0 @@
-## [0.3.2] - 2024-08-31
-
-- DDL: Support table column rename - #157
-
-## [0.3.0] - 2024-08-31
-
-- Support DDL Tracking by - #155
-  - `recreate-indices-post-copy` now defaults to `false`
-
-## [0.2.6] - 2024-06-04
-
-- Quote table name in the VACUUM SQL - #118
-- Exclude tables created by extensions - #120
-- Use db user when adding tables to replication - #130
-
-## [0.2.5] - 2024-04-14
-
-- List only permanent tables - #113
-
-## [0.2.4] - 2024-02-13
-
-- Introduce PG_EASY_REPLICATE_STATEMENT_TIMEOUT env var
-
-## [0.2.3] - 2024-01-21
-
-- Fix tables check in config_check - #93
-- add option to skip vacuum analyzing on switchover - #92
-- Disable statement timeout and reset it before/after vacuum+analyze - #94
-- Add spec for skip_vacuum_analyze - #95
-
-Highlights
-
-- You can now skip vacuum and analyze by passing `--skip-vacuum-analyze` to `switchover`. Thanks to @honzasterba
-- Vacuum and Analyze won't run into timeouts. Thanks to the report from @TrueCarry
-
-## [0.2.2] - 2024-01-21
-
-- Extend config check to assert for REPLICA IDENTITY on tables and drop index bug - #88
-
-## [0.2.1] - 2024-01-20
-
-- Don't attempt to drop and recreate unique indices - #88
-- Dependency updates
-
-## [0.2.0] - 2023-12-29
-
-- Recreate indices post COPY, once all tables are in replicating mode - #81
-
-## [0.1.12] - 2023-12-13
-
-- Bump rubocop-rspec from 2.24.1 to 2.25.0 - #65
-- Quote indent DB name - #76
-
-## [0.1.12] - 2023-12-13
-
-- Drop existing user with privileges when bootstrapping - #75
-
-## [0.1.10] - 2023-12-12
-
-- Reference the passed in URL and use source db url - #74
-
-## [0.1.9] - 2023-08-01
-
-- Exclude views, temporary tables and foreign tables from #list_all_tables - #39
-- Add quote_identifier helper for SQL identifiers. - #40
-- Escape db user name in queries - #42
-- Require english lib so that $CHILD_STATUS is loaded - #43
-- Bump rubocop from 1.54.2 to 1.55.0 - #37
-- Bump rubocop-rspec from 2.22.0 to 2.23.0 - #36
-- Quote indent username, dbname and schema in all places - #44
-
-## [0.1.8] - 2023-07-23
-
-- Introduce --copy_schema via pg_dump - #35
-
-## [0.1.7] - 2023-06-26
-
-- Perform smoke test with retries in CI - #26
-- Default schema to `public` #29
-- Perform vacuum and analyze before and after switchover - #30
-
-## [0.1.6] - 2023-06-24
-
-- Bug fix: Support custom schema name
-- New smoke spec in CI
-
-## [0.1.5] - 2023-06-24
-
-- Fix bug in `stop_sync`
-
-## [0.1.4] - 2023-06-24
-
-- Drop lockbox dependency
-- Support password with special chars and test for url encoded URI
-- Support AWS and GCP special user scenarios and introduce `--special-user-role`
-
-## [0.1.3] - 2023-06-22
-
-- Docker multi-platform image build support for linux/amd64 and linux/arm64 starting 0.1.3
-
-## [0.1.2] - 2023-06-22
-
-- Keep the internal username unique
-
-## [0.1.1] - 2023-06-21
-
-- Don't leak bin/console and bin/setup into `$PATH`
-- Typo fixes
-
-## [0.1.0] - 2023-06-19
-
-- Initial release