Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit ecb814b

Browse files
committed
doc: Document result set of CREATE_REPLICATION_SLOT
From: Marko Tiikkaja <marko@joh.to>
1 parent 14ca9ab commit ecb814b

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

doc/src/sgml/protocol.sgml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1510,6 +1510,55 @@ The commands accepted in walsender mode are:
15101510
</listitem>
15111511
</varlistentry>
15121512
</variablelist>
1513+
1514+
<para>
1515+
In response to this command, the server will send a one-row result set
1516+
containing the following fields:
1517+
1518+
<variablelist>
1519+
<varlistentry>
1520+
<term><literal>slot_name</literal> (<type>text</type>)</term>
1521+
<listitem>
1522+
<para>
1523+
The name of the newly-created replication slot.
1524+
</para>
1525+
</listitem>
1526+
</varlistentry>
1527+
1528+
<varlistentry>
1529+
<term><literal>consistent_point</literal> (<type>text</type>)</term>
1530+
<listitem>
1531+
<para>
1532+
The WAL position at which the slot became consistent. This is the
1533+
earliest location from which streaming can start on this replication
1534+
slot.
1535+
</para>
1536+
</listitem>
1537+
</varlistentry>
1538+
1539+
<varlistentry>
1540+
<term><literal>snapshot_name</literal> (<type>text</type>)</term>
1541+
<listitem>
1542+
<para>
1543+
The identifier of the snapshot exported by the command. The
1544+
snapshot is valid until a new command is executed on this connection
1545+
or the replication connection is closed. Null if the created slot
1546+
is physical.
1547+
</para>
1548+
</listitem>
1549+
</varlistentry>
1550+
1551+
<varlistentry>
1552+
<term><literal>output_plugin</literal> (<type>text</type>)</term>
1553+
<listitem>
1554+
<para>
1555+
The name of the output plugin used by the newly-created replication
1556+
slot. Null if the created slot is physical.
1557+
</para>
1558+
</listitem>
1559+
</varlistentry>
1560+
</variablelist>
1561+
</para>
15131562
</listitem>
15141563
</varlistentry>
15151564

0 commit comments

Comments
 (0)