mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Document result set of CREATE_REPLICATION_SLOT

Browse Source 
From: Marko Tiikkaja <marko@joh.to>
This commit is contained in:
Peter Eisentraut 2017-02-02 16:04:59 -05:00
parent 14ca9abfbe
commit ecb814b5ce
1 changed files with 49 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1510,6 +1510,55 @@ The commands accepted in walsender mode are:
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para>
In response to this command, the server will send a one-row result set
containing the following fields:
<variablelist>
<varlistentry>
<term><literal>slot_name</literal> (<type>text</type>)</term>
<listitem>
<para>
The name of the newly-created replication slot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>consistent_point</literal> (<type>text</type>)</term>
<listitem>
<para>
The WAL position at which the slot became consistent. This is the
earliest location from which streaming can start on this replication
slot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>snapshot_name</literal> (<type>text</type>)</term>
<listitem>
<para>
The identifier of the snapshot exported by the command. The
snapshot is valid until a new command is executed on this connection
or the replication connection is closed. Null if the created slot
is physical.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>output_plugin</literal> (<type>text</type>)</term>
<listitem>
<para>
The name of the output plugin used by the newly-created replication
slot. Null if the created slot is physical.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>