COMMENT ON 语句

• 1: 有关约束的注释
• 2: 有关函数的注释
• 3: COMMENT ON AGGREGATE FUNCTION
• 4: COMMENT ON ANALYTIC FUNCTION
• 5: 有关库的注释
• 6: 有关节点的注释
• 7: COMMENT ON PROJECTION
• 8: COMMENT ON PROJECTION COLUMN
• 9: 有关架构的注释
• 10: 有关序列的注释
• 11: 有关表的注释
• 12: COMMENT ON TABLE COLUMN
• 13: 有关转换函数的注释
• 14: 有关视图的注释

1 - 有关约束的注释

添加、修订或移除有关约束的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON CONSTRAINT constraint ON [[database.]schema.]table IS ... {'comment' | NULL };

参数

约束

与注释相关联的约束的名称。

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

表

要与注释相关联的表约束的名称。

注释

指定要添加的注释文本。如果此约束已存在注释，则此注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向 promotion_dimension 表上的 constraint_x 约束添加了一条注释：

=> COMMENT ON CONSTRAINT constraint_x ON promotion_dimension IS 'Primary key';

以下示例从 promotion_dimension 表上的 constraint_x 约束中移除了一条注释：

=> COMMENT ON CONSTRAINT constraint_x ON promotion_dimension IS NULL;

2 - 有关函数的注释

添加、修订或移除有关函数的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON FUNCTION [[database.]schema.]function (function‑args) IS { 'comment' | NULL };

参数

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

function

要与注释相关联的函数的名称。

function‑args

函数实参。

comment

指定要添加的注释文本。如果此函数已存在注释，则此注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向 macros.zerowhennull (x INT) 函数添加了一条注释：

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

以下示例从 macros.zerowhennull (x INT) 函数中移除了一条注释：

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

3 - COMMENT ON AGGREGATE FUNCTION

添加、修订或移除聚合函数的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON AGGREGATE FUNCTION [[database.]schema.]function (function‑args) IS { 'comment' | NULL };

参数

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

function

要与注释相关联的聚合函数的名称。

function‑args

函数实参。

comment

指定要添加的注释文本。如果此函数已存在注释，则此注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向 APPROXIMATE_MEDIAN(x FLOAT) 函数添加了一条注释：

=> COMMENT ON AGGREGATE FUNCTION APPROXIMATE_MEDIAN(x FLOAT) IS 'alias of APPROXIMATE_PERCENTILE with 0.5 as its parameter';

以下示例从 APPROXIMATE_MEDIAN(x FLOAT) 函数中移除了一条注释：

=> COMMENT ON AGGREGATE FUNCTION APPROXIMATE_MEDIAN(x FLOAT) IS NULL;

4 - 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;

5 - 有关库的注释

添加、修订或移除有关库的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON LIBRARY [[database.]schema.]library IS {'comment' | NULL}

参数

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

库

与注释相关联的库的名称。

注释

指定要添加的注释文本。如果此库已存在注释，则此注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向库添加了一条注释 MyFunctions:

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

以下示例从库中移除了一条注释 MyFunctions:

=> COMMENT ON LIBRARY MyFunctions IS NULL;

另请参阅

• COMMENTS

6 - 有关节点的注释

添加、修订或移除有关节点的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

如果删除某个对象，将删除与该对象关联的所有注释。

语法

COMMENT ON NODE node‑name IS  { 'comment' | NULL }

参数

node‑name

与注释相关联的节点的名称。

注释

指定要添加的注释文本。如果此节点已存在注释，则此注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例为 initiator node 添加了一条注释：

=> COMMENT ON NODE initiator IS 'Initiator node';

以下示例从 initiator node 中移除了一条注释：

=> COMMENT ON NODE initiator IS NULL;

另请参阅

COMMENTS

7 - COMMENT ON PROJECTION

添加、修订或移除有关投影的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

如果删除某个对象，将删除与该对象关联的所有注释。

语法

COMMENT ON PROJECTION [[database.]schema.]projection IS { 'comment' | NULL }

参数

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

projection

与注释相关联的投影的名称。

注释

指定要添加的注释的文本。如果此投影已存在注释，则您在此处输入的注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向 customer_dimension_vmart_node01 投影添加了一条注释：

=> COMMENT ON PROJECTION customer_dimension_vmart_node01 IS 'Test data';

以下示例从 customer_dimension_vmart_node01 投影中移除了一条注释：

=> COMMENT ON PROJECTION customer_dimension_vmart_node01 IS NULL;

另请参阅

COMMENTS

8 - COMMENT ON PROJECTION COLUMN

