Makefile

@@ -4,8 +4,13 @@ EXTENSION = decoderbufs
 PROTOBUF_C_CFLAGS = $(shell pkg-config --cflags 'libprotobuf-c >= 1.0.0')
 PROTOBUF_C_LDFLAGS = $(shell pkg-config --libs 'libprotobuf-c >= 1.0.0')
 
+ifneq ($(USE_POSTGIS),false)
+C_PARAMS = -DUSE_POSTGIS
+POSTGIS_C_LDFLAGS = -L/usr/local/lib -llwgeom
+endif
+
 PG_CPPFLAGS += -std=c11 $(PROTOBUF_C_CFLAGS) -I/usr/local/include $(C_PARAMS)
-SHLIB_LINK  += $(PROTOBUF_C_LDFLAGS)
+SHLIB_LINK  += $(PROTOBUF_C_LDFLAGS) $(POSTGIS_C_LDFLAGS)
 
 OBJS = src/decoderbufs.o src/proto/pg_logicaldec.pb-c.o
 

README.md

@@ -10,17 +10,15 @@
 A PostgreSQL logical decoder output plugin to deliver data as [Protocol Buffers](https://developers.google.com/protocol-buffers), adapted for Debezium
 
 ## Thanks to
-
 - The original [Decoderbufs Project](https://github.com/xstevens/decoderbufs) on which this is based 
 - [The PostgreSQL Team](https://postgresql.org) for adding [logical decoding](http://www.postgresql.org/docs/9.4/static/logicaldecoding.html) support
 
 ## Dependencies
-
 This code depends on the following libraries and requires them for compilation:
 
-- [PostgreSQL](http://www.postgresql.org) 9.6+
-- [Protobuf-c](https://github.com/protobuf-c/protobuf-c) 1.2+ - used for data serialization
-- [PostGIS](http://www.postgis.net/) 2.1+ - used for Postgres geometric types support
+* [PostgreSQL](http://www.postgresql.org) 9.6+
+* [Protobuf-c](https://github.com/protobuf-c/protobuf-c) 1.2+ - used for data serialization
+* [PostGIS](http://www.postgis.net/) 2.1+ - used for Postgres geometric types support
 
 ## Building
 
@@ -28,10 +26,8 @@ This code depends on the following libraries and requires them for compilation:
 (for pg_config), PostgreSQL server development packages, protobuf-c for the Protocol Buffer support and some PostGIS development packages.
 
 ### Installing Dependencies
-
 #### Debian
 
-```bash
     # Core build utilities 
     apt-get update && apt-get install -f -y software-properties-common build-essential pkg-config git postgresql-server-dev-9.6 
     
@@ -41,13 +37,10 @@ apt-get install -f -y libproj-dev liblwgeom-dev
     # Protobuf-c dependency (requires a non-stable Debian repo)
     add-apt-repository "deb http://ftp.debian.org/debian testing main contrib" && apt-get update
     apt-get install -y libprotobuf-c-dev=1.2.1-1+b1
-```
 
 When updating the ProtoBuf definition, also install the ProtoBuf C compiler:
 
-```bash
     apt-get install -y protobuf-c-compiler=1.2.*
-```
 
 The above are taken from the Debezium [container images](https://github.com/debezium/docker-images).
 
@@ -60,20 +53,16 @@ Note that the last step from the above sequence is only required for Debian to b
 
 If you have all of the above prerequisites installed, clone this git repo to build from source:
 
-```bash
     git clone https://github.com/debezium/postgres-decoderbufs.git
     cd postgres-decoderbufs
-```
 
 ### Optional: Re-generating ProtoBuf code
 
 This is only needed after changes to the ProtoBuf definition (_proto/pg_logicaldec.proto):
 
-```bash
     cd proto
     protoc-c --c_out=../src/proto pg_logicaldec.proto
     cd ..
-```
 
 Commit the generated files to git then.
 
@@ -82,16 +71,13 @@ Commit the generated files to git then.
 If you have multiple Postgres versions installed, you can select which version to install decoderbufs into by altering your `$PATH` to point to the right version.
 Then `make` and `make install` for each version.  Here is an example:
 
-```bash
     # Install for Postgres 9.6 if I have multiple local versions
     export PATH=/usr/lib/postgresql/9.6/bin:$PATH
     make
     make install
-```
 
 Once the extension has been installed you just need to enable it and logical replication in postgresql.conf:
 
-```bash
     # MODULES
     shared_preload_libraries = 'decoderbufs'
     
@@ -101,21 +87,16 @@ max_wal_senders = 8             # max number of walsender processes (change requ
     wal_keep_segments = 4           # in logfile segments, 16MB each; 0 disables
     #wal_sender_timeout = 60s       # in milliseconds; 0 disables
     max_replication_slots = 4       # max number of replication slots (change requires restart)
-```
 
 In addition, permissions will have to be added for the user that connects to the DB to be able to replicate. This can be modified in _pg\_hba.conf_ like so:
 
-```make
     local   replication     <youruser>                          trust
     host    replication     <youruser>  127.0.0.1/32            trust
     host    replication     <youruser>  ::1/128                 trust
-```
     
 And restart PostgreSQL.
 
 ## Usage
-
-```sql
     -- can use SQL for demo purposes
     select * from pg_create_logical_replication_slot('decoderbufs_demo', 'decoderbufs');
     
@@ -128,7 +109,6 @@ select data from pg_logical_slot_get_changes('decoderbufs_demo', NULL, NULL, 'de
     
     -- check the WAL position of logical replicators
     select * from pg_replication_slots where slot_type = 'logical';
-```
 
 If you're performing an UPDATE/DELETE on your table and you don't see results for those operations from logical decoding, make sure you have set [REPLICA IDENTITY](http://www.postgresql.org/docs/9.4/static/sql-altertable.html#SQL-CREATETABLE-REPLICA-IDENTITY) appropriately for your use case.
     

proto/pg_logicaldec.proto

@@ -5,12 +5,9 @@ option java_outer_classname = "PgProto";
 option optimize_for = SPEED;
 
 enum Op {
-    UNKNOWN = -1;
     INSERT = 0;
     UPDATE = 1;
     DELETE = 2;
-    BEGIN  = 3;
-    COMMIT = 4;
 }
 
 message Point {

src/decoderbufs.c

@@ -60,12 +60,6 @@
 #error Expecting timestamps to be represented as integers, not as floating-point.
 #endif
 
-#if PG_VERSION_NUM >= 170000
-#define TUPLE_ACCESS(x) x
-#else
-#define TUPLE_ACCESS(x) &x->tuple
-#endif
-
 PG_MODULE_MAGIC;
 
 /* define a time macro to convert TimestampTz into something more sane,
@@ -170,6 +164,16 @@ static void pg_decode_shutdown(LogicalDecodingContext *ctx) {
   MemoryContextDelete(data->context);
 }
 
+/* BEGIN callback */
+static void pg_decode_begin_txn(LogicalDecodingContext *ctx,
+                                ReorderBufferTXN *txn) {
+}
+
+/* COMMIT callback */
+static void pg_decode_commit_txn(LogicalDecodingContext *ctx,
+                                 ReorderBufferTXN *txn, XLogRecPtr commit_lsn) {
+}
+
 /* print tuple datums (only used for debug-mode) */
 static void print_tuple_datums(StringInfo out, Decoderbufs__DatumMessage **tup,
                                size_t n) {
@@ -275,11 +279,8 @@ static void set_datum_value(Decoderbufs__DatumMessage *datum_msg, Oid typid,
       datum_msg->datum_case = DECODERBUFS__DATUM_MESSAGE__DATUM_DATUM_INT32;
       break;
     case INT8OID:
-      datum_msg->datum_int64 = DatumGetInt64(datum);
-      datum_msg->datum_case = DECODERBUFS__DATUM_MESSAGE__DATUM_DATUM_INT64;
-      break;
     case OIDOID:
-      datum_msg->datum_int64 = (Oid) DatumGetUInt64(datum);
+      datum_msg->datum_int64 = DatumGetInt64(datum);
       datum_msg->datum_case = DECODERBUFS__DATUM_MESSAGE__DATUM_DATUM_INT64;
       break;
     case FLOAT4OID:
@@ -313,21 +314,23 @@ static void set_datum_value(Decoderbufs__DatumMessage *datum_msg, Oid typid,
     case TIMESTAMPOID:
       ts = DatumGetTimestamp(datum);
       if (TIMESTAMP_NOT_FINITE(ts)) {
-           datum_msg->datum_int64 = ts;
+           ereport(ERROR, (errcode(ERRCODE_DATETIME_VALUE_OUT_OF_RANGE),
+           errmsg("timestamp \'%s\'out of range", ts ? strVal(ts) : "(null)")));
       } else {
            datum_msg->datum_int64 = TIMESTAMPTZ_TO_USEC_SINCE_EPOCH(ts);
-      }
            datum_msg->datum_case = DECODERBUFS__DATUM_MESSAGE__DATUM_DATUM_INT64;
            break;
+      }
     case TIMESTAMPTZOID:
       ts = DatumGetTimestampTz(datum);
       if (TIMESTAMP_NOT_FINITE(ts)) {
-           datum_msg->datum_int64 = ts;
+           ereport(ERROR, (errcode(ERRCODE_DATETIME_VALUE_OUT_OF_RANGE),
+           errmsg("timestamp \'%s\'out of range", ts ? strVal(ts) : "(null)")));
        } else {
            datum_msg->datum_int64 = TIMESTAMPTZ_TO_USEC_SINCE_EPOCH(ts);
-      }
            datum_msg->datum_case = DECODERBUFS__DATUM_MESSAGE__DATUM_DATUM_INT64;
            break;
+        }
     case DATEOID:
       /* simply get the number of days as the stored 32 bit value and convert to EPOCH */
       datum_msg->datum_int32 = DATE_TO_DAYS_SINCE_EPOCH(DatumGetDateADT(datum));
@@ -488,90 +491,6 @@ static void add_metadata_to_msg(Decoderbufs__TypeInfo **tmsg,
   }
 }
 
-/* BEGIN callback */
-static void pg_decode_begin_txn(LogicalDecodingContext *ctx,
-                                ReorderBufferTXN *txn) {
-
-  DecoderData *data;
-  MemoryContext old;
-  Decoderbufs__RowMessage rmsg = DECODERBUFS__ROW_MESSAGE__INIT;
-  elog(DEBUG1, "Entering begin callback");
-
-
-  /* Avoid leaking memory by using and resetting our own context */
-  data = ctx->output_plugin_private;
-  old = MemoryContextSwitchTo(data->context);
-
-  rmsg.op = DECODERBUFS__OP__BEGIN;
-  rmsg.has_op = true;
-  rmsg.transaction_id = txn->xid;
-  rmsg.has_transaction_id = true;
-#if PG_VERSION_NUM >= 150000
-  rmsg.commit_time = TIMESTAMPTZ_TO_USEC_SINCE_EPOCH(txn->xact_time.commit_time);
-#else
-  rmsg.commit_time = TIMESTAMPTZ_TO_USEC_SINCE_EPOCH(txn->commit_time);
-#endif
-  rmsg.has_commit_time = true;
-
-  /* write msg */
-  OutputPluginPrepareWrite(ctx, true);
-  if (data->debug_mode) {
-    print_row_msg(ctx->out, &rmsg);
-  } else {
-    size_t psize = decoderbufs__row_message__get_packed_size(&rmsg);
-    void *packed = palloc(psize);
-    size_t ssize = decoderbufs__row_message__pack(&rmsg, packed);
-    appendBinaryStringInfo(ctx->out, packed, ssize);
-  }
-  OutputPluginWrite(ctx, true);
-
-  /* Cleanup, freeing memory */
-  MemoryContextSwitchTo(old);
-  MemoryContextReset(data->context);
-}
-
-/* COMMIT callback */
-static void pg_decode_commit_txn(LogicalDecodingContext *ctx,
-                                 ReorderBufferTXN *txn, XLogRecPtr commit_lsn) {
-
-  DecoderData *data;
-  MemoryContext old;
-  Decoderbufs__RowMessage rmsg = DECODERBUFS__ROW_MESSAGE__INIT;
-  elog(DEBUG1, "Entering commit callback");
-
-
-  /* Avoid leaking memory by using and resetting our own context */
-  data = ctx->output_plugin_private;
-  old = MemoryContextSwitchTo(data->context);
-
-  rmsg.op = DECODERBUFS__OP__COMMIT;
-  rmsg.has_op = true;
-  rmsg.transaction_id = txn->xid;
-  rmsg.has_transaction_id = true;
-#if PG_VERSION_NUM >= 150000
-  rmsg.commit_time = TIMESTAMPTZ_TO_USEC_SINCE_EPOCH(txn->xact_time.commit_time);
-#else
-  rmsg.commit_time = TIMESTAMPTZ_TO_USEC_SINCE_EPOCH(txn->commit_time);
-#endif
-  rmsg.has_commit_time = true;
-
-  /* write msg */
-  OutputPluginPrepareWrite(ctx, true);
-  if (data->debug_mode) {
-    print_row_msg(ctx->out, &rmsg);
-  } else {
-    size_t psize = decoderbufs__row_message__get_packed_size(&rmsg);
-    void *packed = palloc(psize);
-    size_t ssize = decoderbufs__row_message__pack(&rmsg, packed);
-    appendBinaryStringInfo(ctx->out, packed, ssize);
-  }
-  OutputPluginWrite(ctx, true);
-
-  /* Cleanup, freeing memory */
-  MemoryContextSwitchTo(old);
-  MemoryContextReset(data->context);
-}
-
 /* callback for individual changed tuples */
 static void pg_decode_change(LogicalDecodingContext *ctx, ReorderBufferTXN *txn,
                              Relation relation, ReorderBufferChange *change) {
@@ -604,11 +523,7 @@ static void pg_decode_change(LogicalDecodingContext *ctx, ReorderBufferTXN *txn,
   /* set common fields */
   rmsg.transaction_id = txn->xid;
   rmsg.has_transaction_id = true;
-#if PG_VERSION_NUM >= 150000
-  rmsg.commit_time = TIMESTAMPTZ_TO_USEC_SINCE_EPOCH(txn->xact_time.commit_time);
-#else
   rmsg.commit_time = TIMESTAMPTZ_TO_USEC_SINCE_EPOCH(txn->commit_time);
-#endif
   rmsg.has_commit_time = true;
   rmsg.table = pstrdup(quote_qualified_identifier(get_namespace_name(get_rel_namespace(RelationGetRelid(relation))),
     NameStr(class_form->relname)));
@@ -628,13 +543,13 @@ static void pg_decode_change(LogicalDecodingContext *ctx, ReorderBufferTXN *txn,
         rmsg.new_tuple =
             palloc(sizeof(Decoderbufs__DatumMessage*) * rmsg.n_new_tuple);
         tuple_to_tuple_msg(rmsg.new_tuple, relation,
-                           TUPLE_ACCESS(change->data.tp.newtuple), tupdesc);
+                           &change->data.tp.newtuple->tuple, tupdesc);
 
         rmsg.n_new_typeinfo = rmsg.n_new_tuple;
         rmsg.new_typeinfo =
             palloc(sizeof(Decoderbufs__TypeInfo*) * rmsg.n_new_typeinfo);
         add_metadata_to_msg(rmsg.new_typeinfo, relation,
-                           TUPLE_ACCESS(change->data.tp.newtuple), tupdesc);
+                           &change->data.tp.newtuple->tuple, tupdesc);
       }
       break;
     case REORDER_BUFFER_CHANGE_UPDATE:
@@ -649,7 +564,7 @@ static void pg_decode_change(LogicalDecodingContext *ctx, ReorderBufferTXN *txn,
           rmsg.old_tuple =
               palloc(sizeof(Decoderbufs__DatumMessage*) * rmsg.n_old_tuple);
           tuple_to_tuple_msg(rmsg.old_tuple, relation,
-                             TUPLE_ACCESS(change->data.tp.oldtuple), tupdesc);
+                             &change->data.tp.oldtuple->tuple, tupdesc);
         }
         if (change->data.tp.newtuple != NULL) {
           elog(DEBUG1, "decoding new tuple information");
@@ -659,13 +574,13 @@ static void pg_decode_change(LogicalDecodingContext *ctx, ReorderBufferTXN *txn,
           rmsg.new_tuple =
               palloc(sizeof(Decoderbufs__DatumMessage*) * rmsg.n_new_tuple);
           tuple_to_tuple_msg(rmsg.new_tuple, relation,
-                             TUPLE_ACCESS(change->data.tp.newtuple), tupdesc);
+                             &change->data.tp.newtuple->tuple, tupdesc);
 
           rmsg.n_new_typeinfo = rmsg.n_new_tuple;
           rmsg.new_typeinfo =
               palloc(sizeof(Decoderbufs__TypeInfo*) * rmsg.n_new_typeinfo);
           add_metadata_to_msg(rmsg.new_typeinfo, relation,
-                             TUPLE_ACCESS(change->data.tp.newtuple), tupdesc);
+                             &change->data.tp.newtuple->tuple, tupdesc);
         }
       }
       break;
@@ -681,7 +596,7 @@ static void pg_decode_change(LogicalDecodingContext *ctx, ReorderBufferTXN *txn,
         rmsg.old_tuple =
             palloc(sizeof(Decoderbufs__DatumMessage*) *  rmsg.n_old_tuple);
         tuple_to_tuple_msg(rmsg.old_tuple, relation,
-                           TUPLE_ACCESS(change->data.tp.oldtuple), tupdesc);
+                           &change->data.tp.oldtuple->tuple, tupdesc);
       } else {
         elog(DEBUG1, "no information to decode from DELETE because either no PK is present or REPLICA IDENTITY NOTHING or invalid ");
       }

src/proto/pg_logicaldec.pb-c.c

@@ -565,26 +565,20 @@ const ProtobufCMessageDescriptor decoderbufs__row_message__descriptor =
   (ProtobufCMessageInit) decoderbufs__row_message__init,
   NULL,NULL,NULL    /* reserved[123] */
 };
-static const ProtobufCEnumValue decoderbufs__op__enum_values_by_number[6] =
+static const ProtobufCEnumValue decoderbufs__op__enum_values_by_number[3] =
 {
-  { "UNKNOWN", "DECODERBUFS__OP__UNKNOWN", -1 },
   { "INSERT", "DECODERBUFS__OP__INSERT", 0 },
   { "UPDATE", "DECODERBUFS__OP__UPDATE", 1 },
   { "DELETE", "DECODERBUFS__OP__DELETE", 2 },
-  { "BEGIN", "DECODERBUFS__OP__BEGIN", 3 },
-  { "COMMIT", "DECODERBUFS__OP__COMMIT", 4 },
 };
 static const ProtobufCIntRange decoderbufs__op__value_ranges[] = {
-{-1, 0},{0, 6}
+{0, 0},{0, 3}
 };
-static const ProtobufCEnumValueIndex decoderbufs__op__enum_values_by_name[6] =
+static const ProtobufCEnumValueIndex decoderbufs__op__enum_values_by_name[3] =
 {
-  { "BEGIN", 4 },
-  { "COMMIT", 5 },
-  { "DELETE", 3 },
-  { "INSERT", 1 },
-  { "UNKNOWN", 0 },
-  { "UPDATE", 2 },
+  { "DELETE", 2 },
+  { "INSERT", 0 },
+  { "UPDATE", 1 },
 };
 const ProtobufCEnumDescriptor decoderbufs__op__descriptor =
 {
@@ -593,9 +587,9 @@ const ProtobufCEnumDescriptor decoderbufs__op__descriptor =
   "Op",
   "Decoderbufs__Op",
   "decoderbufs",
-  6,
+  3,
   decoderbufs__op__enum_values_by_number,
-  6,
+  3,
   decoderbufs__op__enum_values_by_name,
   1,
   decoderbufs__op__value_ranges,

src/proto/pg_logicaldec.pb-c.h

@@ -24,12 +24,9 @@ typedef struct _Decoderbufs__RowMessage Decoderbufs__RowMessage;
 /* --- enums --- */
 
 typedef enum _Decoderbufs__Op {
-  DECODERBUFS__OP__UNKNOWN = -1,
   DECODERBUFS__OP__INSERT = 0,
   DECODERBUFS__OP__UPDATE = 1,
-  DECODERBUFS__OP__DELETE = 2,
-  DECODERBUFS__OP__BEGIN = 3,
-  DECODERBUFS__OP__COMMIT = 4
+  DECODERBUFS__OP__DELETE = 2
     PROTOBUF_C__FORCE_ENUM_TO_BE_INT_SIZE(DECODERBUFS__OP)
 } Decoderbufs__Op;