pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。
COMMENT — 给对象添加注释
COMMENT ON [ [ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ]object_name| COLUMNtable_name.column_name| AGGREGATEagg_nameagg_type| FUNCTIONfunc_name(arg1,arg2, ...)| OPERATORop(leftoperand_typerightoperand_type) | TRIGGERtrigger_nameONtable_name] IS'text'
object_name, table_name, column_name, agg_name, func_name, op, trigger_name要加注释的对象的名称。
text要添加的注释。
COMMENT表成功加上注释时返回的消息。
COMMENT 给对象添加一条注释,注释可以用 psql 的 \dd 命令轻松检索。要移除一个注释,使用 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 float8 IS 'Computes sample variance'; COMMENT ON FUNCTION my_function (datetime) 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 中没有 COMMENT。
译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。