Wiki / psql Commands / Describe database objects

\dd

Shows the descriptions of objects of type constraint , operator class , operator family , rule , and trigger . All other comments may be viewed by the respective backslash commands for those object types.

Reading PostgreSQL 18.6.

Description

Client: psql 18.6
Case-sensitive spelling: \dd

Usage

\dd[Sx] [ pattern ]

Spellings in this manual definition

Command	Documented suffix modifiers
\dd	Sx

Manual definition

\dd[Sx] [ pattern ]

Shows the descriptions of objects of type constraint, operator class, operator family, rule, and trigger. All other comments may be viewed by the respective backslash commands for those object types.

\dd displays descriptions for objects matching the pattern, or of visible objects of the appropriate type if no argument is given. But in either case, only objects that have a description are listed. By default, only user-created objects are shown; supply a pattern or the S modifier to include system objects. If x is appended to the command name, the results are displayed in expanded mode.

Descriptions for objects can be created with the COMMENT SQL command.

Related entries

psql command-line options and complete manual

Documentation and source

18.6 English manual · app-psql.html

Source build

Version: 18.6
Build: https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2
Source fingerprint: ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8

Compare versions

PostgreSQL 17 → 18: changed.

--- PostgreSQL 17
+++ PostgreSQL 18
@@ -1,12 +1,12 @@
 {
-  "definition": "Shows the descriptions of objects of type constraint , operator class , operator family , rule , and trigger . All other comments may be viewed by the respective backslash commands for those object types. \\dd displays descriptions for objects matching the pattern , or of visible objects of the appropriate type if no argument is given. But in either case, only objects that have a description are listed. By default, only user-created objects are shown; supply a pattern or the S modifier to include system objects. Descriptions for objects can be created with the COMMENT SQL command.",
+  "definition": "Shows the descriptions of objects of type constraint , operator class , operator family , rule , and trigger . All other comments may be viewed by the respective backslash commands for those object types. \\dd displays descriptions for objects matching the pattern , or of visible objects of the appropriate type if no argument is given. But in either case, only objects that have a description are listed. By default, only user-created objects are shown; supply a pattern or the S modifier to include system objects. If x is appended to the command name, the results are displayed in expanded mode. Descriptions for objects can be created with the COMMENT SQL command.",
   "modifiers": [
     {
       "command": "\\dd",
-      "modifiers": "S"
+      "modifiers": "Sx"
     }
   ],
-  "signature": "\\dd[S] [ pattern ]",
+  "signature": "\\dd[Sx] [ pattern ]",
   "spellings": [
     "\\dd"
   ]

Compares recorded interfaces and attributes. Source fingerprints and build metadata are excluded; an absent sample is not proof of the introduction or removal release.

Related entries

Export JSON · Back to psql Commands · Recorded in PostgreSQL 10 through 20; the first sample is not necessarily its introduction.