Comment
Adds a comment to an object within the database.
Synopsis
COMMENT ON [ [ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ] object_name | COLUMN table_name.column_name | FUNCTION func_name ( argument [, ...] ) | AGGREGATE aggr_func aggr_type | OPERATOR operator ( left_type , right_type ) | TRIGGER trigger_name ON table_name ] IS 'text'
Parameters
DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW
The type of database object that you are adding a comment to.
object_name
The name of the object (
database
,index
,rule
,sequence
,table
,type
, orview
) to which you are adding a comment.COLUMN
table_name.column_name
The complete column name (within the table
table_name
) you are adding a comment to.FUNCTION
func_name
(
argument
[, ...] )
The name of the function on which you are commenting, specified also by the
argument
data types that it accepts.AGGREGATE
aggr_func aggr_type
The aggregate function name (and associated data type
aggr_type
, which it accepts) to which you are adding a comment.OPERATOR
operator ( left_type, right_type )
The name of the operator on which you are commenting (
operator
), further described by the data type it operates on to the left, and the data type it operates on to the right, separated by a comma, enclosed within parentheses. If either side is inapplicable, theNONE
keyword may be used.TRIGGER
trigger_name ON table_name
The name of the trigger on which you are placing a comment, and the name of the table upon which the trigger is placed.
text
The actual ...
Get Practical PostgreSQL now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.