doc: add LITERAL tag to RETURNING

Started by torikoshiaabout 2 years ago4 messages
#1torikoshia
torikoshia@oss.nttdata.com
1 attachment(s)

Hi,

RETURNING is usually tagged with appropriate tags, such as <LITERAL>,
but not in the 'query' section of COPY.

https://www.postgresql.org/docs/devel/sql-copy.html

Would it be better to put <LITERAL> here as well?

--
Regards,

--
Atsushi Torikoshi
NTT DATA Group Corporation

Attachments:

v1-0001-Added-literal-tag-for-RETURNING.patchtext/x-diff; name=v1-0001-Added-literal-tag-for-RETURNING.patchDownload
From 3c9efe404310bf01d79b2f0f006541ebc0b170a0 Mon Sep 17 00:00:00 2001
From: Atsushi Torikoshi <torikoshia@oss.nttdata.com>
Date: Fri, 12 Jan 2024 14:33:47 +0900
Subject: [PATCH v1] Added literal tag for RETURNING.

---
 doc/src/sgml/ref/copy.sgml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/src/sgml/ref/copy.sgml b/doc/src/sgml/ref/copy.sgml
index 18ecc69c33..e2ffbbdf84 100644
--- a/doc/src/sgml/ref/copy.sgml
+++ b/doc/src/sgml/ref/copy.sgml
@@ -128,10 +128,10 @@ COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable
      </para>
      <para>
       For <command>INSERT</command>, <command>UPDATE</command> and
-      <command>DELETE</command> queries a RETURNING clause must be provided,
-      and the target relation must not have a conditional rule, nor
-      an <literal>ALSO</literal> rule, nor an <literal>INSTEAD</literal> rule
-      that expands to multiple statements.
+      <command>DELETE</command> queries a <literal>RETURNING</literal> clause
+      must be provided, and the target relation must not have a conditional
+      rule, nor an <literal>ALSO</literal> rule, nor an
+      <literal>INSTEAD</literal> rule that expands to multiple statements.
      </para>
     </listitem>
    </varlistentry>

base-commit: 08c3ad27eb5348d0cbffa843a3edb11534f9904a
-- 
2.39.2

#2Ashutosh Bapat
ashutosh.bapat.oss@gmail.com
In reply to: torikoshia (#1)
Re: doc: add LITERAL tag to RETURNING

On Fri, Jan 12, 2024 at 11:27 AM torikoshia <torikoshia@oss.nttdata.com> wrote:

Hi,

RETURNING is usually tagged with appropriate tags, such as <LITERAL>,
but not in the 'query' section of COPY.

I have the same observation.

https://www.postgresql.org/docs/devel/sql-copy.html

Would it be better to put <LITERAL> here as well?

The patch looks good.

--
Best Wishes,
Ashutosh Bapat

#3Alvaro Herrera
alvherre@alvh.no-ip.org
In reply to: Ashutosh Bapat (#2)
Re: doc: add LITERAL tag to RETURNING

On 2024-Jan-12, Ashutosh Bapat wrote:

On Fri, Jan 12, 2024 at 11:27 AM torikoshia <torikoshia@oss.nttdata.com> wrote:

RETURNING is usually tagged with appropriate tags, such as <LITERAL>,
but not in the 'query' section of COPY.

The patch looks good.

Good catch, pushed. It has user-visible effect, so I backpatched it.

--
Álvaro Herrera Breisgau, Deutschland — https://www.EnterpriseDB.com/
"People get annoyed when you try to debug them." (Larry Wall)

#4torikoshia
torikoshia@oss.nttdata.com
In reply to: Alvaro Herrera (#3)
Re: doc: add LITERAL tag to RETURNING

On 2024-01-12 20:56, Alvaro Herrera wrote:

On 2024-Jan-12, Ashutosh Bapat wrote:

On Fri, Jan 12, 2024 at 11:27 AM torikoshia
<torikoshia@oss.nttdata.com> wrote:

RETURNING is usually tagged with appropriate tags, such as <LITERAL>,
but not in the 'query' section of COPY.

The patch looks good.

Good catch, pushed. It has user-visible effect, so I backpatched it.

Thanks for your review and push.

--
Regards,

--
Atsushi Torikoshi
NTT DATA Group Corporation