添加、修订或移除投影列注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON COLUMN [[database.]schema.]projection.column IS {'comment' | NULL}

参数

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

projection.column

要与注释相关联的投影和列的名称。

注释

指定要添加的注释文本。如果此列已存在注释，则此注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向 customer_dimension 投影中的 customer_name 列添加了一条注释：

=> COMMENT ON COLUMN customer_dimension_vmart_node01.customer_name IS 'Last name only';

以下示例从 customer_dimension 投影中的 customer_name 列中移除了一条注释：

=> COMMENT ON COLUMN customer_dimension_vmart_node01.customer_name IS NULL;

9 - 有关架构的注释

添加、修订或移除有关架构的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON SCHEMA schema-name IS {'comment' | NULL}

参数

schema‑name

与注释相关联的架构。

注释

要添加的注释的文本。如果此架构已存在注释，则您在此处输入的注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向 public 架构添加了一条注释：

=> COMMENT ON SCHEMA public  IS 'All users can access this schema';

以下示例从 public 架构中移除了一条注释。

=> COMMENT ON SCHEMA public IS NULL;

10 - 有关序列的注释

添加、修订或移除有关序列的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON SEQUENCE [[database.]schema.]sequence IS { 'comment' | NULL }

参数

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

序列

与注释相关联的序列的名称。

注释

指定要添加的注释的文本。如果此序列已存在注释，则此注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向名为 prom_seq 的序列添加了一条注释。

=> COMMENT ON SEQUENCE prom_seq IS 'Promotion codes';

以下示例从 prom_seq 序列中移除了一条注释。

=> COMMENT ON SEQUENCE prom_seq IS NULL;

11 - 有关表的注释

添加、修订或移除有关表的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON TABLE [[database.]schema.]table IS { 'comment' | NULL }

参数

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

表

要与注释相关联的表的名称。

注释

指定要添加的注释的文本。注释的文本两边需要加上单引号。如果此表已存在注释，则您在此处输入的注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除之前添加的注释。

特权

非超级用户：对象所有者

示例

以下示例向 promotion_dimension 表添加了一条注释：

=> COMMENT ON TABLE promotion_dimension IS '2011 Promotions';

以下示例从 Promotion_dimension 表中移除了一条注释：

=> COMMENT ON TABLE promotion_dimension IS NULL;

12 - COMMENT ON TABLE COLUMN

添加、修订或移除表列注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON COLUMN [[database.]schema.]table.column IS {'comment' | NULL}

参数

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

table.column

要与注释相关联的表和列的名称。

注释

指定要添加的注释文本。如果此列已存在注释，则此注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向 store 架构的 store_sales_fact 表中的 transaction_time 列添加了一条注释：

=> COMMENT ON COLUMN store.store_sales_fact.transaction_time IS 'GMT';

以下示例从 store 架构的 store_sales_fact 表中的 transaction_time 列中移除了一条注释：

=> COMMENT ON COLUMN store.store_sales_fact.transaction_time IS NULL;

13 - 有关转换函数的注释

添加、修订或移除有关用户定义的转换函数的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON TRANSFORM FUNCTION [[database.]schema.]tfunction
...( [ tfunction-arg-name tfunction-arg-type ][,...] ) IS {'comment' | NULL}

参数

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

tfunction

要与注释相关联的转换函数的名称。

tfunction‑arg‑name tfunction‑arg‑type

一个或多个转换函数实参的名称和数据类型。如果您提供了参数名称和类型，则每种类型必须与用于创建原始转换函数的库中指定的类型相匹配。

注释

指定要添加的注释文本。如果此转换函数已存在注释，则此注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向 macros.zerowhennull (x INT) UTF 函数添加了一条注释：

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

以下示例使用 acros.zerowhennull (x INT)选项从 NULL 函数中移除了一条注释。

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

14 - 有关视图的注释

添加、修订或移除有关视图的注释。每个对象可以有一条注释。注释存储在系统表 COMMENTS 中。

语法

COMMENT ON VIEW [[database.]schema.]view IS { 'comment' | NULL }

参数

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

视图

要与注释相关联的视图的名称。

注释

指定要添加的注释的文本。如果此视图已存在注释，则此注释将覆盖之前的注释。

注释的长度最多为 8192 个字符。如果注释超出此限制，Vertica 将截断注释并通过消息提醒用户。

NULL

移除现有注释。

特权

非超级用户：对象所有者

示例

以下示例向 curr_month_ship 视图中添加了一条注释：

=> COMMENT ON VIEW curr_month_ship IS 'Shipping data for the current month';

以下示例从 curr_month_ship 视图中移除了一条注释：

=> COMMENT ON VIEW curr_month_ship IS NULL;