COMMENT ON SCHEMA
Adds, revises, or removes a comment on a schema. Each object can have one comment. Comments are stored in the system table COMMENTS
.
Syntax
COMMENT ON SCHEMA schema-name IS {'comment' | NULL}
Parameters
schema‑name
|
The schema associated with the comment. |
comment
|
Text of the comment to add. If a comment already exists for this schema, the comment you enter here overwrites the previous comment. 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. |
NULL
|
Removes an existing comment. |
Privileges
Non-superuser: object owner
Examples
The following example adds a comment to the public
schema:
=> COMMENT ON SCHEMA public IS 'All users can access this schema';
The following example removes a comment from the public
schema.
=> COMMENT ON SCHEMA public IS NULL;