database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-11-03 09:13:20 +03:00
Code Activity

doc: Clarify required options for each action in pg_recvlogical.

Browse Source 
Each pg_recvlogical action requires specific options. For example,
--slot, --dbname, and --file must be specified with the --start action.
Previously, the documentation did not clearly outline these requirements.

This commit updates the documentation to explicitly state
the necessary options for each action.

Author: Hayato Kuroda <kuroda.hayato@fujitsu.com>
Co-authored-by: Fujii Masao <masao.fujii@gmail.com>
Reviewed-by: Ashutosh Bapat <ashutosh.bapat.oss@gmail.com>
Reviewed-by: Vignesh C <vignesh21@gmail.com>
Reviewed-by: David G. Johnston <david.g.johnston@gmail.com>
Discussion: https://postgr.es/m/OSCPR01MB14966930B4357BAE8C9D68A8AF5C72@OSCPR01MB14966.jpnprd01.prod.outlook.com
This commit is contained in:
Fujii Masao
2025-03-25 00:14:38 +09:00
parent 76563f88cf
commit dfc13428a9
1 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/src/sgml/ref/pg_recvlogical.sgml
View File

@@ -73,6 +73,11 @@ PostgreSQL documentation
by <option>--dbname</option>. by <option>--dbname</option>.
</para> </para>
<para>
The <option>--slot</option> and <option>--dbname</option> are required
for this action.
</para>
<para> <para>
The <option>--two-phase</option> can be specified with The <option>--two-phase</option> can be specified with
<option>--create-slot</option> to enable decoding of prepared transactions. <option>--create-slot</option> to enable decoding of prepared transactions.
@@ -87,6 +92,10 @@ PostgreSQL documentation
Drop the replication slot with the name specified Drop the replication slot with the name specified
by <option>--slot</option>, then exit. by <option>--slot</option>, then exit.
</para> </para>
<para>
The <option>--slot</option> is required for this action.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -101,6 +110,11 @@ PostgreSQL documentation
<option>--no-loop</option> is specified. <option>--no-loop</option> is specified.
</para> </para>
<para>
The <option>--slot</option> and <option>--dbname</option>,
<option>--file</option> are required for this action.
</para>
<para> <para>
The stream format is determined by the output plugin specified when The stream format is determined by the output plugin specified when
the slot was created. the slot was created.
@@ -159,6 +173,9 @@ PostgreSQL documentation
Write received and decoded transaction data into this Write received and decoded transaction data into this
file. Use <literal>-</literal> for <systemitem>stdout</systemitem>. file. Use <literal>-</literal> for <systemitem>stdout</systemitem>.
</para> </para>
<para>
This parameter is required for <option>--start</option>.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -265,6 +282,9 @@ PostgreSQL documentation
mode, create the slot with this name. In <option>--drop-slot</option> mode, create the slot with this name. In <option>--drop-slot</option>
mode, delete the slot with this name. mode, delete the slot with this name.
</para> </para>
<para>
This parameter is required for any of actions.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -305,7 +325,11 @@ PostgreSQL documentation
The <replaceable>dbname</replaceable> can be a <link The <replaceable>dbname</replaceable> can be a <link
linkend="libpq-connstring">connection string</link>. If so, linkend="libpq-connstring">connection string</link>. If so,
connection string parameters will override any conflicting connection string parameters will override any conflicting
command line options. Defaults to the user name. command line options.
</para>
<para>
This parameter is required for <option>--create-slot</option>
and <option>--start</option>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>