agora inbox for pgsql-docs@postgresql.org
help / color / mirror / Atom feedFrom: Fujii Masao <masao.fujii@oss.nttdata.com>
To: pgsql-docs@lists.postgresql.org
Subject: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs
Date: Wed, 18 Jun 2025 14:34:55 +0900
Message-ID: <f86cd84f-a6a3-4451-bae7-5cca9e63b06d@oss.nttdata.com> (raw)
Hi,
Commit 302cf157592 added support for LIKE in CREATE FOREIGN TABLE.
In this feature, since indexes are not created for foreign tables,
comments on indexes are not copied either.
However, the CREATE FOREIGN TABLE docs incorrectly states that
index comments are copied when using INCLUDING COMMENTS, as shown below:
------------------------------
INCLUDING COMMENTS
Comments for the copied columns, constraints, and indexes will be copied.
------------------------------
This isn't accurate for foreign tables, so we should remove the mention
of indexes. Patch attached.
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
From e6a023b56f790c9995463d75e6101e5eaf49e98b Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Wed, 18 Jun 2025 13:56:14 +0900
Subject: [PATCH v1] doc: Fix incorrect description of INCLUDING COMMENTS in
CREATE FOREIGN TABLE.
Commit 302cf157592 added support for LIKE in CREATE FOREIGN TABLE.
In this feature, since indexes are not created for foreign tables,
comments on indexes are not copied either.
However, the documentation incorrectly stated that index comments
would be copied when using INCLUDING COMMENTS. This commit
corrects that by removing the mention of index comments.
---
doc/src/sgml/ref/create_foreign_table.sgml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/src/sgml/ref/create_foreign_table.sgml b/doc/src/sgml/ref/create_foreign_table.sgml
index d08834ac9d2..009fa46532b 100644
--- a/doc/src/sgml/ref/create_foreign_table.sgml
+++ b/doc/src/sgml/ref/create_foreign_table.sgml
@@ -232,7 +232,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
<term><literal>INCLUDING COMMENTS</literal></term>
<listitem>
<para>
- Comments for the copied columns, constraints, and indexes will be
+ Comments for the copied columns and constraints will be
copied. The default behavior is to exclude comments, resulting in
the copied columns and constraints in the new table having no
comments.
--
2.49.0
Attachments:
[text/plain] v1-0001-doc-Fix-incorrect-description-of-INCLUDING-COMMEN.patch (1.4K, ../f86cd84f-a6a3-4451-bae7-5cca9e63b06d@oss.nttdata.com/2-v1-0001-doc-Fix-incorrect-description-of-INCLUDING-COMMEN.patch)
download | inline diff:
From e6a023b56f790c9995463d75e6101e5eaf49e98b Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Wed, 18 Jun 2025 13:56:14 +0900
Subject: [PATCH v1] doc: Fix incorrect description of INCLUDING COMMENTS in
CREATE FOREIGN TABLE.
Commit 302cf157592 added support for LIKE in CREATE FOREIGN TABLE.
In this feature, since indexes are not created for foreign tables,
comments on indexes are not copied either.
However, the documentation incorrectly stated that index comments
would be copied when using INCLUDING COMMENTS. This commit
corrects that by removing the mention of index comments.
---
doc/src/sgml/ref/create_foreign_table.sgml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/src/sgml/ref/create_foreign_table.sgml b/doc/src/sgml/ref/create_foreign_table.sgml
index d08834ac9d2..009fa46532b 100644
--- a/doc/src/sgml/ref/create_foreign_table.sgml
+++ b/doc/src/sgml/ref/create_foreign_table.sgml
@@ -232,7 +232,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
<term><literal>INCLUDING COMMENTS</literal></term>
<listitem>
<para>
- Comments for the copied columns, constraints, and indexes will be
+ Comments for the copied columns and constraints will be
copied. The default behavior is to exclude comments, resulting in
the copied columns and constraints in the new table having no
comments.
--
2.49.0
view thread (5+ messages) latest in thread
Message-ID: <f86cd84f-a6a3-4451-bae7-5cca9e63b06d@oss.nttdata.com>
Permalink: ../f86cd84f-a6a3-4451-bae7-5cca9e63b06d@oss.nttdata.com/
Also on: postgresql.org/message-id/f86cd84f-a6a3-4451-bae7-5cca9e63b06d@oss.nttdata.com
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: pgsql-docs@postgresql.org
Cc: masao.fujii@oss.nttdata.com, pgsql-docs@lists.postgresql.org
Subject: Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs
In-Reply-To: <f86cd84f-a6a3-4451-bae7-5cca9e63b06d@oss.nttdata.com>
* 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