pg-pglogical 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da05087f43ad43beb2667fe42141438063b2132d
-  data.tar.gz: ef46f2b1fc9527374b9421d30c2fc4e2698911c3
+  metadata.gz: cfe7f15d53fec94d58d8d5bfa0583c2b18ea9aed
+  data.tar.gz: 6e536b7b1897e26fd0dbe1bfe0d522dbb965fa52
 SHA512:
-  metadata.gz: 1e6956ce6c83426d3baddf094f5142d7bc777a3aec892aafd6e1e74b9f6382b75888fd2c3142f6748fd0b7e48a4d4dbe577d523f6a02ef9466d2f25fb3973038
-  data.tar.gz: 848e14a6cbc2cd559660958009e545c83cbd7ef1113c5b0c29c11522dd8e669c7e29e85cc1f9609e30775d246c98358ecdcbb58b78ff4297687d17ed95aff5e1
+  metadata.gz: c0d27d37d79a48baa6b8a19fcca50310d9dabf0052ac0eb7c5e8ba4731466c24f1a2fde40d376e53e8c3fdec1b708bef2f230d1a3f15aa0a03a94c02e7819761
+  data.tar.gz: 757c12060ea5385d6842601a69f1185e1c195961bc1d15ec3af740533143d3e219fd72b64ce8c7df17dc3adbe6960f35c75e00fb2096b71c9076cc49d436e5b2

data/.travis.yml

@@ -6,7 +6,7 @@ rvm:
 before_install:
   - gem install bundler -v 1.13.6
   - source ${TRAVIS_BUILD_DIR}/ci/before_install.sh
