PostgreSQL 7.3 文档

文档 → PostgreSQL 7.3

受支持版本：当前版本 (18) / 17 / 16 / 15 / 14

测试与开发版本： 19 / devel

不受支持的版本： 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.3 已于 2007 年 11 月结束社区维护，本页译文保留供仍在使用旧版本的读者参考。新系统请看当前版本。

COMMENT
上一页	上一级	SQL 命令	起始页	下一页

COMMENT

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'

输入

object_name, table_name.column_name, agg_name, constraint_name, func_name, op, rule_name, trigger_name: 要加注释的对象的名称。表、聚合、域、函数、索引、操作符、序列、类型和视图的名称可以带模式限定。
text: 要添加的注释。

输出

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

描述

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

要修改一个注释，可以对同一对象发出一条新的COMMENT命令。每个对象只存储一个注释字符串。要移除一个注释，用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 COLUMN my_table.my_field 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 R.I.';
COMMENT ON TYPE complex IS 'Complex Number datatype';
COMMENT ON VIEW my_view IS 'View of departmental costs';

兼容性

SQL92

SQL92 中没有 COMMENT。

上一页	上一级	下一页
CLUSTER	起始页	COMMIT

提交更正

译文有误、术语不当或页面显示问题，请到译文仓库 pgsty/pgdoc 报告译文问题。英文原文本身的问题，请在当前版本的对应页面向上游反馈；上游不再修订已结束维护的版本。