CREATE FUNCTION

描述

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

请参阅节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。

又见