Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

replisome - handsomely replicate something

Project Description

The project is currently in pre-production phase. We are hacking on it.

replisome is an output plugin for PostgreSQL logical decoding Using the plugin a client can receive a stream of changes describing the data manipulation inside the database (INSERT, UPDATE, DELETE of records) for all or a specified subset of tables, with the possibility of limiting the columns and rows received. Changes are received in JSON format.

replisome doesn’t try to be a complete replication solution: take a look at pglogical for that. Things you can do with it:

  • receive data from the database in a readable way, not for replication (e.g. for logging, message passing to different systems…)
  • integrate data update from a database into a receiving database with an arbitrary different schemas.

replisome doesn’t need persistent configuration in the database sending the changes, apart from the creation of a logical replication slot. The configuration, i.e. what records to send, is entirely chosen by the client connecting. Changing configuration is as simple as stopping the replica and restarting it with different parameters (the data stream will recover from where previously interrupted).

replisome is released under PostgreSQL license.

Requirements

  • PostgreSQL 9.4+

Build and Install

This thing will be packaged as an extension, have a version number, be released on PGXN… but currently it is only available on github:

$ git clone https://github.com/dvarrazzo/wal2json.git -b replisome replisome

Unix based Operating Systems

The extension should be compiled and installed in a PostgreSQL installation, after which it will be available in the database clusters run by that installation.

In order to build the extension you will need a C compiler, the PostgreSQL server development packages and maybe something else that google will friendly tell you.

$ git clone https://github.com/dvarrazzo/wal2json.git -b replisome replisome
$ cd replisome
$ export PATH=
$ make PG_CONFIG=/path/to/bin/pg_config
$ sudo make PG_CONFIG=/path/to/bin/pg_config install

Windows

In a world without walls you don’t need windows. But if you happen to do, try it and send some patches back.

Configuration

You need to set up at least two parameters into postgresql.conf:

wal_level = logical
max_replication_slots = 1

After changing these parameters, a restart is needed.

Examples

There are a few ways to obtain the changes (JSON objects) from the replisome plugin:

Examples using pg_recvlogical

Besides the configuration above, it is necessary to configure a replication connection to use pg_recvlogical.

First, add an entry into pg_hba.conf:

local    replication     myuser                     trust
host     replication     myuser     10.1.2.3/32     trust

Also, set max_wal_senders into postgresql.conf:

max_wal_senders = 1

A restart is necessary if you change max_wal_senders.

You are ready to try replisome. In one terminal create a replication slot and start a replica:

$ pg_recvlogical -d postgres --slot test_slot --create-slot -P replisome
$ pg_recvlogical -d postgres --slot test_slot --start -o pretty-print=1 -f -

In another terminal connect to the database and enter some commands:

=# create table test (
   id serial primary key, data text, ts timestamptz default now());
CREATE TABLE

=# insert into test default values;
INSERT 0 1
=# insert into test (data) values ('hello');
INSERT 0 1

=# begin;
BEGIN
*=# update test set data = 'world' where id = 2;
UPDATE 1
*=# delete from test where id = 1;
DELETE 1
*=# commit;
COMMIT

The streaming connection should display a description of the operations performed:

{
    "change": [
        {
            "op": "I",
            "schema": "public",
            "table": "test",
            "colnames": ["id", "data", "ts"],
            "coltypes": ["int4", "text", "timestamptz"],
            "values": [1, null, "2017-05-13 13:15:28.052318+01"]
        }
    ]
}
{
    "change": [
        {
            "op": "I",
            "schema": "public",
            "table": "test",
            "values": [2, "hello", "2017-05-13 13:15:35.140594+01"]
        }
    ]
}
{
    "change": [
        {
            "op": "U",
            "schema": "public",
            "table": "test",
            "values": [2, "world", "2017-05-13 13:15:35.140594+01"],
            "keynames": ["id"],
            "keytypes": ["int4"],
            "oldkey": [2]
        }
        ,{
            "op": "D",
            "schema": "public",
            "table": "test",
            "oldkey": [1]
        }
    ]
}

Options

The plugin output content and format is configured by several options passed to the START_REPLICATION command (e.g. using the -o option of pg_recvlogical, the psycopg start_replication() method etc.

pretty-print [bool] (default: false)
Add whitespaces in the output for readibility.
include [json]

Choose what tables and what content to see of these tables. The command, together with exclude, can be used several times: each table will be considered for inclusion or exclusion by matching it against all the commands specified in order. The last matching command will take effect (e.g. you may exclude an entire schema and then include only one specific table into it).

The parameter is a JSON object which may contain the following keys:

  • table: match a table with this name, in any schema
  • tables: match all the tables whose name matches a regular expression, in any schema
  • schema: match all the tables in a schema
  • schemas: match all the tables in all the schemas whose name matches a regular expression

These keys will establish if a table matches or not the configuration object. At least a schema or a table must be specified. The following options can be specified too, and they will affect any table whose inclusion is decided by the object:

  • columns: only emit the columns specified (as a JSON array)
  • skip_columns: don’t emit the columns specified
  • where: only emit the row matching the condition specified as a SQL expression matching the table columns, like in a CHECK clause.

Example (as pg_recvlogical option):

-o ' {"tables": "^test.*", "skip_columns": ["ts", "wat"], "where": "id % 2 = 0"}'
exlcude [json]
Choose what table to exclude. The format is the same of include but only the tables/schems can be specified, no rows or columns.
include-xids [bool] (default: false)

If true, include the id of each transaction:

{
    "xid": 5360,
    "change": [
        {   ...
include-lsn [bool] (default: false)

Include the Log Sequence Number of the transaction:

{
    "nextlsn": "0/3784C40",
    "change": [
        {   ...
include-timestamp [bool] (default: false)

Include the commit time of the transaction:

{
    "timestamp": "2017-05-13 03:19:29.828474+01",
    "change": [
        {   ...
include-schemas [bool] (default: true)
Include the schema name of the tables.
include-types [bool] (default: true)
Include the types of the table columns.
include-empty-xacts [bool] (default: false)
If true, send information about transactions not containing data changes (e.g. ones only performing DDL statements. Only the metadata (e.g. time, txid) of the transaction are sent.
write-in-chunks [bool] (default: false)
If true, data may be sent in several chunks instead of a single message for the entire transaction. Please note that a single chunk may not be a valid JSON document and the client is responsible to aggregate the parts received.

License

Copyright (c) 2013-2017, Euler Taveira de Oliveira
Copyright (c) 2017, Gambit Research Ltd.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of Gambit Research Ltd. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Release History

Release History

This version
History Node

0.0.1

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting