Vertica Analytics Platform Version 9.2.x Documentation

COMMENT ON FUNCTION

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

Syntax

COMMENT ON FUNCTION [[database.]schema.]function (function‑args) 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.

function

The name of the function with which to associate the comment.

function‑args

The function arguments.

comment

Specifies the comment text to add. If a comment already exists for this function, this 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 macros.zerowhennull (x INT) function:

=> COMMENT ON FUNCTION macros.zerowhennull(x INT) IS 'Returns a 0 if not NULL';

The following examples remove a comment from the macros.zerowhennull (x INT) function in two ways by using the NULL option, or specifying a blank string:

=> COMMENT ON FUNCTION macros.zerowhennull(x INT) IS NULL;
=> COMMENT ON FUNCTION macros.zerowhennull(x INT) IS '';