支持的版本: 当前 (17) / 16 / 15 / 14 / 13
开发版本: devel
不支持的版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4

ALTER FUNCTION

ALTER FUNCTION — 更改函数的定义

概要

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

参数的模式: INOUTINOUTVARIADIC。如果省略,则默认为 IN。请注意,ALTER FUNCTION 实际上并不关注 OUT 参数,因为只需要输入参数来确定函数的标识。因此,列出 ININOUTVARIADIC 参数就足够了。

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 更改函数,使其在某些或所有参数为 null 时被调用。RETURNS NULL ON NULL INPUTSTRICT 更改函数,使其在任何参数为 null 时不被调用;而是自动假定为 null 结果。有关详细信息,请参见 CREATE FUNCTION

IMMUTABLE
STABLE
VOLATILE

将函数的易失性更改为指定的设置。有关详细信息,请参见 CREATE FUNCTION

[ EXTERNAL ] SECURITY INVOKER
[ EXTERNAL ] SECURITY DEFINER

更改函数是否为安全定义者。关键字 EXTERNAL 为 SQL 一致性而被忽略。有关此功能的更多信息,请参见 CREATE FUNCTION

PARALLEL

更改函数是否被认为是并行安全的。有关详细信息,请参见 CREATE FUNCTION

LEAKPROOF

更改函数是否被认为是防泄漏的。有关此功能的更多信息,请参见 CREATE FUNCTION

COST execution_cost

更改函数的估计执行成本。有关详细信息,请参见 CREATE FUNCTION

ROWS result_rows

更改集合返回函数返回的估计行数。有关详细信息,请参见 CREATE FUNCTION

SUPPORT support_function

设置或更改用于此函数的计划器支持函数。有关详细信息,请参见 第 36.11 节。您必须是超级用户才能使用此选项。

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

configuration_parameter
value

添加或更改函数调用时要对配置参数进行的赋值。如果 valueDEFAULT,或者等效地使用 RESET,则会删除函数本地设置,以便函数以其环境中存在的值执行。使用 RESET ALL 清除所有函数本地设置。SET FROM CURRENT 保存 ALTER FUNCTION 执行时参数的当前值,作为进入函数时要应用的值。

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

RESTRICT

为符合 SQL 标准而被忽略。

示例

integer 类型的函数 sqrt 重命名为 square_root

ALTER FUNCTION sqrt(integer) RENAME TO square_root;

integer 类型的函数 sqrt 的所有者更改为 joe

ALTER FUNCTION sqrt(integer) OWNER TO joe;

integer 类型的函数 sqrt 的模式更改为 maths

ALTER FUNCTION sqrt(integer) SET SCHEMA maths;

integer 类型的函数 sqrt 标记为依赖于扩展 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 中是可选的。

提交更正

如果您发现文档中任何不正确、与您使用特定功能的经验不符或需要进一步澄清的地方,请使用此表单报告文档问题。