Как найти, существует ли функция в PostgreSQL?

В отличие от таблиц или последовательностей пользовательские функции не могут быть найдены через pg_class. Есть вопросы о том, как найти список всех функций для их удаления или предоставления, но как найти индивидуальную функцию (с известным именем и типами аргументов) не является очевидным из них. Итак, как найти, существует ли функция или нет?

EDIT: Я хочу использовать его в функции автоматически. Какое решение является лучшим по производительности? Ошибки ловушки довольно дороги, поэтому я думаю, что лучшим решением для меня было бы что-то без дополнительного шага перевода ошибки в false, но я мог ошибаться в этом предположении.

Ответ 1

Да, вы не можете найти функции в pg_class потому что функции хранятся в системной таблице pg_proc

postgres-# \df
                               List of functions
 Schema |        Name        | Result data type | Argument data types  |  Type  
--------+--------------------+------------------+----------------------+--------
 public | foo                | integer          | a integer, b integer | normal
 public | function_arguments | text             | oid                  | normal
(2 rows)

Запрос списка пользовательских функций на основе pg_proc - это просто

postgres=# select p.oid::regprocedure
              from pg_proc p 
                   join pg_namespace n 
                   on p.pronamespace = n.oid 
             where n.nspname not in ('pg_catalog', 'information_schema');
           oid           
-------------------------
 foo(integer,integer)
 function_arguments(oid)
(2 rows)

Наиболее простые и быстрые тесты на существование функций - это литье (без параметров) в regproc или regprocedure (с параметрами):

postgres=# select 'foo'::regproc;
 regproc 
---------
 foo
(1 row)

postgres=# select 'foox'::regproc;
ERROR:  function "foox" does not exist
LINE 1: select 'foox'::regproc;
               ^
postgres=# select 'foo(int, int)'::regprocedure;
     regprocedure     
----------------------
 foo(integer,integer)
(1 row)

postgres=# select 'foo(int, text)'::regprocedure;
ERROR:  function "foo(int, text)" does not exist
LINE 1: select 'foo(int, text)'::regprocedure;
               ^

или вы можете сделать что-то подобное с тестом против pg_proc

postgres=# select exists(select * from pg_proc where proname = 'foo');
 exists 
--------
 t
(1 row)

postgres=# select exists(select * 
                            from pg_proc 
                           where proname = 'foo' 
                             and function_arguments(oid) = 'integer, integer');
 exists 
--------
 t
(1 row)

где:

CREATE OR REPLACE FUNCTION public.function_arguments(oid)
RETURNS text LANGUAGE sql AS $function$
    select string_agg(par, ', ') 
       from (select format_type(unnest(proargtypes), null) par 
                from pg_proc where oid = $1) x
$function$

или вы можете использовать функции pg_get_function_arguments: pg_get_function_arguments

ps трюк для простой ориентации в системном каталоге. Используйте параметр psql -E:

[[email protected] ~]$ psql -E postgres
psql (9.2.8, server 9.5devel)
Type "help" for help.

postgres=# \df
********* QUERY **********
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;
**************************

                               List of functions
 Schema |        Name        | Result data type | Argument data types  |  Type  
--------+--------------------+------------------+----------------------+--------
 public | foo                | integer          | a integer, b integer | normal
 public | function_arguments | text             | oid                  | normal
(2 rows)

Ответ 2

Я думаю, что самый простой способ - использовать pg_get_functiondef().

Если он что-то возвращает, функция там, иначе функция не существует:

select pg_get_functiondef('some_function()'::regprocedure);
select pg_get_functiondef('some_function(integer)'::regprocedure);

Недостатком является то, что он выдает ошибку, если функция не существует, а просто возвращает пустой результат. Но это можно, например, преодолеть, написав функцию PL/pgSQL, которая ловит исключение и вместо этого возвращает false.

Ответ 3

Основываясь на ответе @PavelStehule, я проверяю это в своих сценариях (используя исключения postgres и доступные коды исключений)

DO $_$
BEGIN
    BEGIN
        SELECT 'some_schema.some_function(text)'::regprocedure;
    EXCEPTION WHEN undefined_function THEN
        -- do something here, i.e. create function
    END;
END $_$;