Получение комментариев из БД PostgreSQL

Question

Я запускаю проект в базе данных Postgres, и мне нужно получить комментарии к столбцам в БД, которые будут использоваться в качестве заголовков таблиц и тому подобное. Я видел, что есть несколько встроенных функций ( pg_description и col_description ), но я не смог найти примеров того, как их использовать, и поиграть с ними оказался довольно бесполезным.

Так что мне было интересно, смог ли кто-нибудь сделать это раньше, и если да, то как?

Answer 1

SELECT c.table_schema,c.table_name,c.column_name,pgd.description
FROM pg_catalog.pg_statio_all_tables as st
  inner join pg_catalog.pg_description pgd on (pgd.objoid=st.relid)
  inner join information_schema.columns c on (pgd.objsubid=c.ordinal_position
    and  c.table_schema=st.schemaname and c.table_name=st.relname);

Answer 2

все работает по oid,

mat=> SELECT c.oid FROM pg_catalog.pg_class c WHERE c.relname = 'customers';
  oid  
-------
 23208
(1 row)

Теперь у меня есть oid для этой таблицы, поэтому я могу спросить:

mat=> select pg_catalog.obj_description(23208);
  obj_description  
-------------------
 Customers
(1 row)

Тогда я могу попросить описание четвертого столбца:

mat=> select pg_catalog.col_description(23208,4);
             col_description             
-----------------------------------------
 Customer codes, CHS, FACTPOST, POWER...
(1 row)

Если вы хотите знать, какие запросы psql выполняются при выполнении \dt+ или \d+ customers, просто запустите его с -E.

Answer 3

Берегите схемы, этот код учитывает их:

SELECT
    cols.column_name,
    (
        SELECT
            pg_catalog.col_description(c.oid, cols.ordinal_position::int)
        FROM
            pg_catalog.pg_class c
        WHERE
            c.oid = (SELECT ('"' || cols.table_name || '"')::regclass::oid)
            AND c.relname = cols.table_name
    ) AS column_comment
FROM
    information_schema.columns cols
WHERE
    cols.table_catalog    = 'your_database'
    AND cols.table_name   = 'your_table'
    AND cols.table_schema = 'your_schema';

Ссылки:

• Таблица и столбец документа Postgresql Описание Комментарии к таблице и столбцу

• Определение OID таблицы в Postgres 9.1?

Answer 4

Это работает для меня, используя PostBooks 3.2.2 DB:

select cols.column_name,
(select pg_catalog.obj_description(oid) from pg_catalog.pg_class c where c.relname=cols.table_name) as table_comment
,(select pg_catalog.col_description(oid,cols.ordinal_position::int) from pg_catalog.pg_class c where c.relname=cols.table_name) as column_comment
from information_schema.columns cols
where cols.table_catalog='postbooks' and cols.table_name='apapply'

С уважением, Sylnsr

Answer 5

Просто чтобы быть здесь, если кому-то это понадобится.

Здесь много ответов, но ни один из них не был таким простым, как мне хотелось бы. Итак, основываясь на предыдущих ответах и ​​текущем postgres 9.4, я создал этот запрос:

SELECT 
    obj_description(format('%s.%s',isc.table_schema,isc.table_name)::regclass::oid, 'pg_class') as table_description,
    pg_catalog.col_description(format('%s.%s',isc.table_schema,isc.table_name)::regclass::oid,isc.ordinal_position) as column_description
FROM
    information_schema.columns isc

Извлекает описания таблиц и столбцов, без каких-либо запутанных объединений и безобразных конкатенаций строк.

Answer 6

Улучшение для предложений @Nick и @mat: используйте
SELECT obj_description('schemaName.tableName'::regclass, 'pg_class'); если у вас есть имя строки (не oid).

Чтобы избежать запоминания параметра 'pg_class' и избежать уродливых конкатенаций при вызовах функций, как (tname||'.'||schema)::regclass, полезная перегрузка для obj_description:

  CREATE FUNCTION obj_description(
      p_rname text, p_schema text DEFAULT NULL, 
      p_catalname text DEFAULT 'pg_class'
  ) RETURNS text AS $f$
     SELECT obj_description((CASE 
        WHEN strpos($1, '.')>0 OR $2 IS NULL OR $2='' THEN $1
        ELSE $2||'.'||$1
     END)::regclass, $3);
  $f$ LANGUAGE SQL IMMUTABLE;
 -- USAGE: obj_description('mytable') 
 --        SELECT obj_description('s.t'); 
 -- PS: obj_description('s.t', 'otherschema') is a syntax error, 
 --     but not generates exception: returns the same as ('s.t') 

Теперь это просто в использовании, потому что имя таблицы (rname параметр) является varchar и может быть выражено отдельным полем для имя схемы , как в основной таблицы и запросы.

