PostgreSQL 教程

Appearance

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

参数的模式：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 更改函数，以便在任何参数为空时不调用该函数；相反，自动假设为 null 结果。有关详细信息，请参见 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

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

此选项不能用于完全移除支持函数，因为它必须命名一个新的支持函数。如果您需要执行此操作，请使用 CREATE OR REPLACE FUNCTION。

configuration_parameter
value

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

有关允许的参数名称和值，请参阅 SET 和 第 20 章。

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中该关键字是可选的。

另请参阅 ​

CREATE FUNCTION、DROP FUNCTION、ALTER PROCEDURE、ALTER ROUTINE