pg-logical_replication 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 995a68b802609a1681e2329f88b1dc0e1cea9148
+  data.tar.gz: cb8c1d5435ca90c6c50a30d09a4afcc141f07d3a
+SHA512:
+  metadata.gz: d2f847732697fd297746cc19fa10a2733de22a020be2b165eacaa258c30cfaa39857ca0a0467860e77ee4f672ea4599b3508aa5883f22c4704ee417371171efb
+  data.tar.gz: 52c714f97cd3ccb81be3a6725fa52a49229b8ef43e96ff21691519fb27f9e41904603d8bba7005df6bb933b945d9230f5136d9c90cc7d1ccfaef29d44e34e25f

data/.codeclimate.yml

@@ -0,0 +1,30 @@
+---
+version: '2'
+checks:
+  argument-count:
+    enabled: false
+  complex-logic:
+    enabled: false
+  file-lines:
+    enabled: false
+  method-complexity:
+    config:
+      threshold: 11
+  method-count:
+    enabled: false
+  method-lines:
+    enabled: false
+  nested-control-flow:
+    enabled: false
+  return-statements:
+    enabled: false
+prepare:
+  fetch:
+  - url: https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml
+    path: ".rubocop_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_cc_base.yml
+    path: ".rubocop_cc_base.yml"
+plugins:
+  rubocop:
+    enabled: true
+    config: ".rubocop_cc.yml"

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--format progress
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+- https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml
+- .rubocop_local.yml

data/.rubocop_cc.yml

@@ -0,0 +1,4 @@
+inherit_from:
+- .rubocop_base.yml
+- .rubocop_cc_base.yml
+- .rubocop_local.yml

data/.travis.yml

@@ -0,0 +1,21 @@
+---
+dist: xenial
+language: ruby
+cache: bundler
+rvm:
+- 2.4.5
+- 2.5.3
+before_install:
+- 'echo ''gem: --no-ri --no-rdoc --no-document'' > ~/.gemrc'
+- gem install bundler
+- source ${TRAVIS_BUILD_DIR}/ci/before_install.sh
+before_script:
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+  > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
+- bundle exec rake spec:setup
+after_script:
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+addons:
+  postgresql: '10'

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](https://semver.org/).
+
+## [1.0.0] - 2019-05-08
+
+[Unreleased]: https://github.com/ManageIQ/pg-logical_replication/compare/v1.0.0...master

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pg-logical_replication.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,38 @@
+# PG::LogicalReplication
+
+[![Gem Version](https://badge.fury.io/rb/pg-logical_replication.svg)](http://badge.fury.io/rb/pg-logical_replication)
+[![Build Status](https://travis-ci.org/ManageIQ/pg-logical_replication.svg?branch=master)](https://travis-ci.org/ManageIQ/pg-logical_replication)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9967445630b9e8ff2fe5/maintainability)](https://codeclimate.com/github/ManageIQ/pg-logical_replication/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/9967445630b9e8ff2fe5/test_coverage)](https://codeclimate.com/github/ManageIQ/pg-logical_replication/test_coverage)
+[![Security](https://hakiri.io/github/ManageIQ/pg-logical_replication/master.svg)](https://hakiri.io/github/ManageIQ/pg-logical_replication/master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg-logical_replication'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg-logical_replication
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec:setup spec` to run the tests. `rake spec:teardown` will remove the databases created for test purposes.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ManageIQ/pg-logical_replication.
+
+## License
+
+This project is available as open source under the terms of the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+

data/Rakefile

@@ -0,0 +1,35 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+def create_database(dbname)
+  require "pg"
+  c = PG::Connection.new(:dbname => "postgres")
+  c.async_exec("CREATE DATABASE #{dbname}")
+rescue PG::DuplicateDatabase => err
+  raise unless err.message =~ /already exists/
+end
+
+def drop_database(dbname)
+  require "pg"
+  c = PG::Connection.new(:dbname => "postgres")
+  c.async_exec("DROP DATABASE #{dbname}")
+rescue PG::InvalidCatalogName => err
+  raise unless err.message =~ /does not exist/
+end
+
+namespace :spec do
+  desc "Setup the test databases"
+  task :setup => :teardown do
+    create_database("logical_test")
+    create_database("logical_test_target")
+  end
+
+  desc "Teardown the test databases"
+  task :teardown do
+    drop_database("logical_test")
+    drop_database("logical_test_target")
+  end
+end
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/ci/before_install.sh

@@ -0,0 +1,7 @@
+set -v
+
+echo -e "wal_level = 'logical'\nmax_worker_processes = 10\nmax_replication_slots = 10\nmax_wal_senders = 10" | sudo tee -a /etc/postgresql/10/main/postgresql.conf
+echo -e "local replication all trust" | sudo tee -a /etc/postgresql/10/main/pg_hba.conf
+sudo service postgresql restart 10
+
+set +v

data/lib/pg-logical_replication.rb

@@ -0,0 +1 @@
+require 'pg/logical_replication'

data/lib/pg/logical_replication.rb

@@ -0,0 +1,10 @@
+require "pg/logical_replication/version"
+require "pg/logical_replication/client"
+require "pg/logical_replication/command_builder"
+
+module PG
+  module LogicalReplication
+    class Error < StandardError; end
+    class CommandBuilderError < PG::LogicalReplication::Error; end
+  end
+end

data/lib/pg/logical_replication/client.rb

@@ -0,0 +1,321 @@
+require "pg"
+
+module PG
+  module LogicalReplication
+    class Client
+      attr_reader :connection
+      attr_reader :command_builder
+
+      # @param connection [PG::Connection] Database Connection
+      def initialize(connection)
+        @connection      = connection
+        @command_builder = PG::LogicalReplication::CommandBuilder.new(connection)
+      end
+
+      # Reports on replication lag from publisher to subscriber nodes
+      # This method must be run on the publisher node
+      #
+      # @return [Array<Hash<String,String>>] List of returned lag and application names,
+      #   one for each replication process
+      def lag_bytes
+        typed_exec(<<-SQL).to_a
+          SELECT
+            pg_wal_lsn_diff(pg_current_wal_insert_lsn(), flush_lsn) AS lag_bytes,
+            application_name
+          FROM
+            pg_stat_replication
+        SQL
+      end
+
+      # Reports on replication bytes of WAL being retained for each replication slot
+      # This method must be run on the publisher node
+      #
+      # @return [Array<Hash<String,String>>] List of returned WAL bytes and replication slot names,
+      #   one for each replication process
+      def wal_retained_bytes
+        typed_exec(<<-SQL).to_a
+          SELECT
+            pg_wal_lsn_diff(pg_current_wal_insert_lsn(), restart_lsn) AS retained_bytes,
+            slot_name::TEXT
+          FROM
+            pg_replication_slots
+          WHERE
+            plugin = 'pgoutput'
+        SQL
+      end
+
+      # Creates a subscription to a publisher node
+      #
+      # @param name [String] subscription name
+      # @param conninfo_hash [Hash] publisher node connection info
+      # @param publications [Array<String>] publication names to subscribe to
+      # @param options [Hash] optional parameters for CREATE SUBSCRIPTION
+      def create_subscription(name, conninfo_hash, publications, options = {})
+        connection_string = connection.escape_string(PG::Connection.parse_connect_args(conninfo_hash))
+        base_command = <<-SQL
+          CREATE SUBSCRIPTION #{connection.quote_ident(name)}
+                 CONNECTION '#{connection_string}'
+                 PUBLICATION #{safe_list(publications)}
+        SQL
+        typed_exec(command_builder.command_with_options(base_command, "WITH", options))
+      end
+
+      # Disconnects the subscription and removes it
+      #
+      # @param name [String] subscription name
+      # @param ifexists [Boolean] if true an error is not thrown when the subscription does not exist
+      def drop_subscription(name, ifexists = false)
+        typed_exec("DROP SUBSCRIPTION#{" IF EXISTS" if ifexists} #{connection.quote_ident(name)}")
+      end
+
+      # Updates a subscription connection string
+      #
+      # @param name [String] subscription name
+      # @param conninfo_hash [Hash] new external connection hash to the publisher node
+      def set_subscription_conninfo(name, conninfo_hash)
+        connection_string = connection.escape_string(PG::Connection.parse_connect_args(conninfo_hash))
+        typed_exec("ALTER SUBSCRIPTION #{connection.quote_ident(name)} CONNECTION '#{connection_string}'")
+      end
+
+      # Changes list of subscribed publications
+      #
+      # @param name [String] subscription name
+      # @param publications [Array<String>] publication names to subscribe to
+      # @param options [Hash] optional parameters
+      def set_subscription_publications(name, publications, options = {})
+        base_command = <<-SQL
+          ALTER SUBSCRIPTION #{connection.quote_ident(name)}
+          SET PUBLICATION #{safe_list(publications)}
+        SQL
+        typed_exec(@command_builder.command_with_options(base_command, "WITH", options))
+      end
+
+      # Fetch missing table information from publisher
+      #
+      # @param name [String] subscription name
+      # @param options [Hash] optional parameters
+      def sync_subscription(name, options = {})
+        base_command = <<-SQL
+          ALTER SUBSCRIPTION #{connection.quote_ident(name)} REFRESH PUBLICATION
+        SQL
+        typed_exec(@command_builder.command_with_options(base_command, "WITH", options))
+      end
+
+      # Enables the previously disabled subscription
+      #
+      # @param name [String] subscription name
+      def enable_subscription(name)
+        typed_exec("ALTER SUBSCRIPTION #{connection.quote_ident(name)} ENABLE")
+      end
+
+      # Disables the running subscription
+      #
+      # @param name [String] subscription name
+      def disable_subscription(name)
+        typed_exec("ALTER SUBSCRIPTION #{connection.quote_ident(name)} DISABLE")
+      end
+
+      # Alters parameters originally set by CREATE SUBSCRIPTION
+      #
+      # @param name [String] subscription name
+      # @param options [Hash] parameters to set
+      def alter_subscription_options(name, options)
+        base_command = "ALTER SUBSCRIPTION #{connection.quote_ident(name)}"
+        typed_exec(command_builder.command_with_options(base_command, "SET", options))
+      end
+
+      # Sets the owner of the subscription
+      #
+      # @param name [String] subscription name
+      # @param owner [String] new owner user name
+      def set_subscription_owner(name, owner)
+        typed_exec("ALTER SUBSCRIPTION #{connection.quote_ident(name)} OWNER TO #{connection.quote_ident(owner)}")
+      end
+
+      # Renames the subscription
+      #
+      # @param name [String] current subscription name
+      # @param new_name [String] new subscription name
+      def rename_subscription(name, new_name)
+        typed_exec("ALTER SUBSCRIPTION #{connection.quote_ident(name)} RENAME TO #{connection.quote_ident(new_name)}")
+      end
+
+      # Shows status and basic information about all subscriptions
+      #
+      # @return [Array<Hash>] a list of subscriptions
+      #   keys:
+      #     subscription_name
+      #     database_name
+      #     owner
+      #     worker_count
+      #     enabled
+      #     subscription_dsn
+      #     slot_name
+      #     publications
+      #     remote_replication_lsn
+      #     local_replication_lsn
+      def subscriptions(dbname = nil)
+        subscriptions = typed_exec(<<-SQL).to_a
+          SELECT
+            sub.subname::TEXT         AS subscription_name,
+            pg_database.datname::TEXT AS database_name,
+            pg_user.usename::TEXT     AS owner,
+            COUNT(sub_stat.pid)       AS worker_count,
+            sub.subenabled            AS enabled,
+            sub.subconninfo           AS subscription_dsn,
+            sub.subslotname::TEXT     AS slot_name,
+            sub.subpublications       AS publications,
+            stat.remote_lsn::TEXT     AS remote_replication_lsn,
+            stat.local_lsn::TEXT      AS local_replication_lsn
+          FROM
+            pg_subscription AS sub
+            JOIN pg_user
+              ON sub.subowner = usesysid
+            JOIN pg_database
+              ON sub.subdbid = pg_database.oid
+            LEFT JOIN pg_replication_origin_status stat
+              ON concat('pg_', sub.oid) = stat.external_id
+            LEFT JOIN pg_stat_subscription sub_stat
+              ON sub_stat.subid = sub.oid AND sub_stat.pid IS NOT NULL
+          GROUP BY
+            sub.subname,
+            pg_database.datname,
+            pg_user.usename,
+            sub.subenabled,
+            sub.subconninfo,
+            sub.subslotname,
+            sub.subpublications,
+            stat.remote_lsn,
+            stat.local_lsn
+        SQL
+
+        dbname ? subscriptions.select { |s| s["database_name"] == dbname } : subscriptions
+      end
+
+      # Returns if this database is subscribing to any publications
+      #
+      # @return [Boolean] true if there are any subscriptions, false otherwise
+      def subscriber?
+        subscriptions.any?
+      end
+
+      # Lists the current publications
+      #
+      # @return [Array<String>] publication names
+      def publications
+        typed_exec(<<-SQL)
+          SELECT
+            pubname::TEXT AS name,
+            usename::TEXT AS owner,
+            puballtables,
+            pubinsert,
+            pubupdate,
+            pubdelete
+          FROM
+            pg_publication
+            JOIN pg_user ON pubowner = usesysid
+        SQL
+      end
+
+      def publishes?(publication_name)
+        publications.any? { |p| p["name"] == publication_name }
+      end
+
+      # Creates a new publication
+      #
+      # @param name [String] publication name
+      # @param all_tables [Boolean] replicate changes for all tables, including ones created in the future
+      # @param tables [Array<String>] tables to be added to the publication, ignored if all_tables is true
+      # @param options [Hash] optional parameters
+      def create_publication(name, all_tables = false, tables = [], options = {})
+        base_command = "CREATE PUBLICATION #{connection.quote_ident(name)}"
+        if all_tables
+          base_command << " FOR ALL TABLES"
+        elsif !tables.empty?
+          base_command << " FOR TABLE #{safe_list(tables)}"
+        end
+        typed_exec(@command_builder.command_with_options(base_command, "WITH", options))
+      end
+
+      # Adds tables to a publication
+      #
+      # @param name [String] publication name
+      # @param tables [Array<String>] table names to add
+      def add_tables_to_publication(name, tables)
+        typed_exec("ALTER PUBLICATION #{connection.quote_ident(name)} ADD TABLE #{safe_list(tables)}")
+      end
+
+      # Sets the tables included in a publication
+      #
+      # @param name [String] publication name
+      # @param tables [Array<String>] table names
+      def set_publication_tables(name, tables)
+        typed_exec("ALTER PUBLICATION #{connection.quote_ident(name)} SET TABLE #{safe_list(tables)}")
+      end
+
+      # Removes tables from a publication
+      #
+      # @param name [String] publication name
+      # @param tables [Array<String>] table names to remove
+      def remove_tables_from_publication(name, tables)
+        typed_exec("ALTER PUBLICATION #{connection.quote_ident(name)} DROP TABLE #{safe_list(tables)}")
+      end
+
+      # Alters parameters originally set by CREATE PUBLICATION
+      #
+      # @param name [String] publication name
+      # @param options [Hash] parameters to set
+      def alter_publication_options(name, options)
+        base_command = "ALTER PUBLICATION #{connection.quote_ident(name)}"
+        typed_exec(command_builder.command_with_options(base_command, "SET", options))
+      end
+
+      # Sets the owner of a publication
+      #
+      # @param name [String] publication name
+      # @param owner [String] new owner user name
+      def set_publication_owner(name, owner)
+        typed_exec("ALTER PUBLICATION #{connection.quote_ident(name)} OWNER TO #{connection.quote_ident(owner)}")
+      end
+
+      # Renames a publication
+      #
+      # @param name [String] current publication name
+      # @param new_name [String] new publication name
+      def rename_publication(name, new_name)
+        typed_exec("ALTER PUBLICATION #{connection.quote_ident(name)} RENAME TO #{connection.quote_ident(new_name)}")
+      end
+
+      # Remove a publication
+      #
+      # @param name [String] publication name
+      # @param ifexists [Boolean] if true an error is not thrown when the publication does not exist
+      def drop_publication(name, ifexists = false)
+        typed_exec("DROP PUBLICATION#{" IF EXISTS" if ifexists} #{connection.quote_ident(name)}")
+      end
+
+      # Lists the tables currently in the publication
+      #
+      # @param set_name [String] publication name
+      # @return [Array<String>] table names
+      def tables_in_publication(name)
+        typed_exec(<<-SQL, name).values.flatten
+          SELECT tablename::TEXT
+          FROM pg_publication_tables
+          WHERE pubname = $1
+        SQL
+      end
+
+      private
+
+      def safe_list(list)
+        list.map { |e| connection.quote_ident(e) }.join(", ")
+      end
+
+      def typed_exec(sql, *params)
+        result = connection.async_exec(sql, params, nil, PG::BasicTypeMapForQueries.new(connection))
+        result.map_types!(PG::BasicTypeMapForResults.new(connection))
+      end
+    end
+  end
+end

data/lib/pg/logical_replication/command_builder.rb

@@ -0,0 +1,62 @@
+require "pg"
+
+module PG
+  module LogicalReplication
+    class CommandBuilder
+      attr_accessor :connection
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def command_with_options(sql, keyword, options)
+        raise CommandBuilderError, "Unrecognized keyword #{keyword}" unless ["WITH", "SET"].include?(keyword)
+        if options.empty?
+          case keyword
+          when "WITH"
+            return sql
+          when "SET"
+            raise CommandBuilderError, "Keyword SET requires options"
+          end
+        end
+        "#{sql} #{keyword} (#{parameters_list(options)})"
+      end
+
+      private
+
+      def parameters_list(options)
+        options.to_a.map do |k, v|
+          "#{connection.quote_ident(k)} = #{safe_value(k, v)}"
+        end.join(", ")
+      end
+
+      VALUE_TYPES_BY_KEY = {
+        # subscription options
+        "connect"            => "bool",
+        "copy_data"          => "bool",
+        "create_slot"        => "bool",
+        "enabled"            => "bool",
+        "refresh"            => "bool",
+        "slot_name"          => "string",
+        "synchronous_commit" => "string",
+        # publication options
+        "publish"            => "string"
+      }.freeze
+
+      def safe_value(key, value)
+        case VALUE_TYPES_BY_KEY[key]
+        when "string"
+          value == "NONE" ? "NONE" : quote_string(value)
+        when "bool"
+          value ? "true" : "false"
+        else
+          raise PG::LogicalReplication::CommandBuilderError, "Option type for key '#{key}' not defined"
+        end
+      end
+
+      def quote_string(s)
+        "#{connection.escape_literal(s)}"
+      end
+    end
+  end
+end

data/lib/pg/logical_replication/version.rb

@@ -0,0 +1,5 @@
+module PG
+  module LogicalReplication
+    VERSION = "1.0.0".freeze
+  end
+end

data/pg-logical_replication.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg/logical_replication/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg-logical_replication"
+  spec.version       = PG::LogicalReplication::VERSION
+  spec.authors       = ["Nick Carboni"]
+  spec.email         = ["ncarboni@redhat.com"]
+
+  spec.summary       = "A ruby gem for configuring and using postgresql logical replication"
+  spec.description   = <<-EOS
+This gem provides a class with methods which map directly to the PostgreSQL DSL for logical replication configuration
+  EOS
+  spec.homepage      = "https://github.com/ManageIQ/pg-logical_replication"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pg"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.52"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: pg-logical_replication
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nick Carboni
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'This gem provides a class with methods which map directly to the PostgreSQL
+  DSL for logical replication configuration
+
+'
+email:
+- ncarboni@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_cc.yml"
+- ".rubocop_local.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ci/before_install.sh
+- lib/pg-logical_replication.rb
+- lib/pg/logical_replication.rb
+- lib/pg/logical_replication/client.rb
+- lib/pg/logical_replication/command_builder.rb
+- lib/pg/logical_replication/version.rb
+- pg-logical_replication.gemspec
+homepage: https://github.com/ManageIQ/pg-logical_replication
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A ruby gem for configuring and using postgresql logical replication
+test_files: []