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

4.3. 调用函数 #

PostgreSQL 允许使用位置命名表示法调用具有命名参数的函数。命名表示法对于具有大量参数的函数尤其有用,因为它使得参数和实际参数之间的关联更加明确和可靠。在位置表示法中,函数调用按其在函数声明中定义的顺序写入参数值。在命名表示法中,参数按名称与函数参数匹配,并且可以按任何顺序写入。对于每种表示法,还要考虑函数参数类型的影响,详见第 10.3 节

在任何一种表示法中,函数声明中具有默认值的参数都不需要在调用中写入。但这在命名表示法中尤其有用,因为可以省略任何参数组合;而在位置表示法中,只能从右到左省略参数。

PostgreSQL 还支持混合表示法,它结合了位置表示法和命名表示法。在这种情况下,位置参数首先写入,命名参数出现在它们之后。

以下示例将说明所有三种表示法的使用,使用以下函数定义

CREATE FUNCTION concat_lower_or_upper(a text, b text, uppercase boolean DEFAULT false)
RETURNS text
AS
$$
 SELECT CASE
        WHEN $3 THEN UPPER($1 || ' ' || $2)
        ELSE LOWER($1 || ' ' || $2)
        END;
$$
LANGUAGE SQL IMMUTABLE STRICT;

函数concat_lower_or_upper有两个必需参数,ab。此外,还有一个可选参数uppercase,默认为falseab输入将被连接,并根据uppercase参数强制转换为大写或小写。此函数定义的其余细节在这里并不重要(有关更多信息,请参阅第 36 章)。

4.3.1. 使用位置表示法 #

位置表示法是在PostgreSQL中向函数传递参数的传统机制。一个例子是

SELECT concat_lower_or_upper('Hello', 'World', true);
 concat_lower_or_upper
-----------------------
 HELLO WORLD
(1 row)

所有参数按顺序指定。结果是大写,因为uppercase被指定为true。另一个例子是

SELECT concat_lower_or_upper('Hello', 'World');
 concat_lower_or_upper
-----------------------
 hello world
(1 row)

这里,省略了uppercase参数,因此它接收其默认值false,从而导致小写输出。在位置表示法中,只要参数具有默认值,就可以从右到左省略它们。

4.3.2. 使用命名表示法 #

在命名表示法中,每个参数的名称都使用=>指定,将其与参数表达式分开。例如

SELECT concat_lower_or_upper(a => 'Hello', b => 'World');
 concat_lower_or_upper
-----------------------
 hello world
(1 row)

同样,省略了参数uppercase,因此隐式设置为false。使用命名表示法的一个优点是参数可以按任何顺序指定,例如

SELECT concat_lower_or_upper(a => 'Hello', b => 'World', uppercase => true);
 concat_lower_or_upper
-----------------------
 HELLO WORLD
(1 row)

SELECT concat_lower_or_upper(a => 'Hello', uppercase => true, b => 'World');
 concat_lower_or_upper
-----------------------
 HELLO WORLD
(1 row)

为了向后兼容,支持基于“:=”的旧语法

SELECT concat_lower_or_upper(a := 'Hello', uppercase := true, b := 'World');
 concat_lower_or_upper
-----------------------
 HELLO WORLD
(1 row)

4.3.3. 使用混合表示法 #

混合表示法结合了位置表示法和命名表示法。但是,如前所述,命名参数不能位于位置参数之前。例如

SELECT concat_lower_or_upper('Hello', 'World', uppercase => true);
 concat_lower_or_upper
-----------------------
 HELLO WORLD
(1 row)

在上面的查询中,参数ab按位置指定,而uppercase按名称指定。在此示例中,除了文档之外,几乎没有添加任何内容。对于具有许多具有默认值的参数的更复杂函数,命名或混合表示法可以节省大量编写并减少出错的机会。

注意

当前,在调用聚合函数时不能使用命名和混合调用表示法(但是当聚合函数用作窗口函数时,它们可以正常工作)。

提交更正

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