PG中添加和查询注释comment

0    237    1

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

COMMENT命令简介

PG中可以使用comment命令为表、列、索引、视图等对象添加注释。

命令

描述

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

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

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

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

参数

  • object_name relation_name.column_name aggregate_name constraint_name function_name operator_name policy_name procedure_name routine_name rule_name trigger_name

    要被注释的对象的名称。表、聚集、排序方式、转换、域、外部表、函数、 索引、操作符、操作符类、操作符族、存储过程、例程、序列、统计信息、文本搜索对象、类型和视图 的名称可以被模式限定。在注释一列时, relation_name必须 引用一个表、视图、组合类型或者外部表。

  • table_name domain_name

    当在一个约束、触发器、规则或者策略上创建一段注释时,这些参数指定在其上定义 该对象的表或域的名称。

  • source_type

    造型的源数据类型的名称。

  • target_type

    造型的目标数据类型的名称。

  • argmode

    一个函数,存储过程或者聚集函数的参数的模式:INOUTINOUT或者VARIADIC。 如果被省略,默认值是IN。注意 COMMENT并不真正关心 OUT参数,因为决定函数的身份只需要输入参数。因此 列出ININOUTVARIADIC 参数就足够了。

  • argname

    一个函数,存储过程或者聚集函数参数的名称。注意 COMMENT并不真正关心参数名称, 因为决定函数的身份只需要参数数据类型。

  • argtype

    一个函数,存储过程或者聚集函数参数的数据类型。

  • large_object_oid

    大对象的 OID。

  • left_type right_type

    操作符的参数的数据类型(可以是模式限定的)。对一个前缀后后缀操作符 的缺失参数可以写NONE

  • PROCEDURAL

    这是一个噪声词。

  • type_name

    该转换的数据类型的名称。

  • lang_name

    该转换的语言的名称。

  • text

    写成一个字符串的新注释。如果要删除注释,写成NULL

注解

当前对查看注释没有安全机制:任何连接到一个数据库的用户能够看到 该数据库中所有对象的注释。对于数据库、角色、表空间这类共享对象, 注释被全局存储,因此连接到集簇中任何数据库的任何用户可以看到共 享对象的所有注释。因此,不要在注释中放置有安全性风险的信息。

示例

为表mytable附加一段注释:

移除它:

本人提供Oracle、MySQL、PG等数据库的培训和考证业务,私聊QQ646634621或微信db_bao,谢谢!

更多的一些例子:

兼容性

SQL 标准中没有COMMENT命令。

查询注释

表 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类似,只是它用于检索共享对象(也就是数据库、角色和表空间)上的注释。 有些系统编目对每个集群中的所有数据库都是全局的,其中对象的描述也全局存储。

我的示例

注意:::regclass是oid的别名。

regclass是一种数据类型,它实际上是oid的别名。相当于是oid和对象名之间的双向符号,既可以把oid翻译成表名,也可以把表名翻译成oid。通过使用::regclass, 我们就不需要通过查询pg_class表来获取对象与oid的对应关系了。

过程:

参考

http://postgres.cn/docs/14/sql-comment.html

    头像

    小麦苗

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

    您可能还喜欢...

    发表评论

    您的电子邮箱地址不会被公开。

    1 × 1 =

     

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

    • 麦老师QQ聊天
    • 个人邮箱
    • 点击加入QQ群
    • 个人微店

    • 回到顶部
    返回顶部