См. Также « Получение списка комментариев к таблицам в PostgreSQL » или новое руководство по pg9.3

Answer 7

Небольшое изменение одного из других ответов, которое дает вам только столбцы с комментариями к ним, это дает вам все столбцы, есть ли у них комментарий или нет.

select c.table_schema, st.relname as TableName, c.column_name, 
pgd.description
from pg_catalog.pg_statio_all_tables as st
inner join information_schema.columns c
on c.table_schema = st.schemaname
and c.table_name = st.relname
left join pg_catalog.pg_description pgd
on pgd.objoid=st.relid
and pgd.objsubid=c.ordinal_position
where st.relname = 'YourTableName';

Answer 8

Этот ответ немного запоздал, но он появился в поиске Google, который я сделал, чтобы исследовать эту проблему. Нам нужны только описания таблиц, но метод будет одинаковым для столбцов. Описания столбцов также находятся в таблице pg_description, на которые ссылается objoid.

Добавить эту точку зрения:

CREATE OR REPLACE VIEW our_tables AS 
 SELECT c.oid, n.nspname AS schemaname, c.relname AS tablename, d.description,
   pg_get_userbyid(c.relowner) AS tableowner, t.spcname AS "tablespace", 
   c.relhasindex AS hasindexes, c.relhasrules AS hasrules, c.reltriggers > 0 AS hastriggers
   FROM pg_class c
   LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
   LEFT JOIN pg_tablespace t ON t.oid = c.reltablespace
   LEFT JOIN pg_description d ON c.oid = d.objoid
  WHERE c.relkind = 'r'::"char";

ALTER TABLE our_tables OWNER TO postgres;
GRANT SELECT, UPDATE, INSERT, DELETE, REFERENCES, TRIGGER ON TABLE our_tables TO postgres;
GRANT SELECT ON TABLE our_tables TO public;

Затем запустите:

SELECT tablename, description FROM our_tables WHERE schemaname = 'public'

Представление является модифицированной версией представления pg_tables, которое добавляется в столбец описания. Вы также можете использовать определение представления, чтобы сделать его одним запросом.

Answer 9

Я получил доступ к комментариям к таблице, как это:

select c.relname table_name, pg_catalog.obj_description(c.oid) as comment from pg_catalog.pg_class c where c.relname = 'table_name';

и столбец комментариев, таким образом:

SELECT c.column_name, pgd.description FROM pg_catalog.pg_statio_all_tables as st inner join pg_catalog.pg_description pgd on (pgd.objoid=st.relid) inner join information_schema.columns c on (pgd.objsubid=c.ordinal_position and c.table_schema=st.schemaname and c.table_name=st.relname and c.table_name = 'table_name' and c.table_schema = 'public');

Answer 10

Я только что нашел это здесь. Он предоставит вам все виды метаданных в одной конкретной таблице (тип, значение по умолчанию, не нулевой флаг, длина, комментарий, имя внешнего ключа, имя первичного ключа). Вроде хорошо работает.

SELECT pg_tables.tablename, pg_attribute.attname AS field, 
    format_type(pg_attribute.atttypid, NULL) AS "type", 
    pg_attribute.atttypmod AS len,
    (SELECT col_description(pg_attribute.attrelid, 
            pg_attribute.attnum)) AS comment, 
    CASE pg_attribute.attnotnull 
        WHEN false THEN 1  ELSE 0  
    END AS "notnull", 
    pg_constraint.conname AS "key", pc2.conname AS ckey, 
    (SELECT pg_attrdef.adsrc FROM pg_attrdef 
        WHERE pg_attrdef.adrelid = pg_class.oid 
        AND pg_attrdef.adnum = pg_attribute.attnum) AS def 
FROM pg_tables, pg_class 
JOIN pg_attribute ON pg_class.oid = pg_attribute.attrelid 
    AND pg_attribute.attnum > 0 
LEFT JOIN pg_constraint ON pg_constraint.contype = 'p'::"char" 
    AND pg_constraint.conrelid = pg_class.oid AND
    (pg_attribute.attnum = ANY (pg_constraint.conkey)) 
LEFT JOIN pg_constraint AS pc2 ON pc2.contype = 'f'::"char" 
    AND pc2.conrelid = pg_class.oid 
    AND (pg_attribute.attnum = ANY (pc2.conkey)) 
WHERE pg_class.relname = pg_tables.tablename  
--    AND pg_tables.tableowner = "current_user"() 
    AND pg_attribute.atttypid <> 0::oid  
    AND tablename='your_table' 
ORDER BY field ASC

Источник: http://golden13.blogspot.de/2012/08/how-to-get-some-information-about_7.html