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