COMMENT ON SEQUENCE
Adds, revises, or removes a comment on a sequence. Each object can have one comment. Comments are stored in the system table COMMENTS
.
Syntax
COMMENT ON SEQUENCE [[database.]schema.]sequence IS { 'comment' | NULL }
Parameters
[database.]schema
|
Specifies a schema, by default myschema.thisDbObject If you specify a database, it must be the current database. |
sequence
|
The name of the sequence associated with the comment. |
comment
|
Specifies the text of the comment to add. If a comment already exists for this sequence, this comment overwrites the previous one. Comments can be up to 8192 characters in length. If a comment exceeds that limitation, Vertica truncates the comment and alerts the user with a message. You can enclose a blank value within single quotes to remove an existing comment. |
NULL
|
Removes an existing comment. |
Privileges
Superuser or object owner
Examples
The following example adds a comment to the sequence called prom_seq.
=> COMMENT ON SEQUENCE prom_seq IS 'Promotion codes';
The following examples remove a comment from the prom_seq sequence.
=> COMMENT ON SEQUENCE prom_seq IS NULL; => COMMENT ON SEQUENCE prom_seq IS '';