合 PG中添加和查询注释comment
Tags： PGPostgreSQL注释comment
简介
PG或GP的表的注释可以通过obj_description函数获取，列的注释通过col_description函数获取，也可以通过pg_description视图获取。
pg_description视图查询注释
pg_description视图记录了数据库中对象（表、字段等）的注释。这个表的功能类似PG_SHDESCRIPTION，用于记录整个集群范围内共享对象的注释。
视图pg_description存储对每一个数据库对象可选的描述（注释）。描述可以通过COMMENT操作，并可使用psql的\d命令查看。在pg_description的初始内容中提供了很多内建系统对象的描述。
参见pg_shdescription，它对在一个数据库集簇中共享的对象的描述提供了相似的功能。
其中比较重要的字段有：
objoid 这条描述所描述的对象的 OID。如果这条注释是一个表或表中字段的注释，那么，该值对应于pg_class.oid
objsubid 对于一个表字段的注释，它是字段号，对应于pg_attribute.attnum。对于其它对象类型，它是零。
description 作为对该对象的描述的任意文本
函数查询注释
表 9.73中展示的函数抽取注释，注释是由COMMENT命令在以前存储的。如果对指定参数找不到注释，则返回空值。
表 9.73. 注释信息函数
| 函数描述 |
|---|
col_description ( table oid, column integer ) → text返回表列的注释，该注释由该表的OID和列号指定。(obj_description不能用于表的列，因为列没有自己的oid。) |
obj_description ( object oid, catalog name ) → text返回OID指定的数据库对象的注释和包含该对象的系统目录的名称。 例如，obj_description(123456, 'pg_class')将检索OID为123456的表的注释。 |
obj_description ( object oid ) → text返回仅由其OID指定的数据库对象的注释。 这个已被弃用(deprecated)\因为无法保证oid在不同的系统目录中是唯一的;因此，可能会返回错误的注释。 |
shobj_description ( object oid, catalog name ) → text返回共享数据库对象的注释，该对象由其OID和包含的系统编目的名称指定。 这与obj_description类似，只是它用于检索共享对象(也就是数据库、角色和表空间)上的注释。 有些系统编目对每个集群中的所有数据库都是全局的，其中对象的描述也全局存储。 |
COMMENT命令简介
PG中可以使用comment命令为表、列、索引、视图等对象添加注释。
命令
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | COMMENT ON { ACCESS METHOD object_name | AGGREGATE aggregate_name ( aggregate_signature ) | CAST (source_type AS target_type) | COLLATION object_name | COLUMN relation_name.column_name | CONSTRAINT constraint_name ON table_name | CONSTRAINT constraint_name ON DOMAIN domain_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 | POLICY policy_name ON table_name | [ PROCEDURAL ] LANGUAGE object_name | PROCEDURE procedure_name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] | PUBLICATION object_name | ROLE object_name | ROUTINE routine_name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] | RULE rule_name ON table_name | SCHEMA object_name | SEQUENCE object_name | SERVER object_name | STATISTICS object_name | SUBSCRIPTION 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 | TRANSFORM FOR type_name LANGUAGE lang_name | TRIGGER trigger_name ON table_name | TYPE object_name | VIEW object_name } IS 'text' 其中 aggregate_signature 是： * | [ argmode ] [ argname ] argtype [ , ... ] | [ [ argmode ] [ argname ] argtype [ , ... ] ] ORDER BY [ argmode ] [ argname ] argtype [ , ... ] |
描述
COMMENT存储关于一个数据库对象的注释。
对每一个对象只保存一个注释字符串，因此为了修改一段注释，对同一个对象 发出一个新的COMMENT命令。要移除一段注释，可在文本字符串的位置上写上NULL。当对象被删除时，其注释 也会被自动删除。
对大部分类型的对象，只有对象的拥有者可以设置注释。角色没有拥有者，因此 COMMENT ON ROLE的规则是你必须作为一个超级用户来对一个 超级用户角色设置注释，或者具有CREATEROLE特权来对非超级用 户角色设置注释。同样的，访问方法也没有拥有者，你必须作为一个超级用户来 对一个访问方法设置注释。当然，一个超级用户可以对任何东西设置注释。
使用psql的\d 命令家族可以查看注释。其他检索注释的用户接口可以构建在 psql使用的内建函数之上，即 obj_description、col_description 以及shobj_description （见表 9.73）。
参数
object_namerelation_name.column_nameaggregate_nameconstraint_namefunction_nameoperator_namepolicy_nameprocedure_nameroutine_namerule_nametrigger_name要被注释的对象的名称。表、聚集、排序方式、转换、域、外部表、函数、 索引、操作符、操作符类、操作符族、存储过程、例程、序列、统计信息、文本搜索对象、类型和视图 的名称可以被模式限定。在注释一列时，
relation_name必须 引用一个表、视图、组合类型或者外部表。table_namedomain_name当在一个约束、触发器、规则或者策略上创建一段注释时，这些参数指定在其上定义 该对象的表或域的名称。
source_type造型的源数据类型的名称。
target_type造型的目标数据类型的名称。
argmode一个函数，存储过程或者聚集函数的参数的模式：
IN、OUT、INOUT或者VARIADIC。 如果被省略，默认值是IN。注意COMMENT并不真正关心OUT参数，因为决定函数的身份只需要输入参数。因此 列出IN、INOUT和VARIADIC参数就足够了。argname一个函数，存储过程或者聚集函数参数的名称。注意
COMMENT并不真正关心参数名称， 因为决定函数的身份只需要参数数据类型。argtype一个函数，存储过程或者聚集函数参数的数据类型。
large_object_oid本人提供Oracle(OCP、OCM)、MySQL(OCP)、PostgreSQL(PGCA、PGCE、PGCM)等数据库的培训和考证业务，私聊QQ646634621或微信dbaup66，谢谢！
