pg_easy_replicate 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62d1f99ef5e2e12aa5969d9bda1a0e9d4df32a61102d712e3409386ca9e35697
-  data.tar.gz: 074aaabbd3be3ceef65bc3949f91d694d9d597ba7e49000c8fcf01d8ccb425a7
+  metadata.gz: 5861f7f038a1d9c632eeab71e7195019041846f98f22297d3e148070e150f3f0
+  data.tar.gz: f3187c00bc0625954ac3c1b9f5a6847782383d198e5c04f2b6597d61a7d83e4d
 SHA512:
-  metadata.gz: d504dfa0c0d41e3f095186a65e0103ce297a65104d6c130b479dae199992455e0732215d9748914f71c3b2fb33db9735d619b3ad59226f0103f78a9b47701bad
-  data.tar.gz: d99b662637e65c6e9547f081dcecb51fc34ef29c3c5ed38e23f3b4e12d94c1861c8a3420f1bef1fbc79167dd9d709f1c9ba191cb16e57882c385083cf3d88951
+  metadata.gz: 60fe3ae088cab65b1a1ec5168e62cfed7f1ef1141a85a438481b05b798e143d2728f970771092094ee9ef643fdced7373a361fee5dca36a27074799370f142e7
+  data.tar.gz: 4267418bfd99ab8327f0d89e20a85062d06e1b8a0b5d6086afdb531ce7f3f91229015c611c9629bb2c471fedddada07974954bffa0cbd3ca18cd1bf7c7ac6a05

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [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

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    pg_easy_replicate (0.3.2)
+    pg_easy_replicate (0.3.3)
       ougai (~> 2.0.0)
       pg (~> 1.5.3)
       pg_query (~> 5.1.0)
-      sequel (>= 5.69, < 5.84)
+      sequel (>= 5.69, < 5.87)
       thor (>= 1.2.2, < 1.4.0)
 
 GEM
@@ -15,10 +15,10 @@ GEM
     bigdecimal (3.1.8)
     coderay (1.1.3)
     diff-lcs (1.5.1)
-    google-protobuf (4.28.0-arm64-darwin)
+    google-protobuf (4.28.2-arm64-darwin)
       bigdecimal
       rake (>= 13)
-    google-protobuf (4.28.0-x86_64-linux)
+    google-protobuf (4.28.2-x86_64-linux)
       bigdecimal
       rake (>= 13)
     haml (6.1.1)
@@ -31,24 +31,23 @@ GEM
     oj (3.14.3)
     ougai (2.0.0)
       oj (~> 3.10)
-    parallel (1.25.1)
-    parser (3.3.3.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
-    pg (1.5.7)
+    pg (1.5.9)
     pg_query (5.1.0)
       google-protobuf (>= 3.22.3)
     prettier_print (1.2.1)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.8.0)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
     rbs (3.1.0)
     regexp_parser (2.9.2)
-    rexml (3.3.6)
-      strscan
+    rexml (3.3.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -73,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.31.3)
+    rubocop-ast (1.32.3)
       parser (>= 3.3.1.0)
     rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
@@ -81,7 +80,7 @@ GEM
       rubocop (~> 1.41)
     rubocop-packaging (0.5.2)
       rubocop (>= 1.33, < 2.0)
-    rubocop-performance (1.21.1)
+    rubocop-performance (1.22.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
@@ -94,9 +93,8 @@ GEM
     rubocop-rspec_rails (2.28.2)
       rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
-    sequel (5.83.1)
+    sequel (5.86.0)
       bigdecimal
-    strscan (3.1.0)
     syntax_tree (6.2.0)
       prettier_print (>= 1.2.0)
     syntax_tree-haml (4.0.3)
@@ -108,9 +106,9 @@ GEM
       rbs
       syntax_tree (>= 2.0.1)
     temple (0.10.1)
-    thor (1.3.1)
+    thor (1.3.2)
     tilt (2.1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
   arm64-darwin-22

data/README.md

@@ -26,6 +26,7 @@ Battle tested in production at [Tines](https://www.tines.com/) 🚀
     - [Listing DDL Changes](#listing-ddl-changes)
     - [Applying DDL Changes](#applying-ddl-changes)
   - [Stats](#stats)
+  - [Notify](#notify)
   - [Performing switchover](#performing-switchover)
 - [Replicating single database with custom tables](#replicating-single-database-with-custom-tables)
 - [Exclude tables from replication](#exclude-tables-from-replication)
@@ -120,6 +121,7 @@ pg_easy_replicate commands:
   pg_easy_replicate help [COMMAND]                           # Describe available commands or one specific command
   pg_easy_replicate start_sync -g, --group-name=GROUP_NAME   # Starts the logical replication from source database to target database provisioned in the group
   pg_easy_replicate stats  -g, --group-name=GROUP_NAME       # Prints the statistics in JSON for the group
+  pg_easy_replicate notify  -g, --group-name=GROUP_NAME,  -u --url=URL_TO_NOTIFY    # Sends notifications of all stats values for a group to a specified url
   pg_easy_replicate stop_sync -g, --group-name=GROUP_NAME    # Stop the logical replication from source database to target database provisioned in the group
   pg_easy_replicate switchover  -g, --group-name=GROUP_NAME  # Puts the source database in read only mode after all the data is flushed and written
   pg_easy_replicate version                                  # Prints the version
@@ -276,6 +278,14 @@ $ pg_easy_replicate stats --group-name database-cluster-1
   ....
 ```
 
+### Notify
+
+You can send stats to an endpoint on an interval using notify. This can be configured to receieve the stats to this url on a frequency (default 10s). A timeout can also be configured for the request to the endpoint (default 10s). This gives you greater control over processing different events in the replication cycle in your workflow.
+
+```bash
+$ pg_easy_replicate notify --group-name database-cluster-1 --url https://example.com/webhook --frequency 10 --timeout 10
+```
+
 ### Performing switchover
 
 `pg_easy_replicate` doesn't kick off the switchover on its own. When you start the sync via `start_sync`, it starts the replication between the two databases. Once you have had the time to monitor stats and any other key metrics, you can kick off the `switchover`.

data/lib/pg_easy_replicate/cli.rb

@@ -163,6 +163,16 @@ 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"
+
+    def notify
+      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"
     method_option :group_name,
                   aliases: "-g",

data/lib/pg_easy_replicate/stats.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "net/http"
+
 module PgEasyReplicate
   class Stats
     REPLICATION_STATE_MAP = {
@@ -39,6 +41,30 @@ module PgEasyReplicate
         end
       end
 
+      def notify(group_name, url, frequency = 10, timeout = 10)
+        loop do
+          stats = object(group_name)
+          uri = URI.parse(url)
+
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = (uri.scheme == "https")
+          http.open_timeout = timeout
+          http.read_timeout = timeout
+
+          request = Net::HTTP::Post.new(uri.request_uri)
+          request.content_type = "application/json"
+          request.body = stats.to_json
+
+          response = http.request(request)
+
+          puts "Notification sent: #{response.code} #{response.message}"
+
+          sleep(frequency)
+        end
+      rescue StandardError => e
+        abort_with("Notify failed with: #{e.message}")
+      end
+
       # Get
       def lag_stats(group_name)
         sql = <<~SQL

data/lib/pg_easy_replicate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_easy_replicate
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Shayon Mukherjee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-31 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ougai
@@ -61,7 +61,7 @@ dependencies:
         version: '5.69'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.84'
+        version: '5.87'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +71,7 @@ dependencies:
         version: '5.69'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.84'
+        version: '5.87'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement