COMMENT

Inserts or replaces a comment string on a database object.

 

where routine-specification is:

 

Usage

Embedded, Interactive, Module, ODBC, JDBC.

Description

The comment string for the specified object is stored in the data dictionary. Any previously defined comment for the object is replaced by the new.

Restrictions

A comment can only be stored by the creator of the object.

Notes

A comment string may have a maximum length of 254 characters, and must be enclosed in string delimiters.

Comments may not be altered or dropped directly. However, since the COMMENT statement replaces any existing comment with the new text, a comment may be altered simply by issuing a new COMMENT statement. A comment may be effectively dropped by issuing a COMMENT statement with an empty string.

When a comment is written for a column, the column name must be qualified by a table-name or a view-name in the form table-name.column-name or view-name.column-name.

Example

COMMENT ON TABLE countries IS 'All countries we ship to';

Standard Compliance