agora inbox for pgsql-docs@postgresql.org
help / color / mirror / Atom feedFix inaccurate mention of index comments in CREATE FOREIGN TABLE docs
5+ messages / 2 participants
[nested] [flat]
* Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs
@ 2025-06-18 05:34 Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-18 06:50 ` Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Michael Paquier <michael@paquier.xyz>
0 siblings, 1 reply; 5+ messages in thread
From: Fujii Masao @ 2025-06-18 05:34 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org
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
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs
2025-06-18 05:34 Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Fujii Masao <masao.fujii@oss.nttdata.com>
@ 2025-06-18 06:50 ` Michael Paquier <michael@paquier.xyz>
2025-06-18 07:55 ` Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Fujii Masao <masao.fujii@oss.nttdata.com>
0 siblings, 1 reply; 5+ messages in thread
From: Michael Paquier @ 2025-06-18 06:50 UTC (permalink / raw)
To: Fujii Masao <masao.fujii@oss.nttdata.com>; +Cc: pgsql-docs@lists.postgresql.org
On Wed, Jun 18, 2025 at 02:34:55PM +0900, Fujii Masao wrote:
> 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.
Good point. This doc fix sounds fine to me.
--
Michael
Attachments:
[application/pgp-signature] signature.asc (832B, ../../aFJhr9iqbqJKzR6X@paquier.xyz/2-signature.asc)
download
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs
2025-06-18 05:34 Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-18 06:50 ` Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Michael Paquier <michael@paquier.xyz>
@ 2025-06-18 07:55 ` Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-19 00:17 ` Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-19 01:21 ` Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Michael Paquier <michael@paquier.xyz>
0 siblings, 2 replies; 5+ messages in thread
From: Fujii Masao @ 2025-06-18 07:55 UTC (permalink / raw)
To: Michael Paquier <michael@paquier.xyz>; +Cc: pgsql-docs@lists.postgresql.org
On 2025/06/18 15:50, Michael Paquier wrote:
> On Wed, Jun 18, 2025 at 02:34:55PM +0900, Fujii Masao wrote:
>> 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.
>
> Good point. This doc fix sounds fine to me.
Thanks for the review! I will commit the patch barring any other objections.
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs
2025-06-18 05:34 Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-18 06:50 ` Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Michael Paquier <michael@paquier.xyz>
2025-06-18 07:55 ` Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Fujii Masao <masao.fujii@oss.nttdata.com>
@ 2025-06-19 00:17 ` Fujii Masao <masao.fujii@oss.nttdata.com>
1 sibling, 0 replies; 5+ messages in thread
From: Fujii Masao @ 2025-06-19 00:17 UTC (permalink / raw)
To: Michael Paquier <michael@paquier.xyz>; +Cc: pgsql-docs@lists.postgresql.org
On 2025/06/18 16:55, Fujii Masao wrote:
>
>
> On 2025/06/18 15:50, Michael Paquier wrote:
>> On Wed, Jun 18, 2025 at 02:34:55PM +0900, Fujii Masao wrote:
>>> 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.
>>
>> Good point. This doc fix sounds fine to me.
>
> Thanks for the review! I will commit the patch barring any other objections.
I've pushed the patch. Thanks!
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs
2025-06-18 05:34 Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-18 06:50 ` Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Michael Paquier <michael@paquier.xyz>
2025-06-18 07:55 ` Re: Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Fujii Masao <masao.fujii@oss.nttdata.com>
@ 2025-06-19 01:21 ` Michael Paquier <michael@paquier.xyz>
1 sibling, 0 replies; 5+ messages in thread
From: Michael Paquier @ 2025-06-19 01:21 UTC (permalink / raw)
To: Fujii Masao <masao.fujii@oss.nttdata.com>; +Cc: pgsql-docs@lists.postgresql.org
On Wed, Jun 18, 2025 at 04:55:56PM +0900, Fujii Masao wrote:
> Thanks for the review! I will commit the patch barring any other objections.
Thanks.
--
Michael
Attachments:
[application/pgp-signature] signature.asc (832B, ../../aFNmErrH2v1tK0Vx@paquier.xyz/2-signature.asc)
download
^ permalink raw reply [nested|flat] 5+ messages in thread
end of thread, other threads:[~2025-06-19 01:21 UTC | newest]
Thread overview: 5+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2025-06-18 05:34 Fix inaccurate mention of index comments in CREATE FOREIGN TABLE docs Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-18 06:50 ` Michael Paquier <michael@paquier.xyz>
2025-06-18 07:55 ` Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-19 00:17 ` Fujii Masao <masao.fujii@oss.nttdata.com>
2025-06-19 01:21 ` Michael Paquier <michael@paquier.xyz>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox