Provided by: manpages-zh_1.5.2-1_all bug

NAME

       COMMENT - 定义或者改变一个对象的评注

SYNOPSIS

       COMMENT ON
       {
         TABLE object_name |
         COLUMN table_name.column_name |
         AGGREGATE agg_name (agg_type) |
         CONSTRAINT constraint_name ON table_name |
         DATABASE object_name |
         DOMAIN object_name |
         FUNCTION func_name (arg1_type, arg2_type, ...) |
         INDEX object_name |
         OPERATOR op (leftoperand_type, rightoperand_type) |
         RULE rule_name ON table_name |
         SCHEMA object_name |
         SEQUENCE object_name |
         TRIGGER trigger_name ON table_name |
         TYPE object_name |
         VIEW object_name
       } IS 'text'

DESCRIPTION 描述

       COMMENT   存储一个数据库对象的评注,   这个评注可以很容易用  psql  的  \dd,  \d+,  和  \l+
       命令检索出来。 其它检索评注的用户接口可以建设在 psql 所用地同样地内部函数的基础上, 也就是
       obj_description() 和 col_description()。

        要修改一个评注,为同一个对象发出一条新的    COMMENT    命令即可。每个对象只存储一条评注。
       要删除评注,在文本字串的位置写上 NULL。 当删除对象时,评注自动被删除掉。

PARAMETERS 参数

       object_name

       table_name.column_name

       aggname

       constraint_name

       func_name

       op

       rule_name

       trigger_name
               要加入评注的对象名称。表,索引,序列,视图,类型,域,函数,
              聚集和操作符的名字可以是模式修饰的。

       agg_type
              聚集函数的参数类型,如果函数接受任意数据类型,那么是 *。

       large_object_oid
              大对象的 OID。

       PROCEDURAL
              这个字无用。

       sourcetype
              类型转换的源数据类型名字。

       targettype
              类型转换的目的数据类型名字。

       text   新的评注。

NOTES 注意

        一个数据库里的评注只能在改数据库里创建,并且只有在那个数据库里可见,其它库里不可见。

        需要说明的是目前评注没有安全机制:任何联接到某数据库上的用户都可以看到所有该数据库对象的评注
       (尽管只有超级用户可以修改不属于他的对象的评注)。因此,不要在评注里放安全性敏感地信息。

EXAMPLES 例子

        给表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 COLUMN my_table.my_column IS 'Employee ID number';
       COMMENT ON DATABASE my_database IS 'Development Database';
       COMMENT ON DOMAIN my_domain IS 'Email Address Domain';
       COMMENT ON FUNCTION my_function (timestamp) IS 'Returns Roman Numeral';
       COMMENT ON INDEX my_index IS 'Enforces uniqueness on employee ID';
       COMMENT ON OPERATOR ^ (text, text) IS 'Performs intersection of two texts';
       COMMENT ON OPERATOR ^ (NONE, text) IS 'This is a prefix operator on text';
       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 TABLE my_schema.my_table IS 'Employee Information';
       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';

COMPATIBILITY 兼容性

       SQL 标准里没有COMMENT。

译者

       Postgresql 中文网站 何伟平 <laser@pgsqldb.org>