↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发中的版本: 19 / 20devel
已结束支持的版本: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3 / 7.2 / 7.1 / 7.0
历史版本。 PostgreSQL 7.2 已结束支持。 请参阅 当前版本手册.

COMMENT

COMMENT — 定义或更改对象的注释

大纲

COMMENT ON
[
  [ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ] object_name |
  COLUMN table_name.column_name |
  AGGREGATE agg_name (agg_type) |
  FUNCTION func_name (arg1, arg2, ...) |
  OPERATOR op (leftoperand_type rightoperand_type) |
  TRIGGER trigger_name ON table_name
] IS 'text'
  

输入

object_name, table_name, column_name, agg_name, func_name, op, trigger_name

要加注释的对象的名称。

text

要添加的注释。

输出

COMMENT

表成功加上注释时返回的消息。

描述

COMMENT 存储关于某个数据库对象的注释。注释可以用 psql 的 \dd、\d+ 或 \l+ 命令轻松检索。其他检索注释的用户界面可以构建在 psql 所用的相同内置函数之上,即 obj_description() 和 col_description()。

要修改一个注释,可以对同一对象发出一条新的COMMENT命令。每个对象只存储一个注释字符串。要移除一个注释,用NULL代替文本字符串。对象被删除时,其注释也会被自动删除。

目前注释没有任何安全机制:任何连接到数据库的用户都能看到该数据库中对象的全部注释(不过只有超级用户才能修改他们不拥有的对象的注释)。因此,不要把安全攸关的信息放在注释里。

用法

给表 mytable 加注释:

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

更多示例:

COMMENT ON DATABASE my_database IS 'Development Database';
COMMENT ON INDEX my_index IS 'Enforces uniqueness on employee id';
COMMENT ON RULE my_rule IS 'Logs UPDATES of employee records';
COMMENT ON SEQUENCE my_sequence IS 'Used to generate primary keys';
COMMENT ON TABLE my_table IS 'Employee Information';
COMMENT ON TYPE my_type IS 'Complex Number support';
COMMENT ON VIEW my_view IS 'View of departmental costs';
COMMENT ON COLUMN my_table.my_field IS 'Employee ID number';
COMMENT ON AGGREGATE my_aggregate (double precision) IS 'Computes sample variance';
COMMENT ON FUNCTION my_function (timestamp) IS 'Returns Roman Numeral';
COMMENT ON OPERATOR ^ (text, text) IS 'Performs intersection of two text';
COMMENT ON TRIGGER my_trigger ON my_table IS 'Used for R.I.';
   

兼容性

SQL92

SQL92 中没有 COMMENT。

报告文档问题

阅读 上游文档. 反馈更正前请先核对 当前版本手册.