COMMENT
功能描述
定义或修改一个对象的注释。
注意事项
- 每个对象只存储一条注释，因此要修改一个注释，对同一个对象发出一条新的COMMENT命令即可。要删除注释，在文本字符串的位置写上NULL即可。当删除对象时，注释自动被删除掉。
- 目前注释浏览没有安全机制：任何连接到某数据库上的用户都可以看到所有该数据库对象的注释。共享对象（比如数据库、角色、表空间）的注释是全局存储的，连接到任何数据库的任何用户都可以看到它们。因此，不要在注释里存放与安全有关的敏感信息。
- 对大多数对象，只有对象的所有者或者被授予了对象COMMENT权限的用户可以设置注释，系统管理员默认拥有该权限。
- 角色没有所有者，所以COMMENT ON ROLE命令仅可以由系统管理员对系统管理员角色执行，有CREATE ROLE权限的角色也可以为非系统管理员角色设置注释。系统管理员可以对所有对象进行注释。
- Vastbase G100 V2.2 Build 12开始支持存储和查询创建视图的注释内容。
语法格式
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 |
SEQUENCE 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
对象名。
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
注释。
示例
1、创建测试表。
CREATE TABLE 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
)
WITH (ORIENTATION = COLUMN,COMPRESSION=MIDDLE) ;
2、为customer_demographics_t2.cd_demo_sk列加注释。
COMMENT ON COLUMN customer_demographics_t2.cd_demo_sk IS 'Primary key of customer demographics table.';
3、查看表结构，包含注释信息。
\d+ customer_demographics_t2
返回结果为：
Table "public.customer_demographics_t2"
Column | Type | Modifiers | Storage | Stats target | Description
-----------------------+---------------+-----------+----------+--------------+---------------------------------------------
cd_demo_sk | integer | not null | plain | | Primary key of customer demographics table.
cd_gender | character(1) | | extended | |
cd_marital_status | character(1) | | extended | |
cd_education_status | character(20) | | extended | |
cd_purchase_estimate | integer | | plain | |
cd_credit_rating | character(10) | | extended | |
cd_dep_count | integer | | plain | |
cd_dep_employed_count | integer | | plain | |
cd_dep_college_count | integer | | plain | |
Has OIDs: no
Options: orientation=column, compression=middle
4、创建一个视图。
CREATE VIEW customer_details_view_v2 AS
SELECT *
FROM customer_demographics_t2;
5、为customer_details_view_v2视图加注释。
COMMENT ON VIEW customer_details_view_v2 IS 'View of customer detail';
6、删除view和customer_demographics_t2。
DROP VIEW customer_details_view_v2;
DROP TABLE customer_demographics_t2;
