Skip to content
Snippets Groups Projects
Commit c80be8a8 authored by Robert Haas's avatar Robert Haas
Browse files

Clarify which relkinds accept column comments.

Per discussion with Josh Kupershmidt.
parent c9737310
No related branches found
No related tags found
No related merge requests found
...@@ -26,7 +26,7 @@ COMMENT ON ...@@ -26,7 +26,7 @@ COMMENT ON
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>) |
COLLATION <replaceable class="PARAMETER">object_name</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> | 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> |
...@@ -98,7 +98,7 @@ COMMENT ON ...@@ -98,7 +98,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>
...@@ -111,6 +111,9 @@ COMMENT ON ...@@ -111,6 +111,9 @@ COMMENT ON
aggregates, collations, conversions, domains, foreign tables, functions, aggregates, collations, conversions, domains, foreign tables, functions,
indexes, operators, operator classes, operator families, sequences, indexes, operators, operator classes, operator families, sequences,
text search objects, types, and views can be schema-qualified. 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> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment