SQL COMMAND · 函数与过程
ALTER FUNCTION
更改函数的定义
ALTER函数与过程引入 10(基线)现存至 20 devel3 次语法变更
- 动词
ALTER- 对象
FUNCTION- 分组
- 函数与过程
- 引入版本
- 10(基线)
- 状态
- 现存
- 语法变更次数
- 3
- 手册小节数
- 5
版本轨迹
相对 PostgreSQL 17 无变化。
语法铁道图 PostgreSQL 18
沿轨道从左向右阅读,分岔表示选择,绕行表示可选,回环表示重复。方框为参数,点击带下划线的参数可展开子规则。
ALTER FUNCTION · 语法 2
ALTER FUNCTION · 语法 3
ALTER FUNCTION · 语法 4
ALTER FUNCTION · 语法 5
action
语法概要
ALTER FUNCTIONname[ ( [ [argmode] [argname]argtype[, ...] ] ) ]action[ ... ] [ RESTRICT ] ALTER FUNCTIONname[ ( [ [argmode] [argname]argtype[, ...] ] ) ] RENAME TOnew_nameALTER FUNCTIONname[ ( [ [argmode] [argname]argtype[, ...] ] ) ] OWNER TO {new_owner| CURRENT_ROLE | CURRENT_USER | SESSION_USER } ALTER FUNCTIONname[ ( [ [argmode] [argname]argtype[, ...] ] ) ] SET SCHEMAnew_schemaALTER FUNCTIONname[ ( [ [argmode] [argname]argtype[, ...] ] ) ] [ NO ] DEPENDS ON EXTENSIONextension_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 } COSTexecution_costROWSresult_rowsSUPPORTsupport_functionSETconfiguration_parameter{ TO | = } {value| DEFAULT } SETconfiguration_parameterFROM CURRENT RESETconfiguration_parameterRESET 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 EXTENSIONextension_nameNO DEPENDS ON EXTENSIONextension_name这种形式会将函数标记为依赖于该扩展;如果指定了
NO, 则表示不再依赖该扩展。被标记为依赖扩展的函数会在扩展被删除时一并删除, 即使没有指定CASCADE也是如此。一个函数可以依赖 多个扩展,其中任意一个扩展被删除时,该函数都会被删除。CALLED ON NULL INPUTRETURNS NULL ON NULL INPUTSTRICTCALLED ON NULL INPUT将该函数改为在其部分 或全部参数为 null 时仍会被调用。RETURNS NULL ON NULL INPUT或STRICT将该函数改为只要任一参数为 null 就不调用, 而是自动假定结果为 null。详见CREATE FUNCTION。IMMUTABLESTABLEVOLATILE将该函数的易变性更改为指定的设置。详见 CREATE FUNCTION。
[ EXTERNAL ] SECURITY INVOKER[ EXTERNAL ] SECURITY DEFINER更改该函数是否为安全性定义者。关键字
EXTERNAL为了符合 SQL 标准而被忽略。关于这一能力的更多信息,参见 CREATE FUNCTION。PARALLEL更改该函数是否被视为对并行执行安全。详见 CREATE FUNCTION。
LEAKPROOF更改该函数是否被视为防泄漏的。关于这一能力的更多信息,参见 CREATE FUNCTION。
COSTexecution_cost更改该函数的估计执行代价。详见CREATE FUNCTION。
ROWSresult_rows更改集合返回函数估计返回的行数。详见 CREATE FUNCTION。
SUPPORTsupport_function设置或更改该函数要使用的规划器支持函数。详见 Section 36.11。你必须是超级用户才能使用此选项。
此选项不能用于完全删除支持函数,因为它必须指定一个新的支持函数。 如果需要这样做,请使用
CREATE OR REPLACE FUNCTION。configuration_parametervalue添加或更改在调用该函数时要赋给某个配置参数的值。如果
value是DEFAULT,或者 等效地使用了RESET,则会移除函数局部设置,这样 该函数就会使用其环境中现有的值执行。使用RESET ALL可以清除所有函数局部设置。SET FROM CURRENT会把执行ALTER FUNCTION时该参数的当前值保存为 进入函数时要应用的值。关于允许的参数名和值的更多信息,参见SET和 Chapter 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中是可选的。
另见
语法演化
相邻大版本之间的差异,新的在前。版本号链接到对应快照。
PostgreSQL 14← 13语法变化
+ OWNER TO { new_owner | CURRENT_ROLE | CURRENT_USER | SESSION_USER }+ 其中 action 是以下之一:− OWNER TO { new_owner | CURRENT_USER | SESSION_USER }− 其中action为以下之一:正文更新PostgreSQL 13← 12语法变化
+ [ NO ] DEPENDS ON EXTENSION extension_name− DEPENDS ON EXTENSION extension_name正文更新PostgreSQL 12← 11语法变化
+ SUPPORT support_function正文更新PostgreSQL 11← 10正文更新
正文更新
同组命令
| 命令 | 动词 | 对象 | 版本变动 | 最近变更 |
|---|---|---|---|---|
CALL | CALL | — | — | |
| 调用一个过程 | 现存 | |||
DO | DO | — | — | |
| 执行匿名代码块 | 现存 | |||
CREATE AGGREGATE | CREATE | AGGREGATE | 203 次 | |
| 定义一个新的聚合函数 | 现存 | |||
ALTER AGGREGATE | ALTER | AGGREGATE | 141 次 | |
| 更改一个聚合函数的定义 | 现存 | |||
DROP AGGREGATE | DROP | AGGREGATE | — | |
| 移除一个聚合函数 | 现存 | |||
CREATE FUNCTION | CREATE | FUNCTION | 143 次 | |
| 定义一个新函数 | 现存 | |||
ALTER FUNCTION | ALTER | FUNCTION | 143 次 | |
| 更改函数的定义 | 现存 | |||
DROP FUNCTION | DROP | FUNCTION | — | |
| 移除一个函数 | 现存 | |||
CREATE LANGUAGE | CREATE | LANGUAGE | 131 次 | |
| 定义一种新的过程语言 | 现存 | |||
ALTER LANGUAGE | ALTER | LANGUAGE | 141 次 | |
| 更改一种过程语言的定义 | 现存 | |||
DROP LANGUAGE | DROP | LANGUAGE | — | |
| 移除一种过程语言 | 现存 | |||
CREATE PROCEDURE | CREATE | PROCEDURE | 141 次 | |
| 定义一个新过程 | 现存 | |||
ALTER PROCEDURE | ALTER | PROCEDURE | 142 次 | |
| 更改过程的定义 | 现存 | |||
DROP PROCEDURE | DROP | PROCEDURE | — | |
| 移除一个过程 | 现存 | |||
ALTER ROUTINE | ALTER | ROUTINE | 142 次 | |
| 更改一个例程的定义 | 现存 | |||
DROP ROUTINE | DROP | ROUTINE | — | |
| 移除一个例程 | 现存 | |||
CREATE TRANSFORM | CREATE | TRANSFORM | — | |
| 定义一个新的转换 | 现存 | |||
DROP TRANSFORM | DROP | TRANSFORM | — | |
| 移除一个转换 | 现存 | |||