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 转换指定的，则在找不到表时会引发错误。
变更历史
- PostgreSQL 7.2
- 已添加（提交 bf56f075）
示例
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)
参考资料
- PostgreSQL documentation: Comment Information Functions