pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。
COMMENT — 定义或修改对象的注释
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'
COMMENT 存储关于某个数据库对象的注释。注释可以用 psql 的命令 \dd、\d+ 和 \l+ 轻松检索。其他检索注释的用户界面可以构建在 psql 所用的相同内置函数之上,即 obj_description 和 col_description。
要修改一个注释,可以对同一对象发出一条新的COMMENT命令。每个对象只存储一个注释字符串。要移除一个注释,用NULL代替文本字符串。对象被删除时,其注释也会被自动删除。
object_nametable_name.column_nameaggnameconstraint_namefunc_nameoprule_nametrigger_name要加注释的对象的名称。表、聚合、域、函数、索引、操作符、序列、类型和视图的名称可以带模式限定。
text新的注释。
目前注释没有任何安全机制:任何连接到数据库的用户都能看到该数据库中对象的全部注释(不过只有超级用户才能修改他们不拥有的对象的注释)。因此,不要把安全攸关的信息放在注释里。
为表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';
SQL 标准中没有COMMENT命令。
译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。