COMMENT ON VIEW
Adds, revises, or removes a comment on a view. Each object can have one comment. Comments are stored in the system table COMMENTS
.
Syntax
COMMENT ON VIEW [schema.]view‑name IS { 'comment' | NULL }
Parameters
schema |
Specifies a schema. If multiple schemas are defined in the database, include the schema name. For example: myschema.thisDbObject |
view‑name |
The name of the view with which to associate the comment. |
comment |
Specifies the text of the comment to add. If a comment already exists for this view, 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. Enclose a blank value in single quotes to remove an existing comment. |
NULL |
Removes an existing comment. |
Privileges
- Superuser: View and add comments to all objects.
- Object owner: Add or edit comments for the object.
- User: VIEW privileges on an object to view its comments.
Examples
The following example adds a comment to a view called curr_month_ship:
=> COMMENT ON VIEW curr_month_ship IS 'Shipping data for the current month';
The following example removes a comment from the curr_month_ship
view:
=> COMMENT ON VIEW curr_month_ship IS NULL;