定义或更改对象的注释。

语法

COMMENT ON
{
  TABLE table_name |
  COLUMN table_name.column_name
} IS 'text'

说明

COMMENT 存储有关数据库对象的注释。要修改注释,请为同一个对象发布新的 COMMENT 命令。只能为每个对象存储一个注释字符串。要删除注释,请为 text 指定空字符串(两个连续的单引号,中间没有空格)。删除对象时将自动删除注释。

说明 当前没有针对注释的安全机制:连接到数据库的任何用户都可以查看该数据库中对象的所有注释。不要在注释中放置重要的安全信息。

参数

参数 说明
table_name 要加注释的表的名称。表名可能是 schema 限定的。
table_name.column_name 要加注释的 table_name 中的列的名称。表名可能是 schema 限定的。
text 新注释。

示例

将注释附加到表 emp:

COMMENT ON TABLE emp IS 'Current employee information';

将注释附加到emp表的empno列:

COMMENT ON COLUMN emp.empno IS 'Employee identification number';

删除这些注释:

COMMENT ON TABLE emp IS '';
COMMENT ON COLUMN emp.empno IS '';

查看emp表的注释:

\dt+ emp;

查看emp表中的列的注释:

\d+ emp;