]> git.ipfire.org Git - thirdparty/postgresql.git/commit
doc: Clarify INCLUDING COMMENTS behavior in CREATE TABLE LIKE.
authorFujii Masao <fujii@postgresql.org>
Thu, 26 Feb 2026 00:02:53 +0000 (09:02 +0900)
committerFujii Masao <fujii@postgresql.org>
Thu, 26 Feb 2026 00:03:34 +0000 (09:03 +0900)
commite81c61ee4a8e9df0f4d0a9fd0024947a1c5cfc84
tree79abf499c08752ec7ddf55e89cfb8b14041eb8be
parent74ee3e9e73656497d0bbf57ff6d839b37feefb09
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