内容

col_description()

返回列注释的函数

col_description() 是一个返回表列注释的系统函数。

col_description() 在 PostgreSQL 7.2 中添加。

用法

col_description ( table oid, column integer ) → text

col_description() 需要表名作为 OID（这可以通过将表名转换为 regclass 来轻松获得），以及列号，该列号不一定是列的顺序号；列号对应于 pg_attribute 的 attnum 列中的值。

col_description() 如果指定的表列没有注释，或者指定的表或列不存在，则返回 NULL。

如果通过 regclass 转换指定表，则如果找不到表，则会引发错误。

变更历史

示例

col_description() 的基本用法示例

postgres=# COMMENT ON COLUMN foo.id IS 'Thingy number';
COMMENT

postgres=# SELECT col_description('foo'::regclass, 1);
 col_description 
-----------------
 Thingy number
(1 row)

postgres=# COMMENT ON COLUMN foo.id IS NULL;
COMMENT

postgres=# SELECT col_description('foo'::regclass, 1);
 col_description 
-----------------
 
(1 row)

尝试获取不存在表的列描述

postgres=# SELECT col_description(9999, 1);
 col_description 
-----------------
 
(1 row)

postgres=# SELECT col_description('not_a_table'::regclass, 1);
ERROR:  relation "not_a_table" does not exist
LINE 1: SELECT col_description('not_a_table'::regclass, 1);

尝试获取不存在列的列描述

postgres=# SELECT col_description('foo'::regclass, 999);
 col_description 
-----------------
 
(1 row)

分类

系统函数

另请参阅

obj_description()，shobj_description()，COMMENT ON

反馈

提交任何关于“col_description()”的评论、建议或更正 此处。