mirror/postgresql
2
0
Fork 0
mirror of https://git.postgresql.org/git/postgresql.git synced 2025-02-05 19:09:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clarify which relkinds accept column comments.

Browse Source 
Per discussion with Josh Kupershmidt.
This commit is contained in:
Robert Haas 2011-07-26 09:34:55 -04:00
parent 65c033cbe9
commit 6f8f9c2bdd
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/src/sgml/ref/comment.sgml
View File

@ -24,9 +24,9 @@ PostgreSQL documentation
COMMENT ON COMMENT ON
{ {
TABLE <replaceable class="PARAMETER">object_name</replaceable> | 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> [, ...] ) | AGGREGATE <replaceable class="PARAMETER">agg_name</replaceable> (<replaceable class="PARAMETER">agg_type</replaceable> [, ...] ) |
CAST (<replaceable>source_type</replaceable> AS <replaceable>target_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> | CONSTRAINT <replaceable class="PARAMETER">constraint_name</replaceable> ON <replaceable class="PARAMETER">table_name</replaceable> |
CONVERSION <replaceable class="PARAMETER">object_name</replaceable> | CONVERSION <replaceable class="PARAMETER">object_name</replaceable> |
DATABASE <replaceable class="PARAMETER">object_name</replaceable> | DATABASE <replaceable class="PARAMETER">object_name</replaceable> |
@ -86,7 +86,7 @@ COMMENT ON
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><replaceable class="parameter">object_name</replaceable></term> <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">agg_name</replaceable></term>
<term><replaceable class="parameter">constraint_name</replaceable></term> <term><replaceable class="parameter">constraint_name</replaceable></term>
<term><replaceable class="parameter">function_name</replaceable></term> <term><replaceable class="parameter">function_name</replaceable></term>
@ -99,6 +99,9 @@ COMMENT ON
aggregates, domains, functions, indexes, operators, operator classes, aggregates, domains, functions, indexes, operators, operator classes,
operator families, sequences, text search objects, types, and views can operator families, sequences, text search objects, types, and views can
be schema-qualified. be schema-qualified.
When commenting on a column,
<replaceable class="parameter">relation_name</replaceable> must refer
to a table, view, or composite types.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>