pgoutput

Description

The built-in output plugin used by PostgreSQL logical replication.

Interface family

Logical-decoding output plugin

Handler or routine

_PG_output_plugin_init

Recorded callbacks

20

LOGICALREP_PROTO_MIN_VERSION_NUM

1

LOGICALREP_PROTO_VERSION_NUM

1

LOGICALREP_PROTO_STREAM_VERSION_NUM

2

LOGICALREP_PROTO_TWOPHASE_VERSION_NUM

3

LOGICALREP_PROTO_STREAM_PARALLEL_VERSION_NUM

4

Interface and capability boundaries

The matrix records callbacks actually registered in this source build. Registration identifies an implemented interface hook; options, query shape, privileges and provider rules determine whether an operation is allowed.

The complete same-version manual below retains configuration, constraints and examples. No runtime capability test is claimed.

Output and protocol boundaries

Callback presence and protocol versions are separate from client negotiation and enabled plugin options. Streaming and two-phase processing require the matching protocol and configuration.

test_decoding is an example/test output format; pgoutput implements the logical-replication protocol. Their output contracts are not interchangeable.

Registered implementation in core source

{
	cb->startup_cb = pgoutput_startup;
	cb->begin_cb = pgoutput_begin_txn;
	cb->change_cb = pgoutput_change;
	cb->truncate_cb = pgoutput_truncate;
	cb->message_cb = pgoutput_message;
	cb->commit_cb = pgoutput_commit_txn;

	cb->begin_prepare_cb = pgoutput_begin_prepare_txn;
	cb->prepare_cb = pgoutput_prepare_txn;
	cb->commit_prepared_cb = pgoutput_commit_prepared_txn;
	cb->rollback_prepared_cb = pgoutput_rollback_prepared_txn;
	cb->filter_by_origin_cb = pgoutput_origin_filter;
	cb->shutdown_cb = pgoutput_shutdown;

	/* transaction streaming */
	cb->stream_start_cb = pgoutput_stream_start;
	cb->stream_stop_cb = pgoutput_stream_stop;
	cb->stream_abort_cb = pgoutput_stream_abort;
	cb->stream_commit_cb = pgoutput_stream_commit;
	cb->stream_change_cb = pgoutput_change;
	cb->stream_message_cb = pgoutput_message;
	cb->stream_truncate_cb = pgoutput_truncate;
	/* transaction streaming - two-phase commit */
	cb->stream_prepare_cb = pgoutput_stream_prepare_txn;
}

Related entries

• Logical decoding output interface
• Existing extension catalogue identity
• Logical Begin message
• Logical Relation message
• Logical tuple representation
• Logical Stream Start message
• Logical Prepare message

Documentation and source

• PostgreSQL 18 English manual
• src/backend/replication/pgoutput/pgoutput.c:262
• PostgreSQL 18 English manual
• Logical replication protocol constants

Compare versions

PostgreSQL 13 → 14: changed.

--- PostgreSQL 13
+++ PostgreSQL 14
@@ -4,26 +4,50 @@
     "change_cb": "pgoutput_change",
     "commit_cb": "pgoutput_commit_txn",
     "filter_by_origin_cb": "pgoutput_origin_filter",
+    "message_cb": "pgoutput_message",
     "shutdown_cb": "pgoutput_shutdown",
     "startup_cb": "pgoutput_startup",
+    "stream_abort_cb": "pgoutput_stream_abort",
+    "stream_change_cb": "pgoutput_change",
+    "stream_commit_cb": "pgoutput_stream_commit",
+    "stream_message_cb": "pgoutput_message",
+    "stream_start_cb": "pgoutput_stream_start",
+    "stream_stop_cb": "pgoutput_stream_stop",
+    "stream_truncate_cb": "pgoutput_truncate",
     "truncate_cb": "pgoutput_truncate"
   },
   "options": [
     {
-      "definition": "Protocol version. Currently only version 1 is supported. A valid version is required.",
+      "definition": "Protocol version. Currently versions 1 and 2 are supported. A valid version is required. The version 2 is supported only for server version 14 and above, and it allows streaming of large in-progress transactions.",
       "name": "proto_version"
     },
     {
       "definition": "Comma separated list of publication names for which to subscribe (receive changes). The individual publication names are treated as standard objects names and can be quoted the same as needed. At least one publication name is required.",
       "name": "publication_names"
+    },
+    {
+      "definition": "Boolean option to use binary transfer mode. Binary mode is faster than the text mode but slightly less robust.",
+      "name": "binary"
+    },
+    {
+      "definition": "Boolean option to enable sending the messages that are written by pg_logical_emit_message .",
+      "name": "messages"
+    },
+    {
+      "definition": "Boolean option to enable streaming of in-progress transactions. Minimum protocol version 2 is required to turn it on.",
+      "name": "streaming"
     }
   ],
   "protocol_versions": {
     "LOGICALREP_PROTO_MIN_VERSION_NUM": "1",
+    "LOGICALREP_PROTO_STREAM_VERSION_NUM": "2",
     "LOGICALREP_PROTO_VERSION_NUM": "1"
   },
   "source_options": [
+    "binary",
+    "messages",
     "proto_version",
-    "publication_names"
+    "publication_names",
+    "streaming"
   ]
 }

Compares recorded interfaces and attributes. Source fingerprints and build metadata are excluded; an absent sample is not proof of the introduction or removal release.