2024年9月26日： PostgreSQL 17 发布！
支持版本：当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本：devel
不支持的版本：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
上一个  上级 SQL 命令 主页  下一个

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 更改函数，使其在部分或全部参数为 null 时被调用。RETURNS NULL ON NULL INPUT 或 STRICT 更改函数，使其在任何参数为 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

添加或更改在调用函数时要对配置参数进行的赋值。如果 value 为 DEFAULT 或等效地使用 RESET，则函数本地设置将被删除，因此函数将使用其环境中存在的 value 执行。使用 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 中是可选的。

上一个  上级  下一个
ALTER FOREIGN TABLE  主页  ALTER GROUP

提交更正

如果您在文档中看到任何不正确的内容、与您对特定功能的体验不符或需要进一步说明，请使用 此表格 报告文档问题。