postgres.git / summary / log / commit / refs

commit    ec84a1f16f2838830d4ca37e3ea1f40faf3e4e52
Author:   Fujii Masao <fujii@postgresql.org>
Date:     Thu Feb 26 00:02:53 2026 +0000
First released in: 14.23, 15.18, 16.14, 17.10, 18.4

    doc: Clarify INCLUDING COMMENTS behavior in CREATE TABLE LIKE.
    
    The documentation for the INCLUDING COMMENTS option of the LIKE clause
    in CREATE TABLE was inaccurate and incomplete. It stated that comments for
    copied columns, constraints, and indexes are copied, but regarding comments
    on constraints in reality only comments on CHECK and NOT NULL constraints
    are copied; comments on other constraints (such as primary keys) are not.
    In addition, comments on extended statistics are copied, but this was not
    documented.
    
    The CREATE FOREIGN TABLE documentation had a similar omission: comments
    on extended statistics are also copied, but this was not mentioned.
    
    This commit updates the documentation to clarify the actual behavior.
    The CREATE TABLE reference now specifies that comments on copied columns,
    CHECK constraints, NOT NULL constraints, indexes, and extended statistics are
    copied. The CREATE FOREIGN TABLE reference now notes that comments on
    extended statistics are copied as well.
    
    Backpatch to all supported versions. Documentation updates related to
    CREATE FOREIGN TABLE LIKE and NOT NULL constraint comment copying are
    not applied to v17 and earlier, since those features were introduced in v18.
    
    Author: Fujii Masao <masao.fujii@gmail.com>
    Reviewed-by: Matheus Alcantara <matheusssilv97@gmail.com>
    Discussion: https://postgr.es/m/CAHGQGwHSOSGcaYDvHF8EYCUCfGPjbRwGFsJ23cx5KbJ1X6JouQ@mail.gmail.com
    Backpatch-through: 14


 doc/src/sgml/ref/create_table.sgml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml
index 9900663bd90..5b0a96ba3a1 100644
--- a/doc/src/sgml/ref/create_table.sgml
+++ b/doc/src/sgml/ref/create_table.sgml
@@ -634,9 +634,10 @@ 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, check constraints,
+          indexes, and extended statistics will be
           copied.  The default behavior is to exclude comments, resulting in
-          the copied columns and constraints in the new table having no
+          the corresponding objects in the new table having no
           comments.
          </para>
         </listitem>


[parent: 5d2dec77efaf]