Vertica Analytics Platform Version 9.2.x Documentation

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 [[database.]schema.]library IS {'comment' | NULL}

Parameters

[database.]schema

Specifies a schema, by default public. If schema is any schema other than public, you must supply the schema name. For example:

myschema.thisDbObject

If you specify a database, it must be the current database.

library

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

Superuser or object owner

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