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:38:33 -0400 |
| commit | 6f8f9c2bdd30eef9c3f1858fb413f5f4e39d6010 (patch) | |
| tree | e4e7cc2ae002db71ad6af096d9ea381e4b65be73 | |
| parent | 65c033cbe913972872a10b17deae636243ae96df (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 53c6b0fcbc9..838f43fcbd5 100644 --- a/doc/src/sgml/ref/comment.sgml +++ b/doc/src/sgml/ref/comment.sgml @@ -24,9 +24,9 @@ PostgreSQL documentation COMMENT ON { TABLE <replaceable class="PARAMETER">object_name</replaceable> | - COLUMN <replaceable class="PARAMETER">table_name</replaceable>.<replaceable class="PARAMETER">column_name</replaceable> | AGGREGATE <replaceable class="PARAMETER">agg_name</replaceable> (<replaceable class="PARAMETER">agg_type</replaceable> [, ...] ) | CAST (<replaceable>source_type</replaceable> AS <replaceable>target_type</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> | @@ -86,7 +86,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> @@ -99,6 +99,9 @@ COMMENT ON aggregates, domains, 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, or composite types. </para> </listitem> </varlistentry> |