obj_description()

返回对象注释的函数

obj_description() 是一个返回对象注释的系统函数。

obj_description()PostgreSQL 6.3 中添加。

用法

obj_description ( object oid, catalog name ) → text
obj_description ( object oid ) → text

给定一个 OID 和相应的 系统目录 表的名称,obj_description() 返回该对象的注释(由 COMMENT ON 定义),如果未指定注释则返回 NULL

请注意,obj_description ( object oid ) 的形式已弃用,因为不能保证特定的 OID 对特定的系统目录表是唯一的。

变更历史

示例

postgres=# CREATE TABLE foo (id int, val text);
CREATE TABLE

postgres=# COMMENT ON TABLE foo IS 'Store all the things';
COMMENT

postgres=# SELECT obj_description('foo'::regclass, 'pg_class');
   obj_description
----------------------
 Store all the things
(1 row)

分类

系统函数

另请参阅

COMMENT ON, pg_description, col_description(), shobj_description(),

反馈

提交任何关于“obj_description()”的评论、建议或更正请 在此