COMMENT

COMMENT¶

定义或更改对象的注释。

语法

sql
COMMENT ON
{ TABLE object_name |
  COLUMN relation_name.column_name |
  AGGREGATE agg_name (agg_type [, ...]) |
  CAST (source_type AS target_type) |
  COLLATION object_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 func_name ([[argmode] [argname] argtype [, ...]]) |
  INDEX object_name |
  LARGE OBJECT large_object_oid |
  OPERATOR operator_name (left_type, right_type) |
  OPERATOR CLASS object_name USING index_method |
  [PROCEDURAL] LANGUAGE object_name |
  RESOURCE GROUP object_name |
  ROLE object_name |
  RULE rule_name ON table_name |
  SCHEMA object_name |
  SEQUENCE object_name |
  SERVER object_name |
  TABLESPACE object_name |
  TRIGGER trigger_name ON table_name |
  TYPE object_name |
  VIEW object_name }
IS 'text'

描述

COMMENT存储有关数据库对象的注释。每个对象仅存储一个注释字符串。要删除注释，请在文本字符串的位置写入NULL。

删除对象时，注释将自动删除。

对于大多数对象，只有对象的所有者才能设置注释。角色没有所有者，因此COMMENT ON ROLE的规则必须是超级用户才能对超级用户角色进行注释，或者具有CREATEROLE权限才能对非超级用户角色添加注释。当然，超级用户可以对任何对象添加注释。

使用ssql元命令\dd，\d+和\l+可以轻松提取注释。

可以在ssql使用的相同内置函数（即obj_description，col_description和shobj_description）之上构建其他用于提取注释的用户界面。

参数

该SQL命令参数说明见下

要注释的对象的名称。表，聚合，排序规则，转换，域，外部表，函数，索引，运算符，运算符类，运算符族，序列，文本搜索对象，类型和视图的名称可以通过模式指定。

在对列进行注释时，relation_name必须引用表，视图，组合类型或外部表。

aggregate_type

聚合函数所基于的输入数据类型。要引用零参数聚合函数，请写*代替输入数据类型列表。

source_type

强制转换的源数据类型的名称。

target_type

强制转换的目标数据类型的名称。

argmode

函数参数的模式：IN，OUT，INOUT或VARIADIC。如果省略，则默认值为IN。

注意，由于仅需要输入参数来确定函数的标识，因此COMMENT ON FUNCTION实际上并不对OUT参数给予任何关注。因此，列出IN，INOUT和VARIADIC参数就足够了。

argname

函数参数的名称。请注意，COMMENT ON FUNCTION实际上并不关注参数名称，因为仅需要参数数据类型来确定函数的身份。

argtype

函数参数的数据类型（可以由模式指定）（如果有）。

large_object_oid

大对象的OID。

left_type | right_type

运算符参数的数据类型（可以由模式指定）。为前缀或后缀运算符的缺少参数写NONE。

PROCEDURAL

这是一个干扰词。

text

新注释，以字符串文字形式表示；或NULL以删除注释。

注解

当前没有用于查看注释的安全机制：连接到数据库的任何用户都可以查看该数据库中对象的所有注释。对于共享对象，例如数据库，角色和表空间，注释是全局存储的，因此连接到集群中任何数据库的任何用户都可以查看共享对象的所有注释。因此，请勿在评论中添加对安全性至关重要的信息。

示例

在表mytable上添加注释：

COMMENT ON TABLE mytable IS 'This is my table.';

再次删除：

COMMENT ON TABLE mytable IS NULL;

其他示例：

COMMENT ON AGGREGATE my_aggregate (double precision) IS 'Computes sample variance';
COMMENT ON CAST (text AS int4) IS 'Allow casts from text to int4';
COMMENT ON COLLATION "fr_CA" IS 'Canadian French';
COMMENT ON COLUMN my_table.my_column IS 'Employee ID number';
COMMENT ON CONVERSION my_conv IS 'Conversion to UTF8';
COMMENT ON CONSTRAINT bar_col_cons ON bar IS 'Constrains column col';
COMMENT ON DATABASE my_database IS 'Development Database';
COMMENT ON DOMAIN my_domain IS 'Email Address Domain';
COMMENT ON EXTENSION hstore IS 'implements the hstore data type';
COMMENT ON FOREIGN DATA WRAPPER mywrapper IS 'my foreign data wrapper';
COMMENT ON FOREIGN TABLE my_foreign_table IS 'Employee Information in other database';
COMMENT ON FUNCTION my_function (timestamp) IS 'Returns Roman Numeral';
COMMENT ON INDEX my_index IS 'Enforces uniqueness on employee ID';
COMMENT ON LANGUAGE plpython IS 'Python support for stored procedures';
COMMENT ON LARGE OBJECT 346344 IS 'Planning document';
COMMENT ON OPERATOR ^ (text, text) IS 'Performs intersection of two texts';
COMMENT ON OPERATOR - (NONE, integer) IS 'Unary minus';
COMMENT ON OPERATOR CLASS int4ops USING btree IS '4 byte integer operators for btrees';
COMMENT ON OPERATOR FAMILY integer_ops USING btree IS 'all integer operators for btrees';
COMMENT ON ROLE my_role IS 'Administration group for finance tables';
COMMENT ON RULE my_rule ON my_table IS 'Logs updates of employee records';
COMMENT ON SCHEMA my_schema IS 'Departmental data';
COMMENT ON SEQUENCE my_sequence IS 'Used to generate primary keys';
COMMENT ON SERVER myserver IS 'my foreign server';
COMMENT ON TABLE my_schema.my_table IS 'Employee Information';
COMMENT ON TABLESPACE my_tablespace IS 'Tablespace for indexes';
COMMENT ON TEXT SEARCH CONFIGURATION my_config IS 'Special word filtering';
COMMENT ON TEXT SEARCH DICTIONARY swedish IS 'Snowball stemmer for Swedish language';
COMMENT ON TEXT SEARCH PARSER my_parser IS 'Splits text into words';
COMMENT ON TEXT SEARCH TEMPLATE snowball IS 'Snowball stemmer';
COMMENT ON TRIGGER my_trigger ON my_table IS 'Used for RI';
COMMENT ON TYPE complex IS 'Complex number data type';
COMMENT ON VIEW my_view IS 'View of departmental costs';

兼容性说明

SQL标准中没有COMMENT语句。