Amazon Redshift
数据库开发人员指南 (API 版本 2012-12-01)
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

COMMENT

创建或更改有关数据库对象的注释。

语法

COMMENT ON { TABLE object_name | COLUMN object_name.column_name | CONSTRAINT constraint_name ON table_name | DATABASE object_name | VIEW object_name } IS 'text'

参数

object_name

要添加注释的数据库对象的名称。您可以将注释添加到以下对象:

  • TABLE

  • COLUMN(还接受 column_name)。

  • CONSTRAINT(还接受 constraint_nametable_name)。

  • DATABASE

  • VIEW

IS 'text''

要应用于指定对象的注释文本。将注释放在单引号内。

column_name

要添加注释的列的名称。COLUMN 的参数。跟随在 object_name 中指定的表后面。

constraint_name

要添加注释的约束的名称。CONSTRAINT 的参数。

table_name

包含约束的表的名称。CONSTRAINT 的参数。

arg1_type, arg2_type, ...

某个函数的参数的数据类型。FUNCTION 的参数。

使用说明

数据库的注释只能应用于当前数据库。如果您尝试对不同的数据库添加注释,则会显示警告消息。对不存在的数据库添加注释时,会显示同一警告。

示例

以下示例将描述性注释添加到 EVENT 表:

comment on table event is 'Contains listings of individual events.';

要查看注释,请查询 PG_DESCRIPTION 系统目录。以下示例返回 EVENT 表的描述。

select * from pg_catalog.pg_description where objoid = (select oid from pg_class where relname = 'event' and relnamespace = (select oid from pg_catalog.pg_namespace where nspname = 'public') ); objoid | classoid | objsubid | description -------+----------+----------+---------------------------------------- 116658 | 1259 | 0 | Contains listings of individual events.

以下示例使用 \dd 命令查看注释。Amazon Redshift 并不直接支持 psql。您必须从 PostgreSQL psql 客户端执行 psql 命令。

注意

\dd 命令仅返回使用 psql 8.x 版本的评论。

\dd event Object descriptions schema | name | object | description --------+-------+--------+----------------------------------------- public | event | table | Contains listings of individual events. (1 row)

本页内容: