描述

CREATE FUNCTION定义一个新函数。CREATE OR REPLACE FUNCTION将创建一个新函数，或者替换现有定义。

如果包含模式名，则函数将在指定的模式中创建。否则将在当前模式中创建。新函数的名称不能与同一模式中具有相同输入参数类型的任何现有函数匹配。然而，不同参数类型的函数可以共享一个名称（这称为 重载）。

要替换一个现有函数的当前定义，可以使用CREATE OR REPLACE FUNCTION。但不能用这种方式更改函数的名称或者参数类型（如果尝试这样做，实际上就会创建一个新的不同函数）。此外，CREATE OR REPLACE FUNCTION也不允许更改现有函数的返回类型。要做到这一点，必须删除该函数并重新创建。（使用OUT参数时，这意味着除非删除该函数，否则不能更改任何OUT参数的名称或类型。）

如果删除函数后再重新创建，新函数就不再是旧函数的同一实体；你将必须删除引用旧函数的现有规则、视图、触发器等。使用CREATE OR REPLACE FUNCTION可以在不破坏引用该函数的对象的情况下更改函数定义。

创建该函数的用户将成为该函数的拥有者。

参数

注解

有关编写函数的详细信息，请参阅第 33.3 节。

允许使用完整的SQL类型语法来声明输入参数和返回值。不过，类型规范的某些细节（例如numeric类型的精度字段）是底层函数实现的责任，CREATE FUNCTION命令会静默地忽略它们（即不识别也不强制）。

PostgreSQL 允许函数重载；也就是说，只要输入参数类型不同，同一个名称就可以用于多个不同的函数。但是，所有函数的 C 名称都必须不同，因此必须为重载的 C 函数指定不同的 C 名称（例如，把参数类型用作 C 名称的一部分）。

如果两个函数具有相同的名称和输入参数类型，它们被认为相同（不考虑任何OUT参数）。因此这些声明会冲突：

CREATE FUNCTION foo(int) ...
CREATE FUNCTION foo(int, out text) ...

当重复的CREATE FUNCTION调用引用同一个对象文件时，该文件在每个会话中只装载一次。要卸载并重新装载该文件（例如在开发期间），请启动一个新会话。

使用DROP FUNCTION可以移除用户定义的函数。

使用美元引用（见第 4.1.2.2 节）来书写函数定义字符串通常会更有帮助，而不是使用普通的单引号语法。如果没有美元引用，函数定义中的任何单引号或者反斜线都必须用双写来转义。

要定义函数，用户必须具有该语言上的USAGE权限。

当CREATE OR REPLACE FUNCTION被用来替换一个现有函数时，该函数的拥有权和权限不会改变。所有其他的函数属性会按照该命令中指定的或者隐含的值赋值。必须拥有（包括成为拥有角色的成员）该函数才能替换它。

示例

下面给出一些简单示例，帮助你开始使用。有关更多信息和示例，请参见第 33.3 节。

CREATE FUNCTION add(integer, integer) RETURNS integer
    AS 'select $1 + $2;'
    LANGUAGE SQL
    IMMUTABLE
    RETURNS NULL ON NULL INPUT;

在PL/pgSQL中，使用参数名把一个整数加 1：

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);

安全地编写SECURITY DEFINER函数

因为 SECURITY DEFINER 函数要以创建它的用户的权限执行，所以必须小心确保该函数不会被滥用。出于安全考虑，应将 search_path 设置为排除任何可被不受信任用户写入的模式。这可以防止恶意用户创建对象来遮蔽该函数使用的对象。在这方面尤其重要的是临时表模式；默认情况下它最先被搜索，而且通常任何人都可写。一个安全的安排是强制把临时模式放到搜索顺序的最后。要做到这一点，应把 pg_temp 写成 search_path 中的最后一项。下面这个函数展示了安全用法：

CREATE FUNCTION check_password(uname TEXT, pass TEXT)
RETURNS BOOLEAN AS $$
DECLARE passed BOOLEAN;
        old_path TEXT;
BEGIN
        -- Save old search_path; notice we must qualify current_setting
        -- to ensure we invoke the right function
        old_path := pg_catalog.current_setting('search_path');

        -- Set a secure search_path: trusted schemas, then 'pg_temp'.
        -- We set is_local = true so that the old value will be restored
        -- in event of an error before we reach the function end.
        PERFORM pg_catalog.set_config('search_path', 'admin, pg_temp', true);

        -- Do whatever secure work we came for.
        SELECT  (pwd = $2) INTO passed
        FROM    pwds
        WHERE   username = $1;

        -- Restore caller's search_path
        PERFORM pg_catalog.set_config('search_path', old_path, true);

        RETURN passed;
END;
$$ LANGUAGE plpgsql SECURITY DEFINER;

兼容性

CREATE FUNCTION命令在 SQL:1999 及更高版本中定义。PostgreSQL版本与其相似，但并不完全兼容。这些属性和可用的不同语言都不具备可移植性。

为与某些其他数据库系统兼容，argmode可以写在argname之前或之后，但只有前一种写法符合标准。

另见