COMMENT ON ANALYTIC FUNCTION
添加、修订或移除分析函数的注释。每个对象可以有一条注释。注释存储在系统表
COMMENTS
中。
语法
COMMENT ON ANALYTIC FUNCTION [[database.]schema.]function (function‑args) IS { 'comment' | NULL };
参数
-
[database.]schema
数据库和架构。默认架构为
public
。如果指定一个数据库,它必须是当前数据库。function
- 要与注释相关联的分析函数的名称。
function‑args
- 函数实参。
comment
- 指定要添加的注释文本。如果此函数已存在注释,则此注释将覆盖之前的注释。
注释的长度最多为 8192 个字符。如果注释超出此限制,Vertica 将截断注释并通过消息提醒用户。
NULL
- 移除现有注释。
特权
非超级用户:对象所有者
示例
以下示例向用户定义的 an_rank()
函数添加了一条注释:
=> COMMENT ON ANALYTIC FUNCTION an_rank() IS 'built from the AnalyticFunctions library';
以下示例从用户定义的 an_rank()
函数中移除了一条注释:
=> COMMENT ON ANALYTIC FUNCTION an_rank() IS NULL;