CREATE FUNCTION

功能描述

创建一个函数。

内部使用功能，不支持用户使用。

注意事项

• 如果创建函数时参数或返回值带有精度，不进行精度检测。
• 创建函数时，函数定义中对表对象的操作建议都显式指定模式，否则可能会导致函数执行异常。
• 如果函数参数中带有出参，想要出参生效，必须打开guc参数 set behavior_compat_options = 'proc_outparam_override'； SELECT、CALL调用函数时，必须要在出参位置提供实参进行调用，否则函数调用失败。
• 兼容PostgreSQL风格的函数支持重载。
• 不能创建仅形参名字不同（函数名和参数列表类型都一样）的重载函数。
• 不支持形参仅在自定义ref cursor类型和sys_refcursor类型不同的重载。
• 不支持仅返回的数据类型不同的函数重载。
• 不支持仅默认值不同的函数重载。
• 重载的函数在调用时变量需要明确具体的类型。
• 在函数内部使用未声明的变量，函数被调用时会报错。
• SELECT调用可以指定不同参数来进行同名函数调用。
• 在创建function时，不能在avg函数外面嵌套其他agg函数，或者其他系统函数。
• 新创建的函数默认会给PUBLIC授予执行权限。用户默认继承PUBLIC角色权限，因此其他用户也会有函数的执行权限并可以查看函数的定义，另外执行函数时还需要具备函数所在schema的USAGE权限。用户在创建函数时可以选择收回PUBLIC默认执行权限，然后根据需要将执行权限授予其他用户，为了避免出现新函数能被所有人访问的时间窗口，应在一个事务中创建函数并且设置函数执行权限。开启数据库对象隔离属性后，普通用户只能查看有权限执行的函数定义。
• 在函数内部调用其它无参数的函数时，可以省略括号，直接使用函数名进行调用。
• 在函数内部调用其他有出参的函数，如果在赋值表达式中调用时，需要打开guc参数 set behavior_compat_options = 'proc_outparam_override' ，并提前定义与出参类型相同的变量，然后将变量作为出参调用带有出参的其他函数，出参才能生效。否则，被调函数的出参会被忽略。
• 被授予CREATE ANY FUNCTION权限的用户，可以在用户模式下创建/替换函数。
• 函数默认为AUTHID CURRENT_USER权限，如果想将默认行为改为AUTHID DEFINER权限，需要设置guc参数behavior_compat_options='plsql_security_definer'。
• 对于PL/SQL函数，打开参数behavior_compat_options='proc_outparam_override'后，out/inout的行为会改变，函数中同时返回return和out/inout，而参数打开前仅返回return，见示例。
• 对于PL/SQL函数，打开参数behavior_compat_options='proc_outparam_override'后，有以下限制：
  • 如果同一Schema和package中已存在带有out/inout参数函数，不能再次创建带有out/inout参数的同名函数。
  • 部分场景不支持函数参与表达式（与参数打开前相比），如CALL function等。
  • 不支持调用无RETURN的函数、PERFORM function调用。
  • 打开GUC参数proc_outparam_override后，函数返回值为SETOF类型时，out出参不会生效。

语法格式

CREATE OR REPLACE FUNCTION function_name 
    ( [ { argname [ argmode ] argtype [ { DEFAULT | := | = } expression ]} [, ...] ] )
    [ RETURNS rettype | RETURNS TABLE ( { column_name column_type } [, ...] ) ]
    LANGUAGE lang_name 
    [ 
       {IMMUTABLE | STABLE | VOLATILE}
        | {SHIPPABLE | NOT SHIPPABLE}
        | [ NOT ] LEAKPROOF  
        | STRICT
        | {AUTHID DEFINER | AUTHID CURRENT_USER} 
        | not fenced
        | COST execution_cost
        | ROWS result_rows
     ][...]
    {
        AS 'definition'
    };

参数说明

• function_name

  要创建的函数名称（可以用模式修饰）。

  取值范围：字符串，要符合标识符说明。且最多为63个字符。若超过63个字符，数据库会截断并保留前63个字符当做函数名称。

  

  建议不要创建和系统函数重名的函数，否则调用时需要指定函数的Schema。

• argname

  函数参数的名称。

  取值范围：字符串，要符合标识符说明。且最多为63个字符。若超过63个字符，数据库会截断并保留前63个字符当做函数参数名称。

• argmode

  函数参数的模式。

  取值范围：IN，OUT，INOUT或VARIADIC。缺省值是IN。只有OUT模式的参数后面能跟VARIADIC。并且OUT和INOUT模式的参数不能用在RETURNS TABLE的函数定义中。

  

  VARIADIC用于声明数组类型的参数。

• argtype

  函数参数的类型。可以使用%TYPE或%ROWTYPE间接引用变量或表的类型。

• expression

  参数的默认表达式。

  

  • 在参数a_format_version值为10c和a_format_dev_version值为s2的情况下，函数参数为INOUT模式时不支持默认表达式。
  • 推荐使用方式：将所有默认值参数定义在所有非默认值参数后。
  • 调用带有默认参数的函数时，入参从左往右排入函数，如果有非默认参数的入参缺失则报错。
  • 打开 proc_uncheck_default_param 参数，调用带有默认参数的函数时，入参从左往右排入函数，允许缺省默认参数个入参，如果有非默认参数的入参缺失，则会用错位的默认值填充该参数。
  • 在参数a_format_version值为10c、a_format_dev_version值为s1和关闭proc_outparam_override，函数参数同时包括out出参和default时，默认值不可缺省。
