PG中添加和查询注释comment

0    818    1

Tags:

👉 本文共约3919个字,系统预计阅读时间或需15分钟。

简介

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命令为表、列、索引、视图等对象添加注释。

命令

描述

COMMENT存储关于一个数据库对象的注释。

对每一个对象只保存一个注释字符串,因此为了修改一段注释,对同一个对象 发出一个新的COMMENT命令。要移除一段注释,可在文本字符串的位置上写上NULL。当对象被删除时,其注释 也会被自动删除。

对大部分类型的对象,只有对象的拥有者可以设置注释。角色没有拥有者,因此 COMMENT ON ROLE的规则是你必须作为一个超级用户来对一个 超级用户角色设置注释,或者具有CREATEROLE特权来对非超级用 户角色设置注释。同样的,访问方法也没有拥有者,你必须作为一个超级用户来 对一个访问方法设置注释。当然,一个超级用户可以对任何东西设置注释。

使用psql的\d 命令家族可以查看注释。其他检索注释的用户接口可以构建在 psql使用的内建函数之上,即 obj_descriptioncol_description 以及shobj_description (见表 9.73)。

本人提供Oracle(OCP、OCM)、MySQL(OCP)、PostgreSQL(PGCA、PGCE、PGCM)等数据库的培训和考证业务,私聊QQ646634621或微信db_bao,谢谢!
PG中添加和查询注释comment后续精彩内容已被小麦苗无情隐藏,请输入验证码解锁本站所有文章!
验证码:
请先关注本站微信公众号,然后回复“验证码”,获取验证码。在微信里搜索“DB宝”或者“www_xmmup_com”或者微信扫描右侧二维码都可以关注本站微信公众号。

标签:

Avatar photo

小麦苗

学习或考证,均可联系麦老师,请加微信db_bao或QQ646634621

您可能还喜欢...

发表回复

嘿,我是小麦,需要帮助随时找我哦。
  • 18509239930
  • 个人微信

  • DB宝
  • 个人邮箱
  • 点击加入QQ群
  • 个人微店

  • 回到顶部