diff options
| author | Robert Haas <rhaas@postgresql.org> | 2011-08-11 11:16:29 -0400 |
|---|---|---|
| committer | Robert Haas <rhaas@postgresql.org> | 2011-08-11 11:16:29 -0400 |
| commit | 59414cdedbc2ed418d66eddc0fcaf9dc40fbc27f (patch) | |
| tree | ee82dc4d88c058997b0af771e51f98c607661ee4 /doc/src | |
| parent | cff75130b5f63e45423c2ed90d6f2e84c21ef840 (diff) | |
| download | postgresql-59414cdedbc2ed418d66eddc0fcaf9dc40fbc27f.tar.gz postgresql-59414cdedbc2ed418d66eddc0fcaf9dc40fbc27f.zip | |
Change psql's \dd command to do something more useful.
Instead of displaying comments on an arbitrary subset of the object
types which support them, make \dd display comments on exactly those
object types which don't have their own backlash commands. We now
regard the display of comments as properly the job of the relevant
backslash command (though many of them do so only in verbose mode)
rather than something that \dd should be responsible for. However,
a handful of object types have no backlash command, so make \dd
give information about those.
Josh Kupershmidt
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/ref/psql-ref.sgml | 27 |
1 files changed, 12 insertions, 15 deletions
diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index db97df13c4d..3a10e76320e 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -990,24 +990,21 @@ testdb=> <term><literal>\dd[S] [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term> <listitem> <para> - Shows the descriptions of objects matching the <replaceable - class="parameter">pattern</replaceable>, or of all visible objects if - no argument is given. But in either case, only objects that have - a description are listed. + Shows the descriptions of objects of type <literal>constraint</>, + <literal>operator class</>, <literal>operator family</>, + <literal>rule</>, and <literal>trigger</>. All + other comments may be viewed by the respective backslash commands for + those object types. + </para> + + <para> + <literal>\dd</literal> displays descriptions for objects matching the + <replaceable class="parameter">pattern</replaceable>, 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 <literal>S</literal> modifier to include system objects. - <quote>Object</quote> covers aggregates, functions, operators, - types, relations (tables, views, indexes, sequences), large - objects, rules, and triggers. For example: -<programlisting> -=> <userinput>\dd version</userinput> - Object descriptions - Schema | Name | Object | Description -------------+---------+----------+--------------------------- - pg_catalog | version | function | PostgreSQL version string -(1 row) -</programlisting> </para> <para> |