| PostgreSQL 8.0.0 中文文件（轉譯自 PostgreSQL 中國 製作的簡體中文版本） | ||||
|---|---|---|---|---|
| Prev | Fast Backward | Fast Forward | Next | |
COMMENT ON
{
TABLE object_name |
COLUMN table_name.column_name |
AGGREGATE agg_name (agg_type) |
CAST (sourcetype AS targettype) |
CONSTRAINT constraint_name ON table_name |
CONVERSION object_name |
DATABASE object_name |
DOMAIN object_name |
FUNCTION func_name (arg1_type, arg2_type, ...) |
INDEX object_name |
LARGE OBJECT large_object_oid |
OPERATOR op (leftoperand_type, rightoperand_type) |
OPERATOR CLASS object_name USING index_method |
[ PROCEDURAL ] LANGUAGE object_name |
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'
COMMENT 儲存一個資料庫對象的評注。
要修改一個評注，為同一個對像發出一條新的 COMMENT 命令即可。每個對象只儲存一條評注。 要刪除評注，在文本字串的位置寫上 NULL。 當刪除對像時，評注自動被刪除掉。
評注可以用 psql 命令 \dd， \d+，和 \l+ 檢索。 其它希望檢索評注的用戶接口可以建築在 psql 使用的同樣的內置函數上， 也就是說 obj_description 和 col_description （參閱 Table 9-43）。
要加入評注的對象名稱。資料表，索引，序列，視圖，類型，域，函數， 聚集和操作符的名字可以是模式修飾的。
聚集函數的參數類型，如果函數接受任意資料類型，那麼是 *。
大對象的 OID。
這個字無用。
類型轉換的源資料類型名字。
類型轉換的目的資料類型名字。
新的評注，以字串文本的方式寫；如果是 NULL 則刪除該評注。
一個資料庫裡的評注只能在改資料庫裡建立，並且只有在那個資料庫裡可見，其它庫裡不可見。
需要說明的是目前評注沒有安全機制：任何連線到某資料庫上的用戶都可以看到所有該資料庫對象的評注 （儘管只有超級用戶可以修改不屬於他的對象的評注）。因此，不要在評注裡放安全性敏感地訊息。
給資料表mytable 加評註：
COMMENT ON 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 CAST (text AS int4) IS 'Allow casts from text to int4'; COMMENT ON COLUMN my_table.my_column IS 'Employee ID number'; COMMENT ON CONVERSION my_conv IS 'Conversion to Unicode'; 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 LANGUAGE plpython IS 'Python support for stored procedures'; COMMENT ON LARGE OBJECT 346344 IS 'Planning document'; 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 OPERATOR CLASS int4ops USING btree IS '4 byte integer operators for btrees'; 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';