描述

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

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

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

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

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

参数

注意

关于编写函数的更多信息，请参考第 33.3 节。

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

PostgreSQL允许函数重载；也就是说，只要几个不同函数的参数类型不同，它们就可以使用同一个名称。但是，所有函数的 C 名称必须不同，因此你必须给重载的 C 函数起不同的 C 名（例如，把参数类型用作 C 名的一部分）。

当多次CREATE FUNCTION调用引用同一个对象文件时，该文件只会被装载一次。要卸载并重新装载该文件（也许是在开发期间），可以使用LOAD命令。

使用DROP FUNCTION 删除用户定义的函数。

函数定义中的任何单引号或反斜杠都必须通过双写来转义。

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

示例

这里有一个帮助你入门的简单示例。更多信息和示例见第 33.3 节。

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

安全地编写SECURITY DEFINER函数

由于SECURITY DEFINER函数以创建它的用户的权限执行，需要小心确保函数不被滥用。出于安全考虑，应把search_path设置为排除任何可被不受信任用户写入的模式。这可以防止恶意用户创建遮蔽函数所用对象的对象。在这方面特别重要的是临时表模式，它默认最先被搜索，而且通常任何人都可以写。可以通过强制临时模式最后被搜索来获得安全的安排。为此，把pg_temp写成search_path中的最后一项。下面的函数展示了安全用法：

CREATE FUNCTION check_password(TEXT, 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命令在 SQL99 中定义。 PostgreSQL的版本与之类似但不完全兼容。属性不可移植，各种可用语言也一样。

另见

ALTER FUNCTION, DROP FUNCTION, GRANT, LOAD, REVOKE, createlang