©
本文檔使用 php中文網手册 發布
CREATE FUNCTION
Name
CREATE FUNCTION -- 定义一个新函数Synopsis
CREATE [ OR REPLACE ] FUNCTION
name ( [ [ argmode ] [ argname ] argtype [ { DEFAULT | = } default_expr ] [, ...] ] )
[ RETURNS rettype
| RETURNS TABLE ( column_name column_type [, ...] ) ]
{ LANGUAGE lang_name
| WINDOW
| IMMUTABLE | STABLE | VOLATILE
| CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT
| [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER
| COST execution_cost
| ROWS result_rows
| SET configuration_parameter { TO value | = value | FROM CURRENT }
| AS 'definition'
| AS 'obj_file', 'link_symbol'
} ...
[ WITH ( attribute [, ...] ) ]
描述
CREATE FUNCTION 定义一个新的函数。 CREATE OR REPLACE FUNCTION将要么创建一个新函数， 要么替换现有的定义。 为了能够定义一个函数，用户必须语言有USAGE权限。
如果包含了一个模式名，那么函数就在指定的模式中创建。否则 它会在当前模式中创建。 新函数的名称不能通过同一模式中的相同输入参数类型匹配任何现有功能。 然而，不同参数类型的功能可以共享一个名称(此处名为 overloading)。
为了替换一个已有函数的当前定义，使用 CREATE OR REPLACE FUNCTION。要这样改变一个函数的 名称或者参数类型是不可能的（若你尝试过，实际上您会创建一个新的不同的函数）。 另外，CREATE OR REPLACE FUNCTION不会让你改变一个存在 函数的返回类型。为了做到那些，你必须删除并重新创建函数。 （当你使用OUT参数，那意味着您不能更改任何参数的类型，除了通过 删除该函数以外。）
当CREATE OR REPLACE FUNCTION 用于替换一个已有函数，函数的 所有权限和学科权限不会改变。所有其他函数属性都指定了在命令中指定或者 隐含的数值。你必须拥有此函数来替换它（这包括成为所属关系的一员）。
如果你删除然后重建一个函数，新函数和旧函数将是不同的实体； 你就需要删除现有引用了老函数的规则、视图、触发器等等。 使用CREATE OR REPLACE FUNCTION可以在不 破坏引用该函数的对象的前提下修改函数定义。 另外，ALTER FUNCTION可以用于更改一个已有函数的大多数辅助属性。
创建这个函数的用户将成为函数的所有者。
Parameters
- name
要创建的函数名字(可以用模式修饰)
- argmode
一个参数的模式是：IN, OUT, INOUT,或者VARIADIC. 若被遗漏，缺省为IN。只有OUT参数 可以遵循一个VARIADIC。另外， OUT and INOUT参数不能RETURNS TABLE 符号同时使用。
- argname
一个参数的名字。有些语言(目前只有 PL/pgSQL)允许你在函数体里使用 参数名字。对于其他语言，一个输入参数的名称仅仅是额外的文档， 就函数本身而言；但是你可以在调用一个函数来提高可读性时使用输入 参数名称（参阅Section 4.3）； 总之，一个输出参数的名称是重要的，因为它在结果行类型中定义了列名称。 (如果你忽略了输出参数的名称，系统将会选择一个缺省列名称。）
- argtype
-
函数参数的数据类型（可以有模式修饰），若存在。参数类型可以是基础、 符合或者域类型，或者可以引用一个表列的类型。
基于实现语言，也可以允许声明"pseudotypes"，例如cstring. 假类型表明实际参数类型要么是不完全指定，要么是在普通SQL数据类型组之外。
一列的类型通过写table_name 来引用。column_name%TYPE。 使用该特性有时可以帮助使一个函数独立于表定义的改变。
- default_expr
若未声明参数，表达式可用作缺省值。表达式必须是对参数的自变量类型可强制的。 只有输入（包括INOUT) 参数可以有一个默认值。所有跟着一个 有缺省值的参数的输入参数也必须有缺省值。
- rettype
-
返回数据类型（可以有模式修饰）。返回类型可以是一个基础、符合或者域类型， 或者可以参照表列的类型。基于实现语言，也可以允许声明"pseudotypes"， 例如cstring。若函数没能返回一个值，则指定void为返回类型。
当有OUT或者INOUT参数时，RETURNS 子句可以忽略。如果存在，必须与输出参数暗示的结果类型相一致： 若有多个输出参数则为RECORD，或者是单一输参数的相同类型。
SETOF修饰词表示该函数将返回一个集合， 而不是单独一项。
列的类型是通过写 table_name.column_name%TYPE 来参照的。
- column_name
在RETURNS TABLE语法中的一个输出列的名称。 这是生命另一个命名的OUT参数的有效途径，除了 RETURNS TABLE也蕴含RETURNS SETOF。
- column_type
RETURNS TABLE语法中的一个输出列的数据类型。
- lang_name
函数实施语言的名称。可以是SQL, C, internal或者是一个用户定义的程序语言的名称。 为了向后兼容，名称可以通过单引号括起来。
- WINDOW
WINDOW表明函数是window function 而不是一个普通的函数。这目前仅仅对用C写的函数有用。 WINDOW属性可以在替换现有的函数定义时更改。
-
IMMUTABLE
STABLE
VOLATILE -
这些属性告诉系统把对该函数的多次调用替换成一次是否安全， 主要用于运行时优化。缺省是VOLATILE。
IMMUTABLE表示该函数不能修改数据库，并且 在给出同样的参数值时总是返回同样的结果；也就是说，它不查询 数据库或者只使用那些没有出现在参数列表里的信息。如果给出这 个选项，那么任何全部使用常数对该函数的调用都将立即替换为该 函数的值。
STABLE表明函数不能调整数据库，并且在一个独立表扫 描中，将会始终对相同的参数值返回相同的结果，但是其结果会在SQL语句上 有所改变。这是函数的恰当选择，而且函数的结果取决于数据库查找的、参数变量 （如当前时区）等等。（ 希望查询当前命令刚改的行，这对于AFTER 触发器来说是不恰当的。）另外还要注意：函数的
current_timestamp类是稳定的，尽管它们的值不会在事务内改变。VOLATILE表示该函数值甚至可以在一次表扫描内改变， 因此不会做任何优化。只有很少的数据库函数在这个概念上是易变的； 一些例子是random(),currval(), timeofday()。请注意任何有副作用的函数都必需列为易变类， 即使其结果相当有规律也应该这样，这样才能避免它被优化；一个例子就是 setval()。
更多细节，请参阅节Section 35.6。
-
CALLED ON NULL INPUT
RETURNS NULL ON NULL INPUT
STRICT -
CALLED ON NULL INPUT(缺省)表明该函数在自己的 某些参数是 NULL 的时候还是可以按照正常的方式调用。函数的作者必须 负责检查 NULL 以及相应地做出反应。
RETURNS NULL ON NULL INPUT或 STRICT表明如果它的任何参数是NULL ， 此函数总是返回 NULL 。如果声明了这个参数，则如果存在 NULL 参数时不会执行该函数；而只是自动假设一个NULL结果。
-
[EXTERNAL] SECURITY INVOKER
[EXTERNAL] SECURITY DEFINER -
SECURITY INVOKER(缺省)表明该函数将带 着调用它的用户的权限执行。SECURITY DEFINER 声明该函数将以创建它的用户的权限执行。
关键字EXTERNAL的目的是和 SQL 兼容， 但是它是可选的，因为这个特性适合于所有函数，而不仅仅外部函数。
- execution_cost
正值给出函数的预计执行成本，以cpu_operator_cost 为单位。如果函数返回了一个集，这就是每个返回行的成本。如果没有声明成本， 1单位假定为C语言和内部函数，而100单位为所有其他语言的函数。较大的数值 使得规划器试着不需要地频繁的去避免评估函数。
- result_rows
A positive number giving the estimated number of rows that the planner should expect the function to return. This is only allowed when the function is declared to return a set. The default assumption is 1000 rows. 正数给出了规划器希望函数返回的估计行数。这仅仅在函数声明返回一个集时 是允许的。默认假设为1000行。
-
configuration_parameter
value -
SET子句使特定配置参数在函数被输入时被设置为指定的值， 然后当函数退出时恢复到之前的值。SET FROM CURRENT保存 参数的会话的当前值为输入函数时使用的值。
如果一个SET子句附属于一个函数，那么一个在函数内为同以变量 执行的SET LOCAL命令的影响限制在函数内：配置参数优先值 仍然在函数退出时存储。然而，一个普通的SET命令（无 LOCAL）重写SET子句，正如它会为一个先前 SET LOCAL命令所做的：这样一个命令的影响将会在函数退出后继续， 除非当前事务回滚。
参阅SET和Chapter 18 获取更多关于允许的参数名称和数值的相关信息。
- definition
-
一个字符串常量定义函数；含义依托于语言。可以是一个内部函数名称， 对象文件的路径、一个SQL命令，或者过程语言的文本。
使用美元引用（参阅Section 4.1.2.4） 来写函数定义字符串通常是很有效的，而不是普通的单引号语法。 没有美元引用，任何函数定义中的单引号或者反斜杠必须通过对加倍来 使他们逃逸。
- obj_file, link_symbol
-
这个形式的AS子句用于在函数的 C 源文件里的名字和 SQL 名字不同时可动态加载 C 语言函数。字符串 obj_file是包含可动态 加载对象的文件名，而link_symbol 是函数的链接符号，也就是该函数在 C 源文件里的名字。如果省略了链接符号， 那么就假设它和被定义的 SQL 函数同名。
当重复指向相同对象文件的CREATE FUNCTION调用时， 该文件仅在每次会话时加载一次。为了卸载和重新加载文件（可能在开发期间）， 开始一个新会话。
- attribute
-
指定函数的可选内容的历史方法。以下属性可以出现在这里：
- isStrict
等效于STRICT或 RETURNS NULL ON NULL INPUT
- isCachable
isCachable是IMMUTABLE 的过时的等效物；不过出于向下兼容，仍然接受它。
属性名是大小写无关的。
请参阅节Section 35.3获取更多关于书写函数的信息。
Overloading
PostgreSQL允许函数overloading； 也就是说，只要有不同的输入参数类型，相同的名称可以用于不同的函数。然而，所有函数 的C名称必须是不同的，所以你必须给超载的C函数不同的C名称（例如，使用参数类型 作为C名称的一部分）。
如果两个函数同名，并且input参数类型也相同，那么 就认为这两个函数是一样的，忽略所有OUT参数。因此， 下面的声明是冲突的：
CREATE FUNCTION foo(int) ... CREATE FUNCTION foo(int, out text) ...
有不同参数类型列表的函数在创建时认为是不冲突的，但是如果提供缺省值 可能会在使用时冲突。例如，考虑
CREATE FUNCTION foo(int) ... CREATE FUNCTION foo(int, int default 42) ...
一个调用foo(10)将会失败，由于函数应该被调用的歧义。
Notes
完整的SQL类型语法对输入参数和返回值来说是允许的。 然而，类型指定的一些详细信息（例如：类型numeric的精度域） 是根本函数执行的相应度并被CREATE FUNCTION命令悄然 吞下。
当用CREATE OR REPLACE FUNCTION替换现有函数时，在更改 参数名称时有一些限制。你不能改变这些已经分配给所有输入参数的名称 （尽管你可以将名称添加到之前什么都没有的参数）。若有多于一个输出参数， 你不能改变输出参数的名称，因为那会改变描述函数结构的匿名符合类型的列名称。 这些限制是用来保证已有函数调用在替换时不停止工作。
If a function is declared STRICT with a VARIADIC argument, the strictness check tests that the variadic array as a whole is non-null. The function will still be called if the array has null elements. 若一个函数通过VARIADIC参数声明STRICT，严格检查测试 可变参数的数组as a whole是非空的。若数组有空元素则函数将仍被 调用。
Examples
这里是一些简单的例子，用于帮助你开始掌握这个命令。更多信息和例子， 参阅节Section 35.3。
CREATE FUNCTION add(integer, integer) RETURNS integer
AS 'select $1 + $2;'
LANGUAGE SQL
IMMUTABLE
RETURNS NULL ON NULL INPUT;
利用参数名用PL/pgSQL自增一个整数：
CREATE OR REPLACE FUNCTION increment(i integer) RETURNS integer AS $$
BEGIN
RETURN i + 1;
END;
$$ LANGUAGE plpgsql;
返回一个包含多个输出参数的记录：
CREATE FUNCTION dup(in int, out f1 int, out f2 text)
AS $$ SELECT $1, CAST($1 AS text) || ' is text' $$
LANGUAGE SQL;
SELECT * FROM dup(42);
你可以通过命名明确的复合类型的访法冗长地干同样的事情：
CREATE TYPE dup_result AS (f1 int, f2 text);
CREATE FUNCTION dup(int) RETURNS dup_result
AS $$ SELECT $1, CAST($1 AS text) || ' is text' $$
LANGUAGE SQL;
SELECT * FROM dup(42);
返回多个列的另一种方法是使用一个TABLE函数：
CREATE FUNCTION dup(int) RETURNS TABLE(f1 int, f2 text)
AS $$ SELECT $1, CAST($1 AS text) || ' is text' $$
LANGUAGE SQL;
SELECT * FROM dup(42);
然而，一个TABLE函数是不同于前面的例子的，因为它会返回一个 记录的set，而不仅仅是一个记录。
写SECURITY DEFINER函数安全性
因为一个SECURITY DEFINER函数执行创建它的用户的权限， 因此需要谨慎以确保该函数不被滥用。为了安全，search_path 应该被用来排除不可信用户可写的任何模式。这可以阻止恶意用户创建伪装的 函数所用的对象。在这方面临时表模式是特别重要的，该模式在默认情况下是 第一个被搜索的，并且通常是任何人都可写的。通过强制临时模式最后被查询可以 得到安全的布置。要这样做，就要将pg_temp写作search_path 中的最后一条记录。下面这个函数阐明了安全使用方法：
CREATE FUNCTION check_password(uname TEXT, pass TEXT)
RETURNS BOOLEAN AS $$
DECLARE passed BOOLEAN;
BEGIN
SELECT (pwd = $2) INTO passed
FROM pwds
WHERE username = $1;
RETURN passed;
END;
$$ LANGUAGE plpgsql
SECURITY DEFINER
-- Set a secure search_path: trusted schema(s), then 'pg_temp'.
SET search_path = admin, pg_temp;
在PostgreSQL8.3版本之前，SET 选项是无法使用的，所以旧函数可能可能会包含相当复杂的逻辑来保存、 设置或者还原search_path。SET选项用于此目的是 非常容易的。
要注意的另一点是：在默认情况下，执行权限为新创建的函数授予PUBLIC （参阅GRANT获取更多信息）。您常常希望将安全定义函数 的使用仅仅限制到一部分用户。要那样做，您必须撤销默认PUBLIC权限 然后选择性地授予执行权限。为了避免有一个新函数开放访问的窗口，需要创建它 并且设置权限在单一事务中。例如：
BEGIN; CREATE FUNCTION check_password(uname TEXT, pass TEXT) ... SECURITY DEFINER; REVOKE ALL ON FUNCTION check_password(uname TEXT, pass TEXT) FROM PUBLIC; GRANT EXECUTE ON FUNCTION check_password(uname TEXT, pass TEXT) TO admins; COMMIT;
兼容性
它和 SQL:1999 里的CREATE FUNCTION命令类似但是不兼容。 属性和可以使用的语言都是不可移植的。
为了和一些其它的数据库系统兼容，argmode 可以在 argname 之前或者之后写， 但是只有第一种访法是标准兼容的。
SQL标准不声明参数默认值。有DEFAULT关键字的语法 来自于Oracle，并且有些本着标准的精神：SQL/PSM将它用于变量默认值。 =的语法用于T-SQL和Firebird。