COMMENT(7)

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