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 对特定系统目录表唯一。
更改历史
- PostgreSQL 7.2
- 添加
obj_description ( object oid, catalog name )
变体(提交 bf56f075)
- 添加
- PostgreSQL 6.3
- 添加(提交 4cbc06cf)
示例
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)
参考文献
- PostgreSQL 文档: 注释信息函数