Man page - comment(7)

Manual

COMMENT

NAME
SYNOPSIS
DESCRIPTION 描 述
PARAMETERS 参 数
NOTES 注 意
EXAMPLES 例 子
COMPATIBILITY 兼 容 性
译 者
跋

---

NAME

COMMENT - 定 义 或 者 改 变 一 个 对 象 的 评 注

SYNOPSIS

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’

DESCRIPTION 描 述

COMMENT 存 储 一 个 数 据 库 对 象 的 评 注 ， 这 个 评 注 可 以 很 容 易 用 psql 的 \dd , \d+ , 和 \l+ 命 令 检 索 出 来 。 其 它 检 索 评 注 的 用 户 接 口 可 以 建 设 在 psql 所 用 地 同 样 地 内 部 函 数 的 基 础 上 ， 也 就 是 obj_description() 和 col_description()。

要 修 改 一 个 评 注 ， 为 同 一 个 对 象 发 出 一 条 新 的 COMMENT 命 令 即 可 。 每 个 对 象 只 存 储 一 条 评 注 。 要 删 除 评 注 ， 在 文 本 字 串 的 位 置 写 上 NULL。 当 删 除 对 象 时 ， 评 注 自 动 被 删 除 掉 。

PARAMETERS 参 数

object_name
table_name.column_name
aggname
constraint_name
func_name

op

rule_name
trigger_name

要 加 入 评 注 的 对 象 名 称 。 表 ， 索 引 ， 序 列 ， 视 图 ， 类 型 ， 域 ， 函 数 ， 聚 集 和 操 作 符 的 名 字 可 以 是 模 式 修 饰 的 。

agg_type

聚 集 函 数 的 参 数 类 型 ， 如 果 函 数 接 受 任 意 数 据 类 型 ， 那 么 是 *。

large_object_oid

大 对 象 的 OID。

PROCEDURAL

这 个 字 无 用 。

sourcetype

类 型 转 换 的 源 数 据 类 型 名 字 。

targettype

类 型 转 换 的 目 的 数 据 类 型 名 字 。

text

新 的 评 注 。

NOTES 注 意

一 个 数 据 库 里 的 评 注 只 能 在 改 数 据 库 里 创 建 ， 并 且 只 有 在 那 个 数 据 库 里 可 见 ， 其 它 库 里 不 可 见 。

需 要 说 明 的 是 目 前 评 注 没 有 安 全 机 制 ： 任 何 联 接 到 某 数 据 库 上 的 用 户 都 可 以 看 到 所 有 该 数 据 库 对 象 的 评 注 （ 尽 管 只 有 超 级 用 户 可 以 修 改 不 属 于 他 的 对 象 的 评 注 ） 。 因 此 ， 不 要 在 评 注 里 放 安 全 性 敏 感 地 信 息 。

EXAMPLES 例 子

给 表 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_column 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 RI’;
COMMENT ON TYPE complex IS ’Complex number data type’;
COMMENT ON VIEW my_view IS ’View of departmental costs’;

COMPATIBILITY 兼 容 性

SQL 标 准 里 没 有 COMMENT。

译 者

Postgresql 中 文 网 站 何 伟 平 <laser@pgsqldb.org>

跋

本 页 面 中 文 版 由 中 文 man 手 册 页 计 划 提 供 。
中 文 man 手 册 页 计 划 ： https://github.com/man-pages-zh/manpages-zh

---