• rettype

  函数返回值的数据类型。与argtype相同，同样可以使用%TYPE或%ROWTYPE间接引用类型。

  如果存在OUT或INOUT参数，可以省略RETURNS子句。如果没有省略，则该子句必须和输出参数所表示的结果类型一致，如果有多个输出参数，则为RECORD，否则与单个输出参数的类型相同。

  SETOF修饰词表示该函数将返回一个集合，而不是单独一项。

  

  PACKAGE外FUNCTION argtype和rettype中%TYPE不支持引用PACKAGE变量的类型。

• column_name

  字段名称。

• column_type

  字段类型。

• definition

  一个定义函数的字符串常量，含义取决于语言。它可以是一个内部函数名称、一个指向某个目标文件的路径、一个SQL查询、一个过程语言文本。

• LANGUAGE lang_name

  用以实现函数的语言的名称。可以是SQL，internal，或者是用户定义的过程语言名称。为了保证向下兼容，该名称可以用单引号（包围）。若采用单引号，则引号内必须为大写。

  

  • internel函数在定义时，如果AS指定为内部系统函数，则新创建函数的参数类型，参数个数，与返回值类型需要与内部系统函数保持一致，且需要有执行此内部系统函数的权限。
  • internal函数只支持拥有sysadmin权限的用户创建。
• IMMUTABLE

  表示该函数在给出同样的参数值时总是返回同样的结果。

• STABLE

  表示该函数不能修改数据库，对相同参数值，在同一次表扫描里，该函数的返回值不变，但是返回值可能在不同SQL语句之间变化。

• VOLATILE

  表示该函数值可以在一次表扫描内改变，因此不会做任何优化。

• SHIPPABLE|NOT SHIPPABLE

  表示该函数是否可以下推执行。预留接口，不推荐使用。

• NOT FENCED

  声明用户定义的C函数是否在非保护模式下执行。预留接口，不推荐使用。

• LEAKPROOF

  指出该函数的参数只包括返回值。LEAKPROOF只能由系统管理员设置。

• STRICT

  STRICT用于指定如果函数的某个参数是NULL，此函数总是返回NULL。如果声明了这个参数，当有NULL值参数时该函数不会被执行；而只是自动返回一个NULL结果。

• AUTHID CURRENT_USER

  表明该函数将带着调用它的用户的权限执行。该参数可以省略。

• AUTHID DEFINER

  声明该函数将以创建它的用户的权限执行。

• COST execution_cost

  用来估计函数的执行成本。

  execution_cost以cpu_operator_cost为单位。

  取值范围：>=0的数值

• ROWS result_rows

  估计函数返回的行数。用于函数返回的是一个集合。

  取值范围：>=0的数值，默认值是1000行。

  

  当在函数体中进行创建用户、修改密码或加解密等涉及密码或密钥相关操作时，系统表及日志中会记录密码或密钥的明文信息。为防止敏感信息泄露，不建议用户在函数体中进行涉及密码或密钥等敏感信息的相关操作。

示例

--定义函数为SQL查询。
m_db=# CREATE OR REPLACE FUNCTION func_add_sql(integer, integer) RETURNS bigint
    AS 'select $1 + $2;'
    LANGUAGE SQL
    IMMUTABLE
    SHIPPABLE
    STRICT
    AUTHID DEFINER
    not fenced
    COST 10000;

--利用参数名用plpgsql自增一个整数。
m_db=# CREATE OR REPLACE FUNCTION func_increment_plsql(i integer) RETURNS integer AS $$
    BEGIN
        RETURN i + 1;
    END;
    $$ LANGUAGE plpgsql;

--创建internal函数。
m_db=# CREATE OR REPLACE FUNCTION func_test(name) RETURNS text LANGUAGE INTERNAL AS 'series_internal';

--创建同名函数。
m_db=# CREATE OR REPLACE FUNCTION func_add(int) RETURNS int AS $$
    BEGIN
        RETURN $1+10;
    END;
    $$ LANGUAGE PLPGSQL;

m_db=# CREATE OR REPLACE FUNCTION func_add(int,int) RETURNS int AS $$
    BEGIN
        RETURN $1+$2;
    END;
    $$ LANGUAGE PLPGSQL;

--调用函数。
m_db=# SELECT func_add_sql(3, 7);
 func_add_sql 
--------------
           10
(1 row)

m_db=# SELECT func_increment_plsql(5);
 func_increment_plsql 
----------------------
                    6
(1 row)

m_db=# SELECT func_add(4);
 func_add 
----------
       14
(1 row)

m_db=# SELECT func_add(2,7);
 func_add 
----------
        9
(1 row)

--删除函数。
m_db=# DROP FUNCTION func_add_sql;
m_db=# DROP FUNCTION IF EXISTS func_increment_plsql;
m_db=# DROP FUNCTION func_test() CASCADE;
m_db=# DROP FUNCTION func_add(int);
m_db=# DROP FUNCTION IF EXISTS func_add(int,int) RESTRICT;

相关链接

DROP FUNCTION