aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAmit Kapila <akapila@postgresql.org>2023-12-26 10:43:40 +0530
committerAmit Kapila <akapila@postgresql.org>2023-12-26 10:43:40 +0530
commitaede916688c47031a26cd11f773fc6bcdf584014 (patch)
treea0d8130aac345045d8460294ab56aef50e2e50ef
parent1771ec9a82900665226022e77ad5f8a86d27a1be (diff)
downloadpostgresql-aede916688c47031a26cd11f773fc6bcdf584014.tar.gz
postgresql-aede916688c47031a26cd11f773fc6bcdf584014.zip
Doc: Add missing pgoutput options.
We forgot to update the docs while adding new options in pgoutput. Author: Emre Hasegeli Reviewed-by: Peter Smith, Amit Kapila Backpatch-through: 12 Discussion: https://postgr.es/m/CAE2gYzwdwtUbs-tPSV-QBwgTubiyGD2ZGsSnAVsDfAGGLDrGOA%40mail.gmail.com
-rw-r--r--doc/src/sgml/logical-replication.sgml3
-rw-r--r--doc/src/sgml/protocol.sgml18
2 files changed, 16 insertions, 5 deletions
diff --git a/doc/src/sgml/logical-replication.sgml b/doc/src/sgml/logical-replication.sgml
index eb4878a1c94..e0e1967c670 100644
--- a/doc/src/sgml/logical-replication.sgml
+++ b/doc/src/sgml/logical-replication.sgml
@@ -432,7 +432,8 @@
implemented by <quote>walsender</quote> and <quote>apply</quote>
processes. The walsender process starts logical decoding (described
in <xref linkend="logicaldecoding"/>) of the WAL and loads the standard
- logical decoding plugin (pgoutput). The plugin transforms the changes read
+ logical decoding output plugin (<literal>pgoutput</literal>). The plugin
+ transforms the changes read
from WAL to the logical replication protocol
(see <xref linkend="protocol-logical-replication"/>) and filters the data
according to the publication specification. The data is then continuously
diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index 23ee0b84b24..5482f1b7929 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -2515,7 +2515,10 @@ The commands accepted in replication mode are:
<term><replaceable class="parameter">option_name</replaceable></term>
<listitem>
<para>
- The name of an option passed to the slot's logical decoding plugin.
+ The name of an option passed to the slot's logical decoding output
+ plugin. See <xref linkend="protocol-logical-replication"/> for
+ options that are accepted by the standard (<literal>pgoutput</literal>)
+ plugin.
</para>
</listitem>
</varlistentry>
@@ -2823,12 +2826,18 @@ The commands accepted in replication mode are:
the physical streaming replication protocol.
</para>
+ <para>
+ <productname>PostgreSQL</productname> logical decoding supports output
+ plugins. <literal>pgoutput</literal> is the standard one used for
+ the built-in logical replication.
+ </para>
+
<sect2 id="protocol-logical-replication-params">
<title>Logical Streaming Replication Parameters</title>
<para>
- The logical replication <literal>START_REPLICATION</literal> command
- accepts following parameters:
+ Using the <literal>START_REPLICATION</literal> command,
+ <literal>pgoutput</literal> accepts the following options:
<variablelist>
<varlistentry>
@@ -2838,7 +2847,7 @@ The commands accepted in replication mode are:
<listitem>
<para>
Protocol version. Currently only version <literal>1</literal> is
- supported.
+ supported. A valid version is required.
</para>
</listitem>
</varlistentry>
@@ -2852,6 +2861,7 @@ The commands accepted in replication mode are:
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.
</para>
</listitem>
</varlistentry>