PostgreSQL 中文参考文档
🌐 英文原版 官方 ↗

ALTER FUNCTION

ALTER FUNCTION — 更改一个函数的定义

Synopsis

ALTER FUNCTION name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ]
    action [ ... ] [ RESTRICT ]
ALTER FUNCTION name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ]
    RENAME TO new_name
ALTER FUNCTION name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ]
    OWNER TO { new_owner | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
ALTER FUNCTION name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ]
    SET SCHEMA new_schema
ALTER FUNCTION name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ]
    [ NO ] DEPENDS ON EXTENSION extension_name

where action is one of:

    CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT
    IMMUTABLE | STABLE | VOLATILE
    [ NOT ] LEAKPROOF
    [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER
    PARALLEL { UNSAFE | RESTRICTED | SAFE }
    COST execution_cost
    ROWS result_rows
    SUPPORT support_function
    SET configuration_parameter { TO | = } { value | DEFAULT }
    SET configuration_parameter FROM CURRENT
    RESET configuration_parameter
    RESET ALL

描述

ALTER FUNCTION 更改一个函数的定义。

你必须拥有该函数才能使用 ALTER FUNCTION。要更改函数的模式,你还必须在新模式上拥有 CREATE 特权。要更改拥有者,你必须能够 SET ROLE 到新的拥有角色,并且该角色必须在函数所在模式上拥有 CREATE 特权。(这些限制强制确保:更改拥有者不会让你做到删除并重建函数做不到的事情。不过,超级用户无论如何都可以更改任何函数的拥有权。)

参数

name

一个现有函数的名称(可以用模式限定)。如果没有指定参数列表,则该名称必须在其模式中唯一。

argmode

参数的模式:IN、OUT、INOUT 或 VARIADIC。如果省略,默认为 IN。注意 ALTER FUNCTION 实际上并不关注 OUT 参数,因为确定函数的身份只需要输入参数。因此,列出 IN、INOUT 和 VARIADIC 参数就足够了。

argname

参数的名称。注意 ALTER FUNCTION 实际上并不关注参数名称,因为确定函数的身份只需要参数的数据类型。

argtype

函数参数的数据类型(可以用模式限定),如果有的话。

new_name

函数的新名称。

new_owner

函数的新拥有者。注意,如果该函数被标记为 SECURITY DEFINER,那么它此后将以新的拥有者身份执行。

new_schema

函数的新模式。

DEPENDS ON EXTENSION extension_name
NO DEPENDS ON EXTENSION extension_name

这种形式把该函数标记为依赖于该扩展;如果指定了 NO,则标记为不再依赖于该扩展。被标记为依赖于某个扩展的函数在该扩展被删除时会被删除,即使没有指定 CASCADE 也是如此。一个函数可以依赖于多个扩展,并且只要其中任何一个扩展被删除,它就会被删除。

CALLED ON NULL INPUT
RETURNS NULL ON NULL INPUT
STRICT

CALLED ON NULL INPUT 更改该函数,使其在某些或全部参数为空时也会被调用。RETURNS NULL ON NULL INPUT 或 STRICT 更改该函数,使其在任何参数为空时都不会被调用,而是自动假定返回空结果。更多信息请参见 CREATE FUNCTION。

IMMUTABLE
STABLE
VOLATILE

把函数的易变性更改为指定的设置。详情请参见 CREATE FUNCTION。

[ EXTERNAL ] SECURITY INVOKER
[ EXTERNAL ] SECURITY DEFINER

更改该函数是否为安全定义者。为了符合 SQL 标准,关键字 EXTERNAL 会被忽略。有关这种能力的更多信息请参见 CREATE FUNCTION。

PARALLEL

更改该函数是否被认为对于并行执行是安全的。详情请参见 CREATE FUNCTION。

LEAKPROOF

更改该函数是否被认为是防泄漏的。有关这种能力的更多信息请参见 CREATE FUNCTION。

COST execution_cost

更改函数的估计执行代价。更多信息请参见 CREATE FUNCTION。

ROWS result_rows

更改集合返回函数所返回行数的估计值。更多信息请参见 CREATE FUNCTION。

SUPPORT support_function

设置或更改用于该函数的规划器支持函数。详情请参见 Section 36.11。你必须拥有超级用户权限才能使用此选项。

此选项不能用来完全移除支持函数,因为它必须指定一个新的支持函数。如果需要这样做,请使用 CREATE OR REPLACE FUNCTION。

configuration_parameter
value

添加或更改在函数被调用时对配置参数所做的赋值。如果 value 是 DEFAULT,或者等价地使用了 RESET,则函数本地的设置将被移除,这样函数将以存在于其环境中的值执行。使用 RESET ALL 可以清除所有函数本地的设置。SET FROM CURRENT 会把执行 ALTER FUNCTION 时该参数的当前值保存下来,作为进入函数时要应用的值。

有关允许的参数名称和值的更多信息,请参见 SET 和 Chapter 19。

RESTRICT

为了符合 SQL 标准而被忽略。

示例

把函数 sqrt(integer 类型)重命名为 square_root:

ALTER FUNCTION sqrt(integer) RENAME TO square_root;

把函数 sqrt(integer 类型)的拥有者更改为 joe:

ALTER FUNCTION sqrt(integer) OWNER TO joe;

把函数 sqrt(integer 类型)的模式更改为 maths:

ALTER FUNCTION sqrt(integer) SET SCHEMA maths;

把函数 sqrt(integer 类型)标记为依赖于扩展 mathlib:

ALTER FUNCTION sqrt(integer) DEPENDS ON EXTENSION mathlib;

调整为一个函数自动设置的搜索路径:

ALTER FUNCTION check_password(text) SET search_path = admin, pg_temp;

为一个函数禁用 search_path 的自动设置:

ALTER FUNCTION check_password(text) RESET search_path;

此后该函数将以其调用者所使用的任何搜索路径执行。

兼容性

此语句与 SQL 标准中的 ALTER FUNCTION 语句部分兼容。标准允许修改函数的更多属性,但没有提供重命名函数、把函数变成安全定义者、把配置参数值附加到函数上,或者更改函数的拥有者、模式或易变性的能力。标准还要求使用 RESTRICT 关键字,而在 PostgreSQL 中它是可选的。

另请参阅

CREATE FUNCTION, DROP FUNCTION, ALTER PROCEDURE, ALTER ROUTINE