描述

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

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

注意

关于编写外部函数的更多信息，请参考 PostgreSQL 程序员指南 中关于通过函数扩展 PostgreSQL主题的章节。

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

PostgreSQL允许函数重载； 也就是说，只要几个不同函数的参数类型不同，它们就可以使用同一个名称。但对 internal 和 C 语言函数，必须谨慎使用这一设施。

两个internal 函数如果 C 名相同，会在链接时引发错误。要解决这个问题，可以给它们起不同的 C 名（例如，把参数类型用作 C 名的一部分），然后在CREATE FUNCTION的 AS 子句中指定这些名字。 如果 AS 子句留空，则CREATE FUNCTION 假定函数的 C 名与 SQL 名相同。

类似地，当用多个 C 语言函数重载 SQL 函数名时，给函数的每个 C 语言实例起一个不同的名字，然后在 CREATE FUNCTION语法中使用AS子句的另一种形式，为每个重载的 SQL 函数选择合适的 C 语言实现。

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

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

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

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

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

默认情况下，只有函数的拥有者（创建者）有权执行它。其他用户必须被授予该函数上的EXECUTE权限才能使用它。

示例

创建一个简单的 SQL 函数：

CREATE FUNCTION one() RETURNS integer
    AS 'SELECT 1 AS RESULT;'
    LANGUAGE SQL;

SELECT one() AS answer;
 answer 
--------
      1

下一个示例通过调用一个用户创建的名为funcs.so的共享库（扩展名可能因平台而异）中的例程来创建一个 C 函数。共享库文件会在服务器的动态库搜索路径中寻找。这个特定的例程计算一个校验位，如果函数参数中的校验位正确就返回 true。它用于 CHECK 约束中。

CREATE FUNCTION ean_checkdigit(char, char) RETURNS boolean
    AS 'funcs' LANGUAGE C;
    
CREATE TABLE product (
    id        char(8) PRIMARY KEY,
    eanprefix char(8) CHECK (eanprefix ~ '[0-9]{2}-[0-9]{5}')
                      REFERENCES brandname(ean_prefix),
    eancode   char(6) CHECK (eancode ~ '[0-9]{6}'),
    CONSTRAINT ean    CHECK (ean_checkdigit(eanprefix, eancode))
);

下一个示例创建一个把用户定义类型 complex 转换为内建类型 point 的函数。该函数由一个从 C 源码编译出的动态载入对象实现（我们展示指定共享对象文件绝对路径名这种现已废弃的替代方式）。为了让PostgreSQL自动找到类型转换函数，SQL 函数必须与返回类型同名，因此重载不可避免。在 SQL 定义中使用AS子句的第二种形式来重载函数名：

CREATE FUNCTION point(complex) RETURNS point
    AS '/home/bernie/pgsql/lib/complex.so', 'complex_to_point'
    LANGUAGE C STRICT;

该函数的 C 声明可以是：

Point * complex_to_point (Complex *z)
{
        Point *p;

        p = (Point *) palloc(sizeof(Point));
        p->x = z->x;
        p->y = z->y;
                
        return p;
}

注意该函数被标记为“strict”；这使我们可以跳过函数体中的 NULL 输入检查。

安全地编写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的版本与之类似但不完全兼容。属性不可移植，各种可用语言也一样。

另见

DROP FUNCTION, GRANT, LOAD, REVOKE, createlang, PostgreSQL 程序员指南