1
0
mirror of https://github.com/postgres/postgres.git synced 2025-05-03 22:24:49 +03:00

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:
Amit Kapila 2023-12-26 10:56:45 +05:30
parent 375f441bd1
commit 951eaecbc3
2 changed files with 53 additions and 5 deletions

View File

@ -454,7 +454,8 @@
implemented by <quote>walsender</quote> and <quote>apply</quote> implemented by <quote>walsender</quote> and <quote>apply</quote>
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

View File

@ -2525,7 +2525,10 @@ The commands accepted in replication mode are:
<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>
@ -2870,12 +2873,18 @@ The commands accepted in replication mode are:
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>
@ -2885,7 +2894,8 @@ The commands accepted in replication mode are:
<listitem> <listitem>
<para> <para>
Protocol version. Currently versions <literal>1</literal> and Protocol version. Currently versions <literal>1</literal> and
<literal>2</literal> are supported. The version <literal>2</literal> <literal>2</literal> are supported. A valid version is required.
The version <literal>2</literal>
is supported only for server version 14 and above, and it allows is supported only for server version 14 and above, and it allows
streaming of large in-progress transactions. streaming of large in-progress transactions.
</para> </para>
@ -2901,6 +2911,43 @@ The commands accepted in replication mode are:
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.
Minimum protocol version 2 is required to turn it on.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>