From b6d6cffa99be17ce92f2b37df3e57fe78918f18d Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Tue, 26 Oct 1999 03:48:58 +0000 Subject: Add documentation for comment. --- doc/src/sgml/ref/comment.sgml | 156 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 156 insertions(+) create mode 100644 doc/src/sgml/ref/comment.sgml (limited to 'doc/src') diff --git a/doc/src/sgml/ref/comment.sgml b/doc/src/sgml/ref/comment.sgml new file mode 100644 index 00000000000..69fe3e28738 --- /dev/null +++ b/doc/src/sgml/ref/comment.sgml @@ -0,0 +1,156 @@ + + + + + + COMMENT + + SQL - Language Statements + + + + COMMENT + + + Add comment to an object + + + + + 1999-07-20 + + +COMMENT ON +[ + [ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ] + object_name | + COLUMN table_name.column_name| + AGGREGATE agg_name agg_type| + FUNCTION func_name (arg1, arg2, ...)| + OPERATOR op (leftoperand_type rightoperand_type) | + TRIGGER trigger_name ON table_name +] IS 'text' + + + + + 1999-10-25 + + + Inputs + + + + + + object_name, table_name, + column_name, agg_name, func_name, op, trigger_name + + + The name of the object to be be commented. + + + + + text + + + The comment to add. + + + + + + + + + + 1998-09-08 + + + Outputs + + + + + + +COMMENT + + + + Message returned if the table is successfully commented. + + + + + + + + + + + 1998-10-25 + + + Description + + + COMMENT adds a comment to an object that can be + easily retrieved with psql's + \dd command. + To remove a comment, use ''. + + + + + + Usage + + + comment the table mytable: + + +COMMENT ON mytable IS 'This is my table.'; + + + + + + + Compatibility + + + + + 1998-09-08 + + + SQL92 + + + There is no COMMENT in SQL92. + + + + + + -- cgit v1.2.3