From 55e949c8939898660929f31617a5ff27145780fd Mon Sep 17 00:00:00 2001 From: Emre Hasegeli Date: Mon, 20 Mar 2023 17:02:45 +0100 Subject: [PATCH v01 2/2] pgoutput: Document missing options Author: Emre Hasegeli Reviewed-by: Amit Kapila Reviewed-by: Peter Smith Backpatch-through: 14 Discussion: https://www.postgresql.org/message-id/flat/CAE2gYzwdwtUbs-tPSV-QBwgTubiyGD2ZGsSnAVsDfAGGLDrGOA%40mail.gmail.com --- doc/src/sgml/logical-replication.sgml | 3 +- doc/src/sgml/protocol.sgml | 81 ++++++++++++++++++++++++++- 2 files changed, 81 insertions(+), 3 deletions(-) diff --git a/doc/src/sgml/logical-replication.sgml b/doc/src/sgml/logical-replication.sgml index 1bb85e4ad9..e7fd1a38b2 100644 --- a/doc/src/sgml/logical-replication.sgml +++ b/doc/src/sgml/logical-replication.sgml @@ -1655,21 +1655,22 @@ CONTEXT: processing remote data for replication origin "pg_16395" during "INSER transactional consistency is guaranteed for the publications within any single subscription. Logical replication is built with an architecture similar to physical streaming replication (see ). It is implemented by walsender and apply processes. The walsender process starts logical decoding (described in ) of the WAL and loads the standard - logical decoding plugin (pgoutput). The plugin transforms the changes read + logical decoding plugin (pgoutput). The plugin + transforms the changes read from WAL to the logical replication protocol (see ) and filters the data according to the publication specification. The data is then continuously transferred using the streaming replication protocol to the apply worker, which maps the data to local tables and applies the individual changes as they are received, in correct transactional order. The apply process on the subscriber database always runs with diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index af3f016f74..76501a7da6 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -3075,26 +3075,32 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;" flow started by the START_REPLICATION SLOT slot_name LOGICAL replication command. The logical streaming replication protocol builds on the primitives of the physical streaming replication protocol. + + PostgreSQL supports extensible logical decoding + plugins. pgoutput is the standard one used for + the built-in logical replication. + + Logical Streaming Replication Parameters - The logical replication START_REPLICATION command - accepts following parameters: + Using the START_REPLICATION command, + pgoutput) accepts the following options: proto_version Protocol version. Currently versions 1, 2, 3, and 4 are supported. @@ -3120,20 +3126,91 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;" publication_names 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. + + + + + binary + + + + Boolean option to use binary transfer mode. Binary mode is faster + than the text mode but slightly less robust. + + + + + + + + messages + + + + Boolean option to enable sending the messages that are written + by pg_logical_emit_message. + + + + + + + + streaming + + + + Boolean option to enable streaming of in-progress transactions. + It accepts an additional value "parallel" to enable sending extra + information with some messages to be used for parallelisation. + Minimum protocol version 2 is required to turn it on. Minimum protocol + version 4 is required for the "parallel" option. + + + + + + + + two_phase + + + + Boolean option to enable two-phase transactions. Minimum protocol + version 3 is required to turn it on. + + + + + + + + origin + + + + String option to send only changes by an origin. It also gets + the option "none" to send the changes that have no origin associated, + and the option "any" to send the changes regardless of their origin. + This can be used to avoid loops (infinite replication of the same data) + among replication nodes. + + + Logical Replication Protocol Messages The individual protocol messages are discussed in the following -- 2.39.3 (Apple Git-145)