-script:
-  - bundle exec rake spec:setup spec
+script: bundle exec rake spec:setup spec
+after_script: bundle exec codeclimate-test-reporter
 addons:
   postgresql: "9.5"

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/) 
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [1.1.0] - 2017-02-27
+### Added
+- Add the remote and local lsn to the subscription status [[#8](https://github.com/ManageIQ/pg-pglogical/pull/8)]
+
+[Unreleased]: https://github.com/ManageIQ/pg-pglogical/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/ManageIQ/pg-pglogical/compare/v1.0.0...v1.1.0

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pg-pglogical.gemspec
 gemspec
+
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+  gem "simplecov", :require => false
+end

data/README.md

@@ -1,5 +1,11 @@
 # PG::Pglogical
 
+[![Gem Version](https://badge.fury.io/rb/pg-pglogical.svg)](http://badge.fury.io/rb/pg-pglogical)
+[![Build Status](https://travis-ci.org/ManageIQ/pg-pglogical.svg)](https://travis-ci.org/ManageIQ/pg-pglogical)
+[![Code Climate](https://codeclimate.com/github/ManageIQ/pg-pglogical.svg)](https://codeclimate.com/github/ManageIQ/pg-pglogical)
+[![Test Coverage](https://codeclimate.com/github/ManageIQ/pg-pglogical/badges/coverage.svg)](https://codeclimate.com/github/ManageIQ/pg-pglogical/coverage)
+[![Dependency Status](https://gemnasium.com/ManageIQ/pg-pglogical.svg)](https://gemnasium.com/ManageIQ/pg-pglogical)
+
 This gem extends the ActiveRecord connection object to include methods which map directly to the SQL stored procedure APIs provided by pglogical.
 
 ## Installation

data/lib/pg/pglogical/client.rb

@@ -10,6 +10,7 @@ module PG
         @connection = connection
       end
 
+      # Returns whether the pglogical postgres extension is installed or not
       def installed?
         connection.select_value("SELECT EXISTS(SELECT * FROM pg_available_extensions WHERE name = 'pglogical')")
       end
@@ -29,6 +30,7 @@ module PG
         connection.enable_extension("pglogical")
       end
 
+      # Disables pglogical postgres extensions
       def disable
         connection.disable_extension("pglogical")
         connection.disable_extension("pglogical_origin") if connection.postgresql_version < 90_500
@@ -79,15 +81,14 @@ module PG
 
       # Updates a node connection string
       #
+      # NOTE: This method relies on the internals of the pglogical tables
+      #   rather than a published API.
+      # NOTE: Disable subscriptions involving the node before calling this
+      #   method for a provider node in a subscriber database.
+      #
       # @param name [String]
       # @param dsn [String] new external connection string to the node
       # @return [Boolean] true if the dsn was updated, false otherwise
-      #
-      # NOTE: This method relies on the internals of the pglogical tables
-      #       rather than a published API.
-      # NOTE: Disable subscriptions involving the node before
-      #       calling this method for a provider node in a subscriber
-      #       database.
       def node_dsn_update(name, dsn)
         res = typed_exec(<<-SQL, name, dsn)
           UPDATE pglogical.node_interface
@@ -128,11 +129,12 @@ module PG
       # @param replication_sets [Array<String>] replication set names to subscribe to
       # @param sync_structure [Boolean] sync the schema structure when subscribing
       # @param sync_data [Boolean] sync the data when subscribing
-      # @param forward_origins [Array<String>] names of non-provider nodes to replicate changes from (cascading replication)
-      def subscription_create(name, dsn, replication_sets = %w(default default_insert_only),
+      # @param forward_origins [Array<String>] names of non-provider nodes to replicate changes
+      #   from (cascading replication)
+      def subscription_create(name, dsn, replication_sets = %w(default default_insert_only), # rubocop:disable Metrics/ParameterLists
                               sync_structure = true, sync_data = true, forward_origins = ["all"])
-        command = "SELECT pglogical.create_subscription($1, $2, $3, $4, $5, $6)"
-        typed_exec(command, name, dsn, replication_sets, sync_structure, sync_data, forward_origins)
+        typed_exec("SELECT pglogical.create_subscription($1, $2, $3, $4, $5, $6)",
+                   name, dsn, replication_sets, sync_structure, sync_data, forward_origins)
       end
 
       # Disconnects the subscription and removes it
@@ -140,7 +142,8 @@ module PG
       # @param name [String] subscription name
       # @param ifexists [Boolean] if true an error is not thrown when the subscription does not exist
       def subscription_drop(name, ifexists = false)
-        typed_exec("SELECT pglogical.drop_subscription($1, $2)", name, ifexists)
+        typed_exec("SELECT pglogical.drop_subscription($1, $2)",
+                   name, ifexists)
       end
 
       # Disables a subscription and disconnects it from the provider
@@ -148,7 +151,8 @@ module PG
       # @param name [String] subscription name
       # @param immediate [Boolean] do not wait for the current transaction before stopping
       def subscription_disable(name, immediate = false)
-        typed_exec("SELECT pglogical.alter_subscription_disable($1, $2)", name, immediate)
+        typed_exec("SELECT pglogical.alter_subscription_disable($1, $2)",
+                   name, immediate)
       end
 
       # Enables a previously disabled subscription
@@ -156,7 +160,8 @@ module PG
       # @param name [String] subscription name
       # @param immediate [Boolean] do not wait for the current transaction before starting
       def subscription_enable(name, immediate = false)
-        typed_exec("SELECT pglogical.alter_subscription_enable($1, $2)", name, immediate)
+        typed_exec("SELECT pglogical.alter_subscription_enable($1, $2)",
+                   name, immediate)
       end
 
       # Syncs all unsynchronized tables in all sets in a single operation.
@@ -165,7 +170,8 @@ module PG
       # @param name [String] subscription name
       # @param truncate [Boolean] truncate the tables before syncing
       def subscription_sync(name, truncate = false)
-        typed_exec("SELECT pglogical.alter_subscription_synchronize($1, $2)", name, truncate)
+        typed_exec("SELECT pglogical.alter_subscription_synchronize($1, $2)",
+                   name, truncate)
       end
 
       # Resyncs one existing table
@@ -174,7 +180,8 @@ module PG
       # @param name [String] subscription name
       # @param table [String] name of the table to resync
       def subscription_resync_table(name, table)
-        typed_exec("SELECT pglogical.alter_subscription_resynchronize_table($1, $2)", name, table)
+        typed_exec("SELECT pglogical.alter_subscription_resynchronize_table($1, $2)",
+                   name, table)
       end
 
       # Adds a replication set to a subscription
@@ -183,7 +190,8 @@ module PG
       # @param name [String] subscription name
       # @param set_name [String] replication set name
       def subscription_add_replication_set(name, set_name)
-        typed_exec("SELECT pglogical.alter_subscription_add_replication_set($1, $2)", name, set_name)
+        typed_exec("SELECT pglogical.alter_subscription_add_replication_set($1, $2)",
+                   name, set_name)
       end
 
       # Removes a replication set from a subscription
@@ -191,13 +199,14 @@ module PG
       # @param name [String] subscription name
       # @param set_name [String] replication set name
       def subscription_remove_replication_set(name, set_name)
-        typed_exec("SELECT pglogical.alter_subscription_remove_replication_set($1, $2)", name, set_name)
+        typed_exec("SELECT pglogical.alter_subscription_remove_replication_set($1, $2)",
+                   name, set_name)
       end
 
       # Shows status and basic information about a subscription
       #
       # @prarm name [String] subscription name
-      # @return a hash with the subscription information
+      # @return [Hash] a hash with the subscription information
       #   keys:
       #     subscription_name
       #     status
@@ -206,22 +215,29 @@ module PG
       #     slot_name
       #     replication_sets
       #     forward_origins
+      #     remote_replication_lsn(Log Sequence Number)
+      #     local_replication_lsn(Log Sequence Number)
       def subscription_show_status(name)
-        res = typed_exec("SELECT * FROM pglogical.show_subscription_status($1)", name).first
-        res["replication_sets"] = res["replication_sets"][1..-2].split(",")
-        res["forward_origins"] = res["forward_origins"][1..-2].split(",")
-        res
+        sql = <<-SQL
+          SELECT sub.*, stat.remote_lsn AS remote_replication_lsn, stat.local_lsn AS local_replication_lsn
+          FROM pglogical.show_subscription_status($1) sub
+          JOIN pg_replication_origin_status stat
+            ON sub.slot_name = stat.external_id
+        SQL
+
+        typed_exec(sql, name).first.tap do |s|
+          s["replication_sets"] = s["replication_sets"][1..-2].split(",")
+          s["forward_origins"] = s["forward_origins"][1..-2].split(",")
+        end
       end
 
       # Shows the status of all configured subscriptions
       #
       # @return Array<Hash> list of results from #subscription_show_status
       def subscriptions
-        ret = []
-        connection.select_values("SELECT sub_name FROM pglogical.subscription").each do |s|
-          ret << subscription_show_status(s)
+        connection.select_values("SELECT sub_name FROM pglogical.subscription").collect do |s|
+          subscription_show_status(s)
         end
-        ret
       end
 
       # Replication Sets
@@ -271,7 +287,8 @@ module PG
       # @param table_name [String] table name to add
       # @param sync [Boolean] sync the table on all subscribers to the given replication set
       def replication_set_add_table(set_name, table_name, sync = false)
-        typed_exec("SELECT pglogical.replication_set_add_table($1, $2, $3)", set_name, table_name, sync)
+        typed_exec("SELECT pglogical.replication_set_add_table($1, $2, $3)",
+                   set_name, table_name, sync)
       end
 
       # Adds all tables in the given schemas to the replication set
@@ -289,7 +306,8 @@ module PG
       # @param set_name [String] replication set name
       # @param table_name [String] table to remove
       def replication_set_remove_table(set_name, table_name)
-        typed_exec("SELECT pglogical.replication_set_remove_table($1, $2)", set_name, table_name)
+        typed_exec("SELECT pglogical.replication_set_remove_table($1, $2)",
+                   set_name, table_name)
       end
 
       # Lists the tables currently in the replication set
@@ -321,7 +339,8 @@ module PG
       private
 
       def typed_exec(sql, *params)
-        connection.raw_connection.async_exec(sql, params, nil, PG::BasicTypeMapForQueries.new(connection.raw_connection))
+        type_map = PG::BasicTypeMapForQueries.new(connection.raw_connection)
+        connection.raw_connection.async_exec(sql, params, nil, type_map)
       end
     end
   end

data/lib/pg/pglogical/version.rb

@@ -1,5 +1,5 @@
 module PG
   module Pglogical
-    VERSION = "1.0.0".freeze
+    VERSION = "1.1.0".freeze
   end
 end

data/lib/pg-pglogical.rb

@@ -1 +1,2 @@
+# rubocop:disable Style/FileName
 require 'pg/pglogical'

data/pg-pglogical.gemspec

@@ -9,8 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Nick Carboni"]
   spec.email         = ["ncarboni@redhat.com"]
 
-  spec.summary       = %q{A ruby gem for configuring and using pglogical}
-  spec.description   = %q{This gem provides a class with methods which map directly to the SQL stored procedure APIs provided by pglogical. It also provides a way to mix these methods directly into the ActiveRecord connection object.}
+  spec.summary       = "A ruby gem for configuring and using pglogical"
+  spec.description   = <<-EOS
+This gem provides a class with methods which map directly to the SQL stored
+procedure APIs provided by pglogical. It also provides a way to mix these
+methods directly into the ActiveRecord connection object.
+EOS
   spec.homepage      = "https://github.com/ManageIQ/pg-pglogical"
   spec.license       = "Apache-2.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg-pglogical
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nick Carboni
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,8 +80,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: This gem provides a class with methods which map directly to the SQL
-  stored procedure APIs provided by pglogical. It also provides a way to mix these
+description: |
+  This gem provides a class with methods which map directly to the SQL stored
+  procedure APIs provided by pglogical. It also provides a way to mix these
   methods directly into the ActiveRecord connection object.
 email:
 - ncarboni@redhat.com
@@ -92,6 +93,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md