COMMENT · PostgreSQL 中文文檔 9.3

# COMMENT ## Name COMMENT?--?定義或者改變一個對象的注釋 ## Synopsis ``` COMMENT ON { AGGREGATE _agg_name_ (_agg_type_ [, ...] ) | CAST (_source_type_ AS _target_type_) | COLLATION _object_name_ | COLUMN _relation_name_._column_name_ | CONSTRAINT _constraint_name_ ON _table_name_ | CONVERSION _object_name_ | DATABASE _object_name_ | DOMAIN _object_name_ | EXTENSION _object_name_ | EVENT TRIGGER _object_name_ | FOREIGN DATA WRAPPER _object_name_ | FOREIGN TABLE _object_name_ | FUNCTION _function_name_ ( [ [ _argmode_ ] [ _argname_ ] _argtype_ [, ...] ] ) | INDEX _object_name_ | LARGE OBJECT _large_object_oid_ | MATERIALIZED VIEW _object_name_ | OPERATOR _operator_name_ (_left_type_, _right_type_) | OPERATOR CLASS _object_name_ USING _index_method_ | OPERATOR FAMILY _object_name_ USING _index_method_ | [ PROCEDURAL ] LANGUAGE _object_name_ | ROLE _object_name_ | RULE _rule_name_ ON _table_name_ | SCHEMA _object_name_ | SEQUENCE _object_name_ | SERVER _object_name_ | TABLE _object_name_ | TABLESPACE _object_name_ | TEXT SEARCH CONFIGURATION _object_name_ | TEXT SEARCH DICTIONARY _object_name_ | TEXT SEARCH PARSER _object_name_ | TEXT SEARCH TEMPLATE _object_name_ | TRIGGER _trigger_name_ ON _table_name_ | TYPE _object_name_ | VIEW _object_name_ } IS '_text_' ``` ## 描述 `COMMENT`存儲一個數據庫對象的注釋。每個對象只存儲一條注釋，因此要修改一個注釋，對同一個對象發出一條新的`COMMENT`命令即可。要刪除注釋，在文本字符串的位置寫上`NULL`即可。當刪除對象時，注釋自動被刪除掉。對大多數對象，只有對象的所有者可以設置注釋。角色沒有所有者，所以`COMMENT ON ROLE`命令僅可以由超級用戶對超級用戶角色執行，有`CREATEROLE`權限的角色也可以為非超級用戶角色設置注釋，當然超級用戶可以對所有對象進行注釋。注釋可以用psql程序中的`\d`命令檢索。其它希望提取注釋的用戶接口設計可以使用程序psql使用的同樣的內置函數`obj_description`、`col_description`和`shobj_description`(參見[Table 9-55](#calibre_link-1613))。 ## 參數 `_object_name_``_relation_name_`.`_column_name_` `_agg_name_` `_constraint_name_` `_function_name_` `_operator_name_` `_rule_name_` `_trigger_name_` 要加入注釋的對象名稱。表、聚集、排序規則、編碼轉換、域、外部表、函數、索引、操作符、操作符類、操作符系列、序列、全文搜索對象、類型、視圖，名字可以有模式修飾。當對一個字段進行注釋時，`_relation_name_`必需是針對一個表、視圖、復合類型或是外部表。 `_agg_type_` 聚集函數操作的輸入參數類型，要引用一個零參數聚集函數，可以使用`*`代替輸入數據類型列表。 `_source_type_` 類型轉換的源數據類型。 `_target_type_` 類型轉換的目標數據類型。 `_argmode_` 函數參數的模式：`IN`、`OUT`、`INOUT`或`VARIADIC`。如果省略，缺省值是`IN`。請注意`COMMENT ON FUNCTION`實際上不會使用`OUT`參數，因為只要有輸入參數就可以判斷函數的身份了。因此，只要列出`IN`、`INOUT`和`VARIADIC`參數就足夠了。 `_argname_` 函數參數的名字。請注意`COMMENT ON FUNCTION`實際上并不使用參數名，因為只要有參數的數據類型就可以判斷函數的身份。 `_argtype_` 如果有的話，是函數參數的數據類型(可以用模式修飾) `_large_object_oid_` 大對象的OID 。 `_left_type_` `_right_type_` 操作符參數的數據類型（可以用模式修飾）。當前置或后置操作符不存在時，可以增加`NONE`選項。 `PROCEDURAL` 這個選項沒有任何用處。 `_text_` 新的注釋，以字符串文本的方式寫；如果是`NULL`則刪除注釋。 ## 注意目前注釋瀏覽沒有安全機制：任何連接到某數據庫上的用戶都可以看到所有該數據庫對象的注釋。共享對象(比如數據庫、角色、表空間)的注釋是全局存儲的，連接到任何數據庫的任何用戶都可以看到它們。因此，不要在注釋里存放與安全有關的敏感信息。 ## 例子給表`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 CAST (text AS int4) IS 'Allow casts from text to int4'; COMMENT ON COLLATION "fr_CA" IS 'Canadian French'; COMMENT ON COLUMN my_table.my_column IS 'Employee ID number'; COMMENT ON CONVERSION my_conv IS 'Conversion to UTF8'; COMMENT ON CONSTRAINT bar_col_cons ON bar IS 'Constrains column col'; COMMENT ON DATABASE my_database IS 'Development Database'; COMMENT ON DOMAIN my_domain IS 'Email Address Domain'; COMMENT ON EXTENSION hstore IS 'implements the hstore data type'; COMMENT ON FOREIGN DATA WRAPPER mywrapper IS 'my foreign data wrapper'; COMMENT ON FOREIGN TABLE my_foreign_table IS 'Employee Information in other database'; 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 MATERIALIZED VIEW my_matview IS 'Summary of order history'; COMMENT ON OPERATOR ^ (text, text) IS 'Performs intersection of two texts'; COMMENT ON OPERATOR - (NONE, integer) IS 'Unary minus'; COMMENT ON OPERATOR CLASS int4ops USING btree IS '4 byte integer operators for btrees'; COMMENT ON OPERATOR FAMILY integer_ops USING btree IS 'all integer operators for btrees'; COMMENT ON ROLE my_role IS 'Administration group for finance tables'; 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 SERVER myserver IS 'my foreign server'; COMMENT ON TABLE my_schema.my_table IS 'Employee Information'; COMMENT ON TABLESPACE my_tablespace IS 'Tablespace for indexes'; COMMENT ON TEXT SEARCH CONFIGURATION my_config IS 'Special word filtering'; COMMENT ON TEXT SEARCH DICTIONARY swedish IS 'Snowball stemmer for swedish language'; COMMENT ON TEXT SEARCH PARSER my_parser IS 'Splits text into words'; COMMENT ON TEXT SEARCH TEMPLATE snowball IS 'Snowball stemmer'; 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'; ``` ## 兼容性 SQL標準里沒有`COMMENT`命令。