PostgreSQLデータベースに接続し、特定のスキーマのすべての関数を検索できるようにしたい。
私は、pg_catalogまたはinformation_schemaにクエリを実行してすべての関数のリストを取得できると考えましたが、名前とパラメーターが格納されている場所を把握できません。私は、関数名とそれが取るパラメーターの種類(およびそれらが受け取る順序)を提供するクエリを探しています。
これを行う方法はありますか?
いくつかの検索の後、information_schema.routines
テーブルとinformation_schema.parameters
テーブルを見つけることができました。これらを使用して、この目的のためにクエリを作成できます。パラメータなしで関数を取得するには、JOINではなくLEFT JOINが必要です。
SELECT routines.routine_name, parameters.data_type, parameters.ordinal_position
FROM information_schema.routines
LEFT JOIN information_schema.parameters ON routines.specific_name=parameters.specific_name
WHERE routines.specific_schema='my_specified_schema_name'
ORDER BY routines.routine_name, parameters.ordinal_position;
\df <schema>.*
in psql
は必要な情報を提供します。
内部で使用されているクエリを確認するには、psql
を使用してデータベースに接続し、追加の "-E
"(または "--echo-hidden
")オプションを指定して、上記のコマンドを実行します。
ここに興味がある人は、postgres 9.1でpsql
によって実行されるクエリは次のとおりです。
SELECT n.nspname as "Schema",
p.proname as "Name",
pg_catalog.pg_get_function_result(p.oid) as "Result data type",
pg_catalog.pg_get_function_arguments(p.oid) as "Argument data types",
CASE
WHEN p.proisagg THEN 'agg'
WHEN p.proiswindow THEN 'window'
WHEN p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype THEN 'trigger'
ELSE 'normal'
END as "Type"
FROM pg_catalog.pg_proc p
LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace
WHERE pg_catalog.pg_function_is_visible(p.oid)
AND n.nspname <> 'pg_catalog'
AND n.nspname <> 'information_schema'
ORDER BY 1, 2, 4;
psql
を-E
フラグを指定して実行すると、バックスラッシュコマンドに対してpsql
が実行するものを取得できます。
これを非常に簡単にする便利な関数oidvectortypes
があります。
SELECT format('%I.%I(%s)', ns.nspname, p.proname, oidvectortypes(p.proargtypes))
FROM pg_proc p INNER JOIN pg_namespace ns ON (p.pronamespace = ns.oid)
WHERE ns.nspname = 'my_namespace';
Postgres OnlineのLeo HsuとRegina Obeoidvectortypes
を指摘してくれたことに感謝します。以前にも同様の関数を作成しましたが、この関数が必要としない複雑なネストされた式を使用しました。
(2016年に編集)
一般的なレポートオプションの要約:
-- Compact:
SELECT format('%I.%I(%s)', ns.nspname, p.proname, oidvectortypes(p.proargtypes))
-- With result data type:
SELECT format(
'%I.%I(%s)=%s',
ns.nspname, p.proname, oidvectortypes(p.proargtypes),
pg_get_function_result(p.oid)
)
-- With complete argument description:
SELECT format('%I.%I(%s)', ns.nspname, p.proname, pg_get_function_arguments(p.oid))
-- ... and mixing it.
-- All with the same FROM clause:
FROM pg_proc p INNER JOIN pg_namespace ns ON (p.pronamespace = ns.oid)
WHERE ns.nspname = 'my_namespace';
注意:p.proname||'_'||p.oid AS specific_name
を使用して一意の名前を取得するか、information_schema
テーブルと結合します— routines
を参照してください@RuddZwolinskiの回答でparameters
。
関数の OID (pg_catalog.pg_proc
を参照)および関数のspecific_nameを参照information_schema.routines
)は、関数への主要な参照オプションです。以下に、レポートおよびその他のコンテキストで役立つ機能をいくつか示します。
--- --- --- --- ---
--- Useful overloads:
CREATE FUNCTION oidvectortypes(p_oid int) RETURNS text AS $$
SELECT oidvectortypes(proargtypes) FROM pg_proc WHERE oid=$1;
$$ LANGUAGE SQL IMMUTABLE;
CREATE FUNCTION oidvectortypes(p_specific_name text) RETURNS text AS $$
-- Extract OID from specific_name and use it in oidvectortypes(oid).
SELECT oidvectortypes(proargtypes)
FROM pg_proc WHERE oid=regexp_replace($1, '^.+?([^_]+)$', '\1')::int;
$$ LANGUAGE SQL IMMUTABLE;
CREATE FUNCTION pg_get_function_arguments(p_specific_name text) RETURNS text AS $$
-- Extract OID from specific_name and use it in pg_get_function_arguments.
SELECT pg_get_function_arguments(regexp_replace($1, '^.+?([^_]+)$', '\1')::int)
$$ LANGUAGE SQL IMMUTABLE;
--- --- --- --- ---
--- User customization:
CREATE FUNCTION pg_get_function_arguments2(p_specific_name text) RETURNS text AS $$
-- Example of "special layout" version.
SELECT trim(array_agg( op||'-'||dt )::text,'{}')
FROM (
SELECT data_type::text as dt, ordinal_position as op
FROM information_schema.parameters
WHERE specific_name = p_specific_name
ORDER BY ordinal_position
) t
$$ LANGUAGE SQL IMMUTABLE;
以下のSQLクエリを実行して、すべての機能を表示するビューを作成します。
CREATE OR REPLACE VIEW show_functions AS
SELECT routine_name FROM information_schema.routines
WHERE routine_type='FUNCTION' AND specific_schema='public';
例:
perfdb-# \df information_schema.*;
List of functions
Schema | Name | Result data type | Argument data types | Type
information_schema | _pg_char_max_length | integer | typid oid, typmod integer | normal
information_schema | _pg_char_octet_length | integer | typid oid, typmod integer | normal
information_schema | _pg_datetime_precision| integer | typid oid, typmod integer | normal
.....
information_schema | _pg_numeric_scale | integer | typid oid, typmod integer | normal
information_schema | _pg_truetypid | oid | pg_attribute, pg_type | normal
information_schema | _pg_truetypmod | integer | pg_attribute, pg_type | normal
(11 rows)