获取 PostgreSQL 中表注释的列表

Question

Postgresql 允许向表等对象添加注释。例如，我使用以下 SQL 命令向表“mytable”添加了注释：

COMMENT ON TABLE mytable IS 'This is my table.';

我的问题是： 如果我想使用 SQL 命令获取所有表及其各自的注释 - 我该怎么做？对此合适的查询是什么？

提前致谢！ 干杯!

Answer 1

所有评论都存储在 pg_description

中以获取评论一个表，您需要将其加入 pg_class

作为另一种方法是，您还可以使用函数 obj_description() 来检索此信息：

SELECT obj_description(oid)
FROM pg_class
WHERE relkind = 'r'

编辑

在 psql 中，您只需使用 \d+命令显示所有表格，包括它们的注释。或者使用\dd命令显示系统中所有评论

Answer 2

“显示评论”的主要问题是记住特定功能的名称、目录名称等以检索评论......或其在指南上的页面。在这个答案中我们通过两种方式来解决：
通过普通方式（pg方式）的总结来显示评论；
并通过提供快捷功能，减少“记忆问题”。

---

pg-way

最简单，在psql上，是使用\dt+来显示表注释和\d+显示专栏评论。一些功能注释？

要使用 SQL，对于记住所有参数的人来说，pg 方法是使用 obj_description() 函数（指南）与足够的reg类型结合：

• 函数: select obj_description('mySchema.myFunction'::regproc, 'pg_proc')

• 表或视图:
  ("...以及大多数具有列或与表类似的其他内容",指南)
  选择 obj_description( 'mySchema.myClass'::regclass, 'pg_class')

• 其他 通用：select obj_description('mySchema.myObject'::regName, pg_regName )，其中 regName 是 datatype-oid 引用指南，和 pg_regName 相同，用前缀 pg_ 替换前缀 reg。

• 其他特定：类似select obj_description('schema.myObject'::regName, Catalog_name)，其中catalog_name更具体有关（95 个中的 1 个）关键字，请参见目录指南。它可以减少一些“命名空间污染”。例如，pg_proc 用于函数，pg_aggregate 用于聚合函数。

• 获取共享数据库对象的注释，模拟但使用函数shobj_description()（相同页面指南)。

• 列：select col_description('mySchema.myObject'::regClass, column_number)，其中column_number是列的序号位置（位于CREATE TABLE)。
  没有列名称...请参见下面的col_description(table,column_name)补充。

重要提示：使用相同的reg类型和_catalog_name_（例如::regclass和pg_class）似乎是多余的，有时obj_description(' obj'::regObj) 工作正常，只有 reg 类型！ ...但是，正如指南所说：

它已被弃用，因为不能保证 OID 在不同系统目录中是唯一的；因此，可能会返回错误的评论。

获取注释的快捷函数

如果您发现很难记住所有类型转换和参数，最好是采用一个新的、最简单的函数来检索注释。

 CREATE FUNCTION rel_description(
     p_relname text, p_schemaname text DEFAULT NULL
 ) RETURNS text AS $f$
    SELECT obj_description((CASE 
       WHEN strpos($1, '.')>0 THEN $1
       WHEN $2 IS NULL THEN 'public.'||$1
       ELSE $2||'.'||$1
            END)::regclass, 'pg_class');
 $f$ LANGUAGE SQL;
 -- EXAMPLES OF USE:
 -- SELECT rel_description('mytable'); 
 -- SELECT rel_description('public.mytable'); 
 -- SELECT rel_description('otherschema.mytable'); 
 -- SELECT rel_description('mytable', 'otherschema'); 
 -- PS: rel_description('public.mytable', 'otherschema') is a syntax error, 
 --     but not generates exception: returns the same as ('public.mytable') 

我们还需要一些不那么难看的东西来显示专栏评论。没有任何一种 pg_get_serial_sequence() 函数可以从名称中获取列的序号位置。原生
col_description('mySchema.myObject'::regClass, column_number)
需要补充：

 CREATE FUNCTION col_description(
    p_relname text,  -- table name or schema.table 
    p_colname text,   -- table's column name
    p_database text DEFAULT NULL -- NULL for current
 ) RETURNS text AS $f$
    WITH r AS (
      SELECT CASE WHEN array_length(x,1)=1 THEN array['public',x[1]] ELSE x END
      FROM regexp_split_to_array(p_relname,'\.') t(x)
     ) 
    SELECT col_description(p_relname::regClass, ordinal_position)
    FROM r, information_schema.columns i
    WHERE i.table_catalog = CASE 
        WHEN $3 IS NULL THEN current_database() ELSE $3 
      END and i.table_schema  = r.x[1]
      and i.table_name    = r.x[2]
      and i.column_name = p_colname
 $f$ LANGUAGE SQL;
 -- SELECT col_description('tableName','colName'); 
 -- SELECT col_description('schemaName.tableName','colName','databaseName); 

---

注意：

• 按照 这个答案：“如果您想知道当您执行 \dt+ 或 \d+ 客户时 psql 运行哪些查询，只需使用 psql 启动它 - E”。

• 可以使用任何多行字符串（带有 E\n 或 $$...$$)...
  但是您不能应用 trim() 或使用其他动态方面。必须在 动态 SQL comment.html" rel="noreferrer">COMMENT 子句。

• 没有评论可看？ PostgreSQL 程序员不使用 COMMENT 子句，因为它使用起来很难看：没有语法可以在 CREATE TABLE 或 CREATE FUNCTION 上添加注释；并且没有好的 IDE 来自动化它。

• 现代的http://postgREST.org/界面在网络上显示评论！

Answer 3

您可以使用 pg_catalog.obj_description 函数和 information_schema.tables 架构视图：

SELECT t.table_name, pg_catalog.obj_description(pgc.oid, 'pg_class')
FROM information_schema.tables t
INNER JOIN pg_catalog.pg_class pgc
ON t.table_name = pgc.relname 
WHERE t.table_type='BASE TABLE'
AND t.table_schema='public';

FUNCTIONS-INFO-COMMENT-TABLE

MySQL、PostgreSQL 中的 INFORMATION_SCHEMA 支持

Answer 4

如果您仍然有混合大小写名称的表，您可以使用以下命令获取数据库中所有表及其注释的完整列表，以及目录、模式、表类型等（在 PostGIS - pgAdmin 4 中测试）：

select *,
    obj_description((table_schema||'.'||quote_ident(table_name))::regclass)
from information_schema.tables where table_schema <> 'pg_catalog'