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

---