COMMENT ON

您可以使用 COMMENT ON 命令在 RisingWave 中对表或列添加注释。注释以元数据的形式存储在表或列中。

如果要删除表或列上的现有注释，请使用 NULL 重写当前注释。

句法

COMMENT ON <object_type> <relation_name>.<object_name> IS <comment>

参数

参数	注意事项
object_type	要添加注释的对象类型。允许的值：TABLE、COLUMN。
relation_name.object_name	要添加注释的对象名称。对于列，还需要指定表名称。
comment	要添加的注释。

示例

在表上添加注释：

COMMENT ON TABLE t1 IS 'table to store traffic data';

在列上添加注释：

COMMENT ON COLUMN t1.v1 IS 'column for the duration of the trip';

删除表上的注释：

COMMENT ON table t1 IS NULL;

向表或列添加注释后，可以通过以下方式显示注释：

1. 使用 rw_description 表:

SELECT * FROM rw_description;
------
 objoid | classoid | objsubid |             description             
--------+----------+----------+-------------------------------------
   1001 |       41 |          | table to store traffic data
   1001 |       41 |        1 | column for the duration of the trip
   1001 |       41 |        2 | 
   1001 |       41 |        0 | 

2. 使用 SHOW COLUMNS 或 DESCRIBE 命令：

SHOW COLUMNS FROM t1;

DESCRIBE t1;

相关内容

• DESCRIBE