Skip to content

Commit a575098

Browse files
anarazelanarazel
committed
Improvements to the replication protocol documentation.
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.
1 parent 20561ac commit a575098

File tree

1 file changed

+39
-5
lines changed

1 file changed

+39
-5
lines changed

‎doc/src/sgml/protocol.sgml

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1428,10 +1428,10 @@ The commands accepted in walsender mode are:
14281428
</varlistentry>
14291429

14301430
<varlistentry>
1431-
<term><literal>CREATE_REPLICATION_SLOT</literal> <replaceable class="parameter">slotname</> <literal>PHYSICAL</literal><indexterm><primary>CREATE_REPLICATION_SLOT</primary></indexterm></term>
1431+
<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>
14321432
<listitem>
14331433
<para>
1434-
Create a physical replication
1434+
Create a physical or logical replication
14351435
slot. See <xref linkend="streaming-replication-slots"> for more about
14361436
replication slots.
14371437
</para>
@@ -1445,12 +1445,22 @@ The commands accepted in walsender mode are:
14451445
</para>
14461446
</listitem>
14471447
</varlistentry>
1448+
1449+
<varlistentry>
1450+
<term><replaceable class="parameter">output_plugin</></term>
1451+
<listitem>
1452+
<para>
1453+
The name of the output plugin used for logical decoding
1454+
(see <xref linkend="logicaldecoding-output-plugin">).
1455+
</para>
1456+
</listitem>
1457+
</varlistentry>
14481458
</variablelist>
14491459
</listitem>
14501460
</varlistentry>
14511461

14521462
<varlistentry>
1453-
<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>
1463+
<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>
14541464
<listitem>
14551465
<para>
14561466
Instructs server to start streaming WAL, starting at
@@ -1778,7 +1788,7 @@ The commands accepted in walsender mode are:
17781788
</listitem>
17791789
</varlistentry>
17801790
<varlistentry>
1781-
<term><literal>START_REPLICATION</literal> <literal>SLOT</literal> <replaceable class="parameter">slotname</> <literal>LOGICAL</literal> <replaceable class="parameter">XXX/XXX</></term>
1791+
<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>
17821792
<listitem>
17831793
<para>
17841794
Instructs server to start streaming WAL for logical replication, starting
@@ -1787,10 +1797,17 @@ The commands accepted in walsender mode are:
17871797
been recycled. On success, server responds with a CopyBothResponse
17881798
message, and then starts to stream WAL to the frontend.
17891799
</para>
1800+
1801+
<para>
1802+
The messages inside the CopyBothResponse messages are of the same format
1803+
documented for <literal>START_REPLICATION ... PHYSICAL</literal>.
1804+
</para>
1805+
17901806
<para>
17911807
The output plugin associated with the selected slot is used
17921808
to process the output for streaming.
17931809
</para>
1810+
17941811
<variablelist>
17951812
<varlistentry>
17961813
<term><literal>SLOT</literal> <replaceable class="parameter">slotname</></term>
@@ -1811,12 +1828,29 @@ The commands accepted in walsender mode are:
18111828
</para>
18121829
</listitem>
18131830
</varlistentry>
1831+
<varlistentry>
1832+
<term><replaceable class="parameter">option_name</></term>
1833+
<listitem>
1834+
<para>
1835+
The name of an option passed to the slot's logical decoding plugin.
1836+
</para>
1837+
</listitem>
1838+
</varlistentry>
1839+
<varlistentry>
1840+
<term><replaceable class="parameter">option_value</></term>
1841+
<listitem>
1842+
<para>
1843+
Optional value, in the form of a string constant, associated with the
1844+
specified option.
1845+
</para>
1846+
</listitem>
1847+
</varlistentry>
18141848
</variablelist>
18151849
</listitem>
18161850
</varlistentry>
18171851

18181852
<varlistentry>
1819-
<term><literal>DROP_REPLICATION_SLOT</literal> <replaceable class="parameter">slotname</></term>
1853+
<term>DROP_REPLICATION_SLOT <replaceable class="parameter">slotname</></term>
18201854
<listitem>
18211855
<para>
18221856
Drops a replication slot, freeing any reserved server-side resources. If

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy