public inbox for [email protected]
help / color / mirror / Atom feedFrom: Fujii Masao <[email protected]>
To: David G. Johnston <[email protected]>
To: Hayato Kuroda (Fujitsu) <[email protected]>
Cc: Ashutosh Bapat <[email protected]>
Cc: [email protected] <[email protected]>
Subject: Re: pg_recvlogical requires -d but not described on the documentation
Date: Tue, 18 Mar 2025 14:34:52 +0900
Message-ID: <[email protected]> (raw)
In-Reply-To: <CAKFQuwYWVT84GM2OqRx8EqNrfzNM-zbpQ5Y2bA1dPO9jUgo_Kg@mail.gmail.com>
References: <OSCPR01MB14966930B4357BAE8C9D68A8AF5C72@OSCPR01MB14966.jpnprd01.prod.outlook.com>
<CAExHW5uOprZgj2rVQ0HT3ckr+fVvhG-DvcVT+wfmwnwynH00pw@mail.gmail.com>
<OSCPR01MB149660D1F436F8B82912FCB53F5C72@OSCPR01MB14966.jpnprd01.prod.outlook.com>
<CAExHW5v94uRcr4f3+yhLrLX8UeYusJB06mcSqfdvu8fYUmVc=Q@mail.gmail.com>
<OS7PR01MB14968CC4F20B99B8E1508CE81F5C32@OS7PR01MB14968.jpnprd01.prod.outlook.com>
<CAKFQuwYWVT84GM2OqRx8EqNrfzNM-zbpQ5Y2bA1dPO9jUgo_Kg@mail.gmail.com>
On 2025/03/12 14:59, David G. Johnston wrote:
> On Monday, February 24, 2025, Hayato Kuroda (Fujitsu) <[email protected] <mailto:[email protected]>> wrote:
>
>
> OK, so I will exclude the point in the thread. The patch I've posted contains all of fixes
> which is required.
>
>
> The patch fixes the synopsis and the mention of the default value. Only the later is required. I cannot figure out a policy that would alter the synopsis in the proposed manner. I’d suggest leaving it alone for now and tweak any of the option descriptions that may need clarification.
I agree that the synopsis doesn't need to be updated. Attached patch clarifies
the required options for each action in the documentation. Thought?
BTW, I'm curious why --dbname isn't required for the --drop-slot action. When I ran
pg_recvlogical --drop-slot without --dbname, I got the following error:
pg_recvlogical: error: could not establish database-specific replication connection
Regards,
--
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION
From 8dcc53a6bebeaa1c4d0ddaacd35a3c450327bfef Mon Sep 17 00:00:00 2001
From: Fujii Masao <[email protected]>
Date: Tue, 18 Mar 2025 10:07:08 +0900
Subject: [PATCH v2] doc: Clarify required options for each action in
pg_recvlogical
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.
---
doc/src/sgml/ref/pg_recvlogical.sgml | 26 +++++++++++++++++++++++++-
1 file changed, 25 insertions(+), 1 deletion(-)
diff --git a/doc/src/sgml/ref/pg_recvlogical.sgml b/doc/src/sgml/ref/pg_recvlogical.sgml
index 95eb14b6352..2946bdae1e5 100644
--- a/doc/src/sgml/ref/pg_recvlogical.sgml
+++ b/doc/src/sgml/ref/pg_recvlogical.sgml
@@ -73,6 +73,11 @@ PostgreSQL documentation
by <option>--dbname</option>.
</para>
+ <para>
+ The <option>--slot</option> and <option>--dbname</option> are required
+ for this action.
+ </para>
+
<para>
The <option>--two-phase</option> can be specified with
<option>--create-slot</option> to enable decoding of prepared transactions.
@@ -87,6 +92,10 @@ PostgreSQL documentation
Drop the replication slot with the name specified
by <option>--slot</option>, then exit.
</para>
+
+ <para>
+ The <option>--slot</option> is required for this action.
+ </para>
</listitem>
</varlistentry>
@@ -101,6 +110,11 @@ PostgreSQL documentation
<option>--no-loop</option> is specified.
</para>
+ <para>
+ The <option>--slot</option> and <option>--dbname</option>,
+ <option>--file</option> are required for this action.
+ </para>
+
<para>
The stream format is determined by the output plugin specified when
the slot was created.
@@ -159,6 +173,9 @@ PostgreSQL documentation
Write received and decoded transaction data into this
file. Use <literal>-</literal> for <systemitem>stdout</systemitem>.
</para>
+ <para>
+ This parameter is required for <option>--start</option>.
+ </para>
</listitem>
</varlistentry>
@@ -265,6 +282,9 @@ PostgreSQL documentation
mode, create the slot with this name. In <option>--drop-slot</option>
mode, delete the slot with this name.
</para>
+ <para>
+ This parameter is required for any of actions.
+ </para>
</listitem>
</varlistentry>
@@ -305,7 +325,11 @@ PostgreSQL documentation
The <replaceable>dbname</replaceable> can be a <link
linkend="libpq-connstring">connection string</link>. If so,
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>
</listitem>
</varlistentry>
--
2.48.1
Attachments:
[text/plain] v2-0001-doc-Clarify-required-options-for-each-action-in-p.patch (3.1K, ../[email protected]/2-v2-0001-doc-Clarify-required-options-for-each-action-in-p.patch)
download | inline diff:
From 8dcc53a6bebeaa1c4d0ddaacd35a3c450327bfef Mon Sep 17 00:00:00 2001
From: Fujii Masao <[email protected]>
Date: Tue, 18 Mar 2025 10:07:08 +0900
Subject: [PATCH v2] doc: Clarify required options for each action in
pg_recvlogical
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.
---
doc/src/sgml/ref/pg_recvlogical.sgml | 26 +++++++++++++++++++++++++-
1 file changed, 25 insertions(+), 1 deletion(-)
diff --git a/doc/src/sgml/ref/pg_recvlogical.sgml b/doc/src/sgml/ref/pg_recvlogical.sgml
index 95eb14b6352..2946bdae1e5 100644
--- a/doc/src/sgml/ref/pg_recvlogical.sgml
+++ b/doc/src/sgml/ref/pg_recvlogical.sgml
@@ -73,6 +73,11 @@ PostgreSQL documentation
by <option>--dbname</option>.
</para>
+ <para>
+ The <option>--slot</option> and <option>--dbname</option> are required
+ for this action.
+ </para>
+
<para>
The <option>--two-phase</option> can be specified with
<option>--create-slot</option> to enable decoding of prepared transactions.
@@ -87,6 +92,10 @@ PostgreSQL documentation
Drop the replication slot with the name specified
by <option>--slot</option>, then exit.
</para>
+
+ <para>
+ The <option>--slot</option> is required for this action.
+ </para>
</listitem>
</varlistentry>
@@ -101,6 +110,11 @@ PostgreSQL documentation
<option>--no-loop</option> is specified.
</para>
+ <para>
+ The <option>--slot</option> and <option>--dbname</option>,
+ <option>--file</option> are required for this action.
+ </para>
+
<para>
The stream format is determined by the output plugin specified when
the slot was created.
@@ -159,6 +173,9 @@ PostgreSQL documentation
Write received and decoded transaction data into this
file. Use <literal>-</literal> for <systemitem>stdout</systemitem>.
</para>
+ <para>
+ This parameter is required for <option>--start</option>.
+ </para>
</listitem>
</varlistentry>
@@ -265,6 +282,9 @@ PostgreSQL documentation
mode, create the slot with this name. In <option>--drop-slot</option>
mode, delete the slot with this name.
</para>
+ <para>
+ This parameter is required for any of actions.
+ </para>
</listitem>
</varlistentry>
@@ -305,7 +325,11 @@ PostgreSQL documentation
The <replaceable>dbname</replaceable> can be a <link
linkend="libpq-connstring">connection string</link>. If so,
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>
</listitem>
</varlistentry>
--
2.48.1
view thread (20+ messages) latest in thread
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: [email protected]
Cc: [email protected], [email protected], [email protected], [email protected], [email protected]
Subject: Re: pg_recvlogical requires -d but not described on the documentation
In-Reply-To: <[email protected]>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox