COMMENT ON LIBRARY

Adds, revises, or removes a comment on a library . Each object can have one comment. Comments are stored in the system table COMMENTS.

Syntax

COMMENT ON LIBRARY [ schema.]library-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
library-name

The name of the library associated with the comment.

comment

Specifies the comment text to add. If a comment already exists for this library, 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 within single quotes to remove an existing comment.

NULL

Removes an existing comment.

Privileges

Examples

The following example adds a comment to the library MyFunctions:

=> COMMENT ON LIBRARY MyFunctions IS 'In development';

The following examples remove a comment from the library MyFunctions:

=> COMMENT ON LIBRARY MyFunctions IS NULL;
=> COMMENT ON LIBRARY MyFunctions IS '';

See Also