COMMENT
功能描述
定义或修改一个对象的注释。
注意事项
- 每个对象只存储一条注释,因此要修改一个注释,对同一个对象发出一条新的COMMENT命令即可。要删除注释,在文本字符串的位置写上NULL即可。当删除对象时,注释自动被删除掉。
- 目前注释浏览没有安全机制:任何连接到某数据库上的用户都可以看到所有该数据库对象的注释。共享对象(比如数据库、角色、表空间)的注释是全局存储的,连接到任何数据库的任何用户都可以看到它们。因此,不要在注释里存放与安全有关的敏感信息。
- 对大多数对象,只有对象的所有者或者被授予了对象COMMENT权限的用户可以设置注释,系统管理员默认拥有该权限。
- 角色没有所有者,所以COMMENT ON ROLE命令仅可以由系统管理员对系统管理员角色执行,有CREATEROLE权限的角色也可以为非系统管理员角色设置注释。系统管理员可以对所有对象进行注释。
语法格式
COMMENT ON { AGGREGATE agg_name (agg_type [, ...] ) | CAST (source_type AS target_type) | COLLATION object_name | COLUMN { table_name.column_name | view_name.column_name } | CONSTRAINT constraint_name ON table_name | CONVERSION object_name | DATABASE object_name | DOMAIN object_name | EXTENSION object_name | FOREIGN DATA WRAPPER object_name | FOREIGN TABLE object_name | FUNCTION function_name ( [ {[ argname ] [ argmode ] argtype} [, ...] ] ) | INDEX object_name | LARGE OBJECT large_object_oid | OPERATOR operator_name (left_type, right_type) | OPERATOR CLASS object_name USING index_method | OPERATOR FAMILY object_name USING index_method | [ PROCEDURAL ] LANGUAGE object_name | ROLE object_name | SCHEMA object_name | SERVER object_name | TABLE object_name | TABLESPACE object_name | TEXT SEARCH CONFIGURATION object_name | TEXT SEARCH DICTIONARY object_name | TEXT SEARCH PARSER object_name | TEXT SEARCH TEMPLATE object_name | TYPE object_name | VIEW object_name | TRIGGER trigger_name ON table_name } IS 'text';
参数说明
- agg_name
聚集函数的名称。
- agg_type
聚集函数参数的类型。
- source_type
类型转换的源数据类型。
- target_type
类型转换的目标数据类型。
- object_name
对象名(EXTENSION相关功能详见《实验室特性说明》)。
- table_name.column_name
view_name.column_name
列名称。前缀可加表名称或者视图名称。
- constraint_name
表约束的名称。
- table_name
表的名称。
- function_name
函数名称。
- argname,argmode,argtype
函数参数的名称、模式、类型。
- large_object_oid
大对象的OID。
- operator_name
操作符名称。
- left_type,right_type
操作参数的数据类型(可以用模式修饰)。当前置或者后置操作符不存在时,可以增加NONE选项。
- trigger_name
触发器名称。
- text
注释。
示例
--创建SCHEMA。 openGauss=# CREATE SCHEMA tpcds; --创建表tpcds.customer。 openGauss=# CREATE TABLE tpcds.customer ( c_customer_sk INTEGER NOT NULL, c_customer_id CHAR(16) NOT NULL ); --向表中插入多条记录。 openGauss=# INSERT INTO tpcds.customer VALUES (50, 'AAAAAAAABAAAAAAA'),(100, 'AAAAAAAACAAAAAAA'),(150, 'AAAAAAAADAAAAAAA'); --创建表tpcds.customer_demographics_t2。 openGauss=# CREATE TABLE tpcds.customer_demographics_t2 ( CD_DEMO_SK INTEGER NOT NULL, CD_GENDER CHAR(1) , CD_MARITAL_STATUS CHAR(1) , CD_EDUCATION_STATUS CHAR(20) , CD_PURCHASE_ESTIMATE INTEGER , CD_CREDIT_RATING CHAR(10) , CD_DEP_COUNT INTEGER , CD_DEP_EMPLOYED_COUNT INTEGER , CD_DEP_COLLEGE_COUNT INTEGER ) ; -- 为tpcds.customer_demographics_t2.cd_demo_sk列加注释。 openGauss=# COMMENT ON COLUMN tpcds.customer_demographics_t2.cd_demo_sk IS 'Primary key of customer demographics table.'; --创建一个由c_customer_sk小于150的内容组成的视图。 openGauss=# CREATE VIEW tpcds.customer_details_view_v2 AS SELECT * FROM tpcds.customer WHERE c_customer_sk < 150; -- 为tpcds.customer_details_view_v2视图加注释。 openGauss=# COMMENT ON VIEW tpcds.customer_details_view_v2 IS 'View of customer detail'; -- 删除view。 openGauss=# DROP VIEW tpcds.customer_details_view_v2; -- 删除tpcds.customer_demographics_t2。 openGauss=# DROP TABLE tpcds.customer_demographics_t2; --删除表tpcds.customer。 openGauss=# DROP TABLE tpcds.customer; --删除SCHEMA。 openGauss=# DROP SCHEMA tpcds CASCADE;