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
This commit is contained in:
parent
bad0763a4d
commit
0eac3c798c
|
@ -535,7 +535,7 @@ test_sub=# SELECT * FROM t3;
|
||||||
remote replication slot was not created automatically, the user must create
|
remote replication slot was not created automatically, the user must create
|
||||||
it manually before the subscription can be activated. The steps to create
|
it manually before the subscription can be activated. The steps to create
|
||||||
the slot and activate the subscription are shown in the following examples.
|
the slot and activate the subscription are shown in the following examples.
|
||||||
These examples specify the standard logical decoding plugin
|
These examples specify the standard logical decoding output plugin
|
||||||
(<literal>pgoutput</literal>), which is what the built-in logical
|
(<literal>pgoutput</literal>), which is what the built-in logical
|
||||||
replication uses.
|
replication uses.
|
||||||
</para>
|
</para>
|
||||||
|
@ -1662,7 +1662,8 @@ CONTEXT: processing remote data for replication origin "pg_16395" during "INSER
|
||||||
implemented by <literal>walsender</literal> and <literal>apply</literal>
|
implemented by <literal>walsender</literal> and <literal>apply</literal>
|
||||||
processes. The walsender process starts logical decoding (described
|
processes. The walsender process starts logical decoding (described
|
||||||
in <xref linkend="logicaldecoding"/>) of the WAL and loads the standard
|
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
|
from WAL to the logical replication protocol
|
||||||
(see <xref linkend="protocol-logical-replication"/>) and filters the data
|
(see <xref linkend="protocol-logical-replication"/>) and filters the data
|
||||||
according to the publication specification. The data is then continuously
|
according to the publication specification. The data is then continuously
|
||||||
|
|
|
@ -2545,7 +2545,10 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
|
||||||
<term><replaceable class="parameter">option_name</replaceable></term>
|
<term><replaceable class="parameter">option_name</replaceable></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<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>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
@ -3106,12 +3109,18 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
|
||||||
the physical streaming replication protocol.
|
the physical streaming replication protocol.
|
||||||
</para>
|
</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">
|
<sect2 id="protocol-logical-replication-params">
|
||||||
<title>Logical Streaming Replication Parameters</title>
|
<title>Logical Streaming Replication Parameters</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The logical replication <literal>START_REPLICATION</literal> command
|
Using the <literal>START_REPLICATION</literal> command,
|
||||||
accepts following parameters:
|
<literal>pgoutput</literal> accepts the following options:
|
||||||
|
|
||||||
<variablelist>
|
<variablelist>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
|
@ -3121,7 +3130,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Protocol version. Currently versions <literal>1</literal>, <literal>2</literal>,
|
Protocol version. Currently versions <literal>1</literal>, <literal>2</literal>,
|
||||||
<literal>3</literal>, and <literal>4</literal> are supported.
|
<literal>3</literal>, and <literal>4</literal> are supported. A valid
|
||||||
|
version is required.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
Version <literal>2</literal> is supported only for server version 14
|
Version <literal>2</literal> is supported only for server version 14
|
||||||
|
@ -3148,6 +3158,73 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
|
||||||
Comma separated list of publication names for which to subscribe
|
Comma separated list of publication names for which to subscribe
|
||||||
(receive changes). The individual publication names are treated
|
(receive changes). The individual publication names are treated
|
||||||
as standard objects names and can be quoted the same as needed.
|
as standard objects names and can be quoted the same as needed.
|
||||||
|
At least one publication name is required.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
binary
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Boolean option to use binary transfer mode. Binary mode is faster
|
||||||
|
than the text mode but slightly less robust.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
messages
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Boolean option to enable sending the messages that are written
|
||||||
|
by <function>pg_logical_emit_message</function>.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
streaming
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
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.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
two_phase
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Boolean option to enable two-phase transactions. Minimum protocol
|
||||||
|
version 3 is required to turn it on.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
origin
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Option to send changes by their origin. Possible values are "none"
|
||||||
|
to only send the changes that have no origin associated, or "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.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
Loading…
Reference in New Issue