]> git.ipfire.org Git - thirdparty/postgresql.git/commitdiff
doc: Clarify that \d and \d+ output lists are illustrative, not exhaustive.
authorFujii Masao <fujii@postgresql.org>
Mon, 26 Jan 2026 11:45:05 +0000 (20:45 +0900)
committerFujii Masao <fujii@postgresql.org>
Mon, 26 Jan 2026 11:45:05 +0000 (20:45 +0900)
The psql documentation for the \d and \d+ meta-commands lists objects
that may be shown, but previously the wording could be read as exhaustive
even though additional objects can also appear in the output.

This commit clarifies the description by adding phrasing such as "for example"
or "such as", making it clear that the listed objects are illustrative
rather than a complete list. While the change is small, it helps avoid
potential user confusion.

As this is a documentation clarification rather than a bug fix,
it is not backpatched.

Author: Peter Smith <smithpb2250@gmail.com>
Reviewed-by: Chao Li <li.evan.chao@gmail.com>
Reviewed-by: Andreas Karlsson <andreas@proxel.se>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/CAHut+Pt1DBtaUqfJftkkaQLJJJenYJBtb6Ec6s6vu82KEMh46A@mail.gmail.com

doc/src/sgml/ref/psql-ref.sgml

index f56c70263e07b2bcb9cfcc36669cee43a7835174..e464e3b13de5e5637aaaa81607603f7da132b5c0 100644 (file)
@@ -1299,9 +1299,9 @@ SELECT $1 \parse stmt1
         <replaceable class="parameter">pattern</replaceable>, show all
         columns, their types, the tablespace (if not the default) and any
         special attributes such as <literal>NOT NULL</literal> or defaults.
-        Associated indexes, constraints, rules, and triggers are
-        also shown.  For foreign tables, the associated foreign
-        server is shown as well.
+        Associated objects, such as indexes, constraints, rules, triggers,
+        and publications, are also shown. For foreign tables,
+        the associated foreign server is shown as well.
         (<quote>Matching the pattern</quote> is defined in
         <xref linkend="app-psql-patterns"/> below.)
         </para>
@@ -1314,8 +1314,8 @@ SELECT $1 \parse stmt1
 
         <para>
         The command form <literal>\d+</literal> is identical, except that
-        more information is displayed: any comments associated with the
-        columns of the table are shown, as is the presence of OIDs in the
+        more information is displayed: for example, any comments associated
+        with the columns of the table, the presence of OIDs in the
         table, the view definition if the relation is a view, a non-default
         <link linkend="sql-altertable-replica-identity">replica
          identity</link> setting and the