ALTER FUNCTION

更改函数的定义

英文手册覆盖始于 PostgreSQL 6.4. 来源历史与运行验证各自保留独立版本边界。

当前阅读 PG 18·选择有来源记录的版本

7.4 8.0 8.1 8.2 8.3 8.4 9.0 9.1 9.2 9.3 9.4 9.5 9.6 10 11 12 13 14 15 16 17 18 19 20

anchor: SQL-ALTERFUNCTION
file: sql-alterfunction.html
lang: en
name: ALTER FUNCTION
purpose: change the definition of a function
purpose zh: 未知
sections same as: 未知
slug: 18

语法

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 · 语法 2

ALTER FUNCTION · 语法 3

ALTER FUNCTION · 语法 4

ALTER FUNCTION · 语法 5

action

版本定义 PG 18

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
其中 action 是以下之一：

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，则会移除函数局部设置，这样该函数就会使用其环境中现有的值执行。使用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中是可选的。

另见

CREATE FUNCTION, DROP FUNCTION, ALTER PROCEDURE, ALTER ROUTINE

比较版本

完整来源事实

synopsis html

ALTER FUNCTION <em class="replaceable"><code>name</code></em> [ ( [ [ <em class="replaceable"><code>argmode</code></em> ] [ <em class="replaceable"><code>argname</code></em> ] <em class="replaceable"><code>argtype</code></em> [, ...] ] ) ]
    <em class="replaceable"><code>action</code></em> [ ... ] [ RESTRICT ]
ALTER FUNCTION <em class="replaceable"><code>name</code></em> [ ( [ [ <em class="replaceable"><code>argmode</code></em> ] [ <em class="replaceable"><code>argname</code></em> ] <em class="replaceable"><code>argtype</code></em> [, ...] ] ) ]
    RENAME TO <em class="replaceable"><code>new_name</code></em>
ALTER FUNCTION <em class="replaceable"><code>name</code></em> [ ( [ [ <em class="replaceable"><code>argmode</code></em> ] [ <em class="replaceable"><code>argname</code></em> ] <em class="replaceable"><code>argtype</code></em> [, ...] ] ) ]
    OWNER TO { <em class="replaceable"><code>new_owner</code></em> | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
ALTER FUNCTION <em class="replaceable"><code>name</code></em> [ ( [ [ <em class="replaceable"><code>argmode</code></em> ] [ <em class="replaceable"><code>argname</code></em> ] <em class="replaceable"><code>argtype</code></em> [, ...] ] ) ]
    SET SCHEMA <em class="replaceable"><code>new_schema</code></em>
ALTER FUNCTION <em class="replaceable"><code>name</code></em> [ ( [ [ <em class="replaceable"><code>argmode</code></em> ] [ <em class="replaceable"><code>argname</code></em> ] <em class="replaceable"><code>argtype</code></em> [, ...] ] ) ]
    [ NO ] DEPENDS ON EXTENSION <em class="replaceable"><code>extension_name</code></em>

<span class="phrase">where <em class="replaceable"><code>action</code></em> is one of:</span>

    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 <em class="replaceable"><code>execution_cost</code></em>
    ROWS <em class="replaceable"><code>result_rows</code></em>
    SUPPORT <em class="replaceable"><code>support_function</code></em>
    SET <em class="replaceable"><code>configuration_parameter</code></em> { TO | = } { <em class="replaceable"><code>value</code></em> | DEFAULT }
    SET <em class="replaceable"><code>configuration_parameter</code></em> FROM CURRENT
    RESET <em class="replaceable"><code>configuration_parameter</code></em>
    RESET ALL

synopsis text

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

来源引用

完整定义与证据 JSON

定义来源

center · PostgreSQL 18 · a709ab85

正文语言: zh-Hans · 1b5ca64c