如何查找PostgreSQL中是否存在函数?

时间:2014-07-16 06:25:36

标签: function postgresql plpgsql

与表或序列不同,无法通过pg_class找到用户定义的函数。关于how find a list of all functions to deletegrant的问题,但是如何找到一个单独的函数(具有已知的名称和参数类型)并不是不言而喻的。那么如何查找函数是否存在呢?

编辑:我希望以自动方式在函数中使用它。哪种解决方案性能最佳?陷阱错误是非常昂贵的,所以我想对我来说最好的解决方案是没有将错误转换为错误的额外步骤,但我可能在这个假设中错了。

4 个答案:

答案 0 :(得分:27)

是的,您无法在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$

或者你可以使用buildin函数:pg_get_function_arguments

P.S。在系统目录中简单定位的技巧。使用psql选项-E

[pavel@localhost ~]$ 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)

答案 1 :(得分:4)

我认为最简单的方法是使用pg_get_functiondef()

如果返回某些内容,则该函数存在,否则该函数不存在:

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

缺点是如果函数不存在则会产生错误而不是简单地返回空结果。但这可能是例如通过编写捕获异常并返回false的PL / pgSQL函数来克服。

答案 2 :(得分:0)

基于@PavelStehule的回答,这就是我在脚本中(使用postgres exceptionsavailable exception codes)进行检查的方式

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

答案 3 :(得分:0)

晚聚会, 但这可能是这样的(如果您不使用结果,请不要使用select而不是perform,否则您会因抱怨而出错:

错误:查询没有结果数据的目的地

因此以下代码将起作用:

DO $$
BEGIN
    BEGIN
        perform pg_get_functiondef('some_function()'::regprocedure);
        raise notice 'it exists!';
    EXCEPTION WHEN undefined_function THEN
        raise notice 'Does not exist';
    END;
END $$;