database/postgres
database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-04-27 22:56:53 +03:00
Code

Improvements to the replication protocol documentation.

Browse Source 
Document the CREATE_REPLICATION_SLOT's output_plugin parameter; that
START_REPLICATION ... LOGICAL takes parameters; that START_REPLICATION
... LOGICAL uses the same messages as ... PHYSICAL; and be more
consistent with the usage of <literal/>.

Michael Paquier, with some additional changes by me.
This commit is contained in:
Andres Freund 2014-05-31 15:58:04 +02:00
parent 20561acf93
commit a57509821c
1 changed files with 39 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
doc/src/sgml/protocol.sgml
View File

@ -1428,10 +1428,10 @@ The commands accepted in walsender mode are:
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>CREATE_REPLICATION_SLOT</literal> <replaceable class="parameter">slotname</> <literal>PHYSICAL</literal><indexterm><primary>CREATE_REPLICATION_SLOT</primary></indexterm></term> <term>CREATE_REPLICATION_SLOT <replaceable class="parameter">slotname</> { <literal>PHYSICAL</> | <literal>LOGICAL</> <replaceable class="parameter">output_plugin</> } <indexterm><primary>CREATE_REPLICATION_SLOT</primary></indexterm></term>
<listitem> <listitem>
<para> <para>
Create a physical replication Create a physical or logical replication
slot. See <xref linkend="streaming-replication-slots"> for more about slot. See <xref linkend="streaming-replication-slots"> for more about
replication slots. replication slots.
</para> </para>
@ -1445,12 +1445,22 @@ The commands accepted in walsender mode are:
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><replaceable class="parameter">output_plugin</></term>
<listitem>
<para>
The name of the output plugin used for logical decoding
(see <xref linkend="logicaldecoding-output-plugin">).
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>START_REPLICATION</literal> [<literal>SLOT</literal> <replaceable class="parameter">slotname</>] [<literal>PHYSICAL</literal>] <replaceable class="parameter">XXX/XXX</> [<literal>TIMELINE</literal> <replaceable class="parameter">tli</>]</term> <term>START_REPLICATION [<literal>SLOT</literal> <replaceable class="parameter">slotname</>] [<literal>PHYSICAL</literal>] <replaceable class="parameter">XXX/XXX</> [<literal>TIMELINE</literal> <replaceable class="parameter">tli</>]</term>
<listitem> <listitem>
<para> <para>
Instructs server to start streaming WAL, starting at Instructs server to start streaming WAL, starting at
@ -1778,7 +1788,7 @@ The commands accepted in walsender mode are:
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>START_REPLICATION</literal> <literal>SLOT</literal> <replaceable class="parameter">slotname</> <literal>LOGICAL</literal> <replaceable class="parameter">XXX/XXX</></term> <term>START_REPLICATION <literal>SLOT</literal> <replaceable class="parameter">slotname</> <literal>LOGICAL</literal> <replaceable class="parameter">XXX/XXX</> [ ( <replaceable>option_name</replaceable> [<replaceable>option_value</replaceable>] [, ... ] ) ]</term>
<listitem> <listitem>
<para> <para>
Instructs server to start streaming WAL for logical replication, starting Instructs server to start streaming WAL for logical replication, starting
@ -1787,10 +1797,17 @@ The commands accepted in walsender mode are:
been recycled. On success, server responds with a CopyBothResponse been recycled. On success, server responds with a CopyBothResponse
message, and then starts to stream WAL to the frontend. message, and then starts to stream WAL to the frontend.
</para> </para>
<para>
The messages inside the CopyBothResponse messages are of the same format
documented for <literal>START_REPLICATION ... PHYSICAL</literal>.
</para>
<para> <para>
The output plugin associated with the selected slot is used The output plugin associated with the selected slot is used
to process the output for streaming. to process the output for streaming.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><literal>SLOT</literal> <replaceable class="parameter">slotname</></term> <term><literal>SLOT</literal> <replaceable class="parameter">slotname</></term>
@ -1811,12 +1828,29 @@ The commands accepted in walsender mode are:
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><replaceable class="parameter">option_name</></term>
<listitem>
<para>
The name of an option passed to the slot's logical decoding plugin.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">option_value</></term>
<listitem>
<para>
Optional value, in the form of a string constant, associated with the
specified option.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>DROP_REPLICATION_SLOT</literal> <replaceable class="parameter">slotname</></term> <term>DROP_REPLICATION_SLOT <replaceable class="parameter">slotname</></term>
<listitem> <listitem>
<para> <para>
Drops a replication slot, freeing any reserved server-side resources. If Drops a replication slot, freeing any reserved server-side resources. If