diff options
| author | Robert Haas <rhaas@postgresql.org> | 2011-07-26 09:34:55 -0400 |
|---|---|---|
| committer | Robert Haas <rhaas@postgresql.org> | 2011-07-26 09:39:03 -0400 |
| commit | d94eb49634fff6abc72bed577269aa21fd9f01e9 (patch) | |
| tree | e7384f7843ae6642c9587c8797c1576d5df0a79b | |
| parent | 5c70cc890dfadb4579c8e96c4b27cce285e75cfc (diff) | |
Clarify which relkinds accept column comments.
Per discussion with Josh Kupershmidt.
| -rw-r--r-- | doc/src/sgml/ref/comment.sgml | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/src/sgml/ref/comment.sgml b/doc/src/sgml/ref/comment.sgml index ab12614f843..0b28d8eefc5 100644 --- a/doc/src/sgml/ref/comment.sgml +++ b/doc/src/sgml/ref/comment.sgml @@ -26,7 +26,7 @@ COMMENT ON AGGREGATE <replaceable class="PARAMETER">agg_name</replaceable> (<replaceable class="PARAMETER">agg_type</replaceable> [, ...] ) | CAST (<replaceable>source_type</replaceable> AS <replaceable>target_type</replaceable>) | COLLATION <replaceable class="PARAMETER">object_name</replaceable> | - COLUMN <replaceable class="PARAMETER">table_name</replaceable>.<replaceable class="PARAMETER">column_name</replaceable> | + COLUMN <replaceable class="PARAMETER">relation_name</replaceable>.<replaceable class="PARAMETER">column_name</replaceable> | CONSTRAINT <replaceable class="PARAMETER">constraint_name</replaceable> ON <replaceable class="PARAMETER">table_name</replaceable> | CONVERSION <replaceable class="PARAMETER">object_name</replaceable> | DATABASE <replaceable class="PARAMETER">object_name</replaceable> | @@ -98,7 +98,7 @@ COMMENT ON <variablelist> <varlistentry> <term><replaceable class="parameter">object_name</replaceable></term> - <term><replaceable class="parameter">table_name.column_name</replaceable></term> + <term><replaceable class="parameter">relation_name</replaceable>.<replaceable>column_name</replaceable></term> <term><replaceable class="parameter">agg_name</replaceable></term> <term><replaceable class="parameter">constraint_name</replaceable></term> <term><replaceable class="parameter">function_name</replaceable></term> @@ -111,6 +111,9 @@ COMMENT ON aggregates, collations, conversions, domains, foreign tables, functions, indexes, operators, operator classes, operator families, sequences, text search objects, types, and views can be schema-qualified. + When commenting on a column, + <replaceable class="parameter">relation_name</replaceable> must refer + to a table, view, composite types, or foreign table. </para> </listitem> </varlistentry> |