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 / 7.3 / 7.2

41.5. 基本语句 #

在本节及后续章节中,我们将描述所有 PL/pgSQL 显式理解的语句类型。任何未识别为这些语句类型之一的内容都被认为是 SQL 命令,并发送到主数据库引擎执行,如第 41.5.2 节中所述。

41.5.1. 赋值 #

将值赋给 PL/pgSQL 变量的写法如下:

variable { := | = } expression;

如前所述,此语句中的表达式通过发送到主数据库引擎的 SQL SELECT 命令进行评估。表达式必须产生单个值(如果变量是行或记录变量,则可能是行值)。目标变量可以是简单变量(可选地用块名称限定)、行或记录目标的字段,或数组目标的元素或切片。可以使用等号 (=) 代替符合 PL/SQL 标准的 :=

如果表达式的结果数据类型与变量的数据类型不匹配,则该值将像赋值强制转换一样进行强制转换(参见第 10.4 节)。如果对于所涉及的数据类型对没有已知的赋值强制转换,则 PL/pgSQL 解释器将尝试以文本方式转换结果值,即通过应用结果类型的输出函数,然后应用变量类型的输入函数。请注意,如果结果值的字符串形式对于输入函数不可接受,这可能会导致输入函数生成的运行时错误。

示例

tax := subtotal * 0.06;
my_record.user_id := 20;
my_array[j] := 20;
my_array[1:3] := array[1,2,3];
complex_array[n].realpart = 12.3;

41.5.2. 执行 SQL 命令 #

一般来说,任何不返回行的 SQL 命令都可以在 PL/pgSQL 函数中通过编写该命令来执行。例如,您可以创建并填充一个表,方法是编写:

CREATE TABLE mytable (id int primary key, data text);
INSERT INTO mytable VALUES (1,'one'), (2,'two');

如果命令确实返回行(例如 SELECT,或带有 RETURNINGINSERT/UPDATE/DELETE/MERGE),则有两种方法可以继续执行。当命令最多返回一行,或者您只关心输出的第一行时,照常编写命令,但添加一个 INTO 子句以捕获输出,如第 41.5.3 节中所述。要处理所有输出行,请将命令作为 FOR 循环的数据源,如第 41.6.6 节中所述。

通常,仅执行静态定义的 SQL 命令是不够的。通常,您希望命令使用不同的数据值,甚至以更基本的方式发生变化,例如在不同时间使用不同的表名。同样,根据情况,您也可以采取两种方法来解决。

PL/pgSQL 变量值可以自动插入到可优化的 SQL 命令中,这些命令是 SELECTINSERTUPDATEDELETEMERGE 和某些包含其中之一的实用程序命令,例如 EXPLAINCREATE TABLE ... AS SELECT。在这些命令中,出现在命令文本中的任何 PL/pgSQL 变量名都将替换为查询参数,然后在运行时提供变量的当前值作为参数值。这与之前为表达式描述的处理方式完全相同;有关详细信息,请参见第 41.11.1 节

以这种方式执行可优化的 SQL 命令时,PL/pgSQL 可能会缓存并重复使用命令的执行计划,如第 41.11.2 节中所述。

不可优化 SQL 命令(也称为实用程序命令)无法接受查询参数。因此,在这些命令中,PL/pgSQL 变量的自动替换不起作用。要在从 PL/pgSQL 执行的实用程序命令中包含非常量文本,您必须将实用程序命令构建为字符串,然后 EXECUTE 它,如第 41.5.4 节中所述。

如果您想以更改数据值以外的其他方式修改命令,例如更改表名,也必须使用 EXECUTE

有时评估表达式或 SELECT 查询但丢弃结果很有用,例如当调用具有副作用但没有有用结果值的函数时。要在 PL/pgSQL 中执行此操作,请使用 PERFORM 语句

PERFORM query;

这将执行 query 并丢弃结果。编写 query 的方式与编写 SQL SELECT 命令的方式相同,但用 PERFORM 替换初始关键字 SELECT。对于 WITH 查询,请使用 PERFORM,然后将查询放在括号中。(在这种情况下,查询只能返回一行。)PL/pgSQL 变量将像上面描述的那样替换到查询中,并且计划以相同的方式进行缓存。此外,如果查询产生至少一行,则特殊变量 FOUND 将设置为 true,否则如果查询没有产生任何行,则设置为 false(参见第 41.5.5 节)。

注意

人们可能会认为直接编写 SELECT 可以实现此结果,但目前唯一被接受的方式是 PERFORM。如果 SQL 命令可以返回行,例如 SELECT,除非它具有下一节中讨论的 INTO 子句,否则将被拒绝并报错。

一个例子

PERFORM create_mv('cs_session_page_requests_mv', my_query);

41.5.3. 执行返回单行结果的命令 #

产生单行结果(可能是多列)的 SQL 命令的结果可以赋给记录变量、行类型变量或标量变量列表。这是通过编写基本 SQL 命令并添加 INTO 子句来完成的。例如,

SELECT select_expressions INTO [STRICT] target FROM ...;
INSERT ... RETURNING expressions INTO [STRICT] target;
UPDATE ... RETURNING expressions INTO [STRICT] target;
DELETE ... RETURNING expressions INTO [STRICT] target;
MERGE ... RETURNING expressions INTO [STRICT] target;

其中 target 可以是记录变量、行变量或简单变量和记录/行字段的逗号分隔列表。PL/pgSQL 变量将像上面描述的那样替换到命令的其余部分(即 INTO 子句以外的所有内容),并且计划以相同的方式进行缓存。这适用于 SELECT、带有 RETURNINGINSERT/UPDATE/DELETE/MERGE 以及某些返回行集的实用程序命令,例如 EXPLAIN。除了 INTO 子句外,SQL 命令与在 PL/pgSQL 外部编写的方式相同。

提示

请注意,这种对带有 INTOSELECT 的解释与 PostgreSQL 的常规 SELECT INTO 命令完全不同,在常规命令中,INTO 目标是新创建的表。如果您想在 PL/pgSQL 函数内从 SELECT 结果创建表,请使用语法 CREATE TABLE ... AS SELECT

如果使用行变量或变量列表作为目标,则命令的结果列必须在数量和数据类型上与目标的结构完全匹配,否则会发生运行时错误。当记录变量是目标时,它会自动将其自身配置为命令结果列的行类型。

INTO 子句几乎可以出现在 SQL 命令的任何位置。习惯上,它要么写在 SELECT 命令中 select_expressions 列表的前面或后面,要么在其他命令类型的命令末尾。建议您遵循此约定,以防 PL/pgSQL 解析器在将来的版本中变得更加严格。

如果 INTO 子句中未指定 STRICT,则 target 将设置为命令返回的第一行,或者如果命令未返回任何行则设置为 null 值。(请注意,除非您使用了 ORDER BY,否则 第一行 的定义不明确。)第一行之后的任何结果行都将被丢弃。您可以检查特殊的 FOUND 变量(请参阅 第 41.5.5 节)以确定是否返回了行。

SELECT * INTO myrec FROM emp WHERE empname = myname;
IF NOT FOUND THEN
    RAISE EXCEPTION 'employee % not found', myname;
END IF;

如果指定了 STRICT 选项,则命令必须恰好返回一行,否则将报告运行时错误,即 NO_DATA_FOUND(无行)或 TOO_MANY_ROWS(多于一行)。如果您希望捕获错误,可以使用异常块,例如

BEGIN
    SELECT * INTO STRICT myrec FROM emp WHERE empname = myname;
    EXCEPTION
        WHEN NO_DATA_FOUND THEN
            RAISE EXCEPTION 'employee % not found', myname;
        WHEN TOO_MANY_ROWS THEN
            RAISE EXCEPTION 'employee % not unique', myname;
END;

使用 STRICT 的命令成功执行始终将 FOUND 设置为 true。

对于带有 RETURNINGINSERT/UPDATE/DELETE/MERGE,即使未指定 STRICTPL/pgSQL 也会针对多于一行返回的结果报告错误。这是因为没有像 ORDER BY 这样的选项来确定应返回哪一行受影响的行。

如果为函数启用了 print_strict_params,则当由于未满足 STRICT 的要求而引发错误时,错误消息的 DETAIL 部分将包含有关传递给命令的参数的信息。您可以通过设置 plpgsql.print_strict_params 来更改所有函数的 print_strict_params 设置,但仅会影响后续的函数编译。您还可以使用编译器选项在每个函数的基础上启用它,例如

CREATE FUNCTION get_userid(username text) RETURNS int
AS $$
#print_strict_params on
DECLARE
userid int;
BEGIN
    SELECT users.userid INTO STRICT userid
        FROM users WHERE users.username = get_userid.username;
    RETURN userid;
END;
$$ LANGUAGE plpgsql;

发生故障时,此函数可能会生成以下错误消息:

ERROR:  query returned no rows
DETAIL:  parameters: username = 'nosuchuser'
CONTEXT:  PL/pgSQL function get_userid(text) line 6 at SQL statement

注意

STRICT 选项与 Oracle PL/SQL 的 SELECT INTO 和相关语句的行为相匹配。

41.5.4. 执行动态命令 #

通常,您希望在 PL/pgSQL 函数内部生成动态命令,即每次执行时都涉及不同表或不同数据类型的命令。PL/pgSQL 通常尝试为命令缓存计划(如 第 41.11.2 节 中所述)在这种情况下将不起作用。为了处理此类问题,提供了 EXECUTE 语句

EXECUTE command-string [ INTO [STRICT] target ] [ USING expression [, ... ] ];

其中 command-string 是一个表达式,产生一个字符串(类型为 text),其中包含要执行的命令。可选的 target 是一个记录变量、行变量或一个逗号分隔的简单变量和记录/行字段列表,命令的结果将存储到其中。可选的 USING 表达式提供要插入命令中的值。

在计算出的命令字符串上不进行 PL/pgSQL 变量的替换。任何所需的变量值都必须在构造命令字符串时插入其中;或者您可以使用下面描述的参数。

此外,对于通过 EXECUTE 执行的命令没有计划缓存。相反,每次运行语句时都会始终计划命令。因此,可以在函数中动态创建命令字符串以对不同的表和列执行操作。

INTO 子句指定应将返回行的 SQL 命令的结果分配到哪里。如果提供了行变量或变量列表,则它必须与命令结果的结构完全匹配;如果提供了记录变量,它将自动配置自身以匹配结果结构。如果返回多行,则仅将第一行分配给 INTO 变量。如果未返回任何行,则将 NULL 分配给 INTO 变量。如果没有指定 INTO 子句,则命令结果将被丢弃。

如果给出了 STRICT 选项,则除非命令恰好产生一行,否则将报告错误。

命令字符串可以使用参数值,这些值在命令中被引用为 $1$2 等。这些符号指的是在 USING 子句中提供的值。此方法通常优于将数据值作为文本插入命令字符串:它避免了将值转换为文本并转换回文本的运行时开销,并且由于不需要引用或转义,因此不太容易受到 SQL 注入攻击。一个例子是

EXECUTE 'SELECT count(*) FROM mytable WHERE inserted_by = $1 AND inserted <= $2'
   INTO c
   USING checked_user, checked_date;

请注意,参数符号只能用于数据值——如果您想使用动态确定的表名或列名,则必须将它们作为文本插入命令字符串中。例如,如果前面的查询需要针对动态选择的表执行,则可以执行以下操作

EXECUTE 'SELECT count(*) FROM '
    || quote_ident(tabname)
    || ' WHERE inserted_by = $1 AND inserted <= $2'
   INTO c
   USING checked_user, checked_date;

更简洁的方法是使用 format()%I 规范来插入表名或列名,并自动添加引号

EXECUTE format('SELECT count(*) FROM %I '
   'WHERE inserted_by = $1 AND inserted <= $2', tabname)
   INTO c
   USING checked_user, checked_date;

(此示例依赖于 SQL 规则,即由换行符分隔的字符串文字隐式连接。)

参数符号的另一个限制是它们仅适用于可优化的 SQL 命令(SELECTINSERTUPDATEDELETEMERGE 和包含其中一个命令的某些命令)。在其他语句类型(通常称为实用程序语句)中,您必须以文本方式插入值,即使它们只是数据值。

带有简单常量命令字符串和一些 USING 参数的 EXECUTE(如上面的第一个示例)在功能上等效于直接在 PL/pgSQL 中编写命令并允许自动替换 PL/pgSQL 变量。重要的区别在于,EXECUTE 将在每次执行时重新计划命令,生成一个特定于当前参数值的计划;而 PL/pgSQL 可能会创建通用计划并将其缓存以供重复使用。在最佳计划在很大程度上取决于参数值的情况下,使用 EXECUTE 可以积极地确保不选择通用计划。

SELECT INTO 目前不支持在 EXECUTE 内使用;而是执行一个普通的 SELECT 命令,并在 EXECUTE 本身中指定 INTO

注意

PL/pgSQLEXECUTE 语句与 PostgreSQL 服务器支持的 EXECUTE SQL 语句无关。服务器的 EXECUTE 语句不能直接在 PL/pgSQL 函数中使用(也不需要)。

示例 41.1. 在动态查询中引用值

在处理动态命令时,您通常需要处理单引号的转义。在函数体中引用固定文本的推荐方法是美元引用。(如果您有未使用美元引用的遗留代码,请参阅 第 41.12.1 节 中的概述,这可以节省您在将此类代码转换为更合理的方案时的一些工作。)

动态值需要小心处理,因为它们可能包含引号字符。一个使用 format() 的示例(这假设您正在使用美元引用函数体,因此不需要对引号进行加倍)

EXECUTE format('UPDATE tbl SET %I = $1 '
   'WHERE key = $2', colname) USING newvalue, keyvalue;

也可以直接调用引用函数

EXECUTE 'UPDATE tbl SET '
        || quote_ident(colname)
        || ' = '
        || quote_literal(newvalue)
        || ' WHERE key = '
        || quote_literal(keyvalue);

此示例演示了 quote_identquote_literal 函数的使用(请参阅 第 9.4 节)。出于安全考虑,包含列或表标识符的表达式应在插入动态查询之前通过 quote_ident 传递。包含应在构造的命令中作为字符串文字的值的表达式应通过 quote_literal 传递。这些函数会采取适当的步骤来返回用双引号或单引号括起来输入文本,并正确转义任何嵌入的特殊字符。

由于 quote_literal 被标记为 STRICT,因此当使用 null 参数调用时,它始终返回 null。在上面的示例中,如果 newvaluekeyvalue 为 null,则整个动态查询字符串将变为 null,从而导致 EXECUTE 发生错误。您可以使用 quote_nullable 函数避免此问题,该函数与 quote_literal 的工作方式相同,只是当使用 null 参数调用时,它返回字符串 NULL。例如,

EXECUTE 'UPDATE tbl SET '
        || quote_ident(colname)
        || ' = '
        || quote_nullable(newvalue)
        || ' WHERE key = '
        || quote_nullable(keyvalue);

如果您正在处理可能为 null 的值,则通常应使用 quote_nullable 代替 quote_literal

与往常一样,必须注意确保查询中的 null 值不会产生意外的结果。例如,WHERE 子句

'WHERE key = ' || quote_nullable(keyvalue)

如果 keyvalue 为 null,则永远不会成功,因为使用等于运算符 = 和 null 操作数的结果始终为 null。如果您希望 null 像普通键值一样工作,则需要将其重写为

'WHERE key IS NOT DISTINCT FROM ' || quote_nullable(keyvalue)

(目前,IS NOT DISTINCT FROM 的处理效率远低于 =,因此除非必须,否则不要这样做。有关 null 和 IS DISTINCT 的更多信息,请参阅 第 9.2 节。)

请注意,美元引用仅适用于引用固定文本。尝试将此示例编写为以下形式将是一个非常糟糕的主意

EXECUTE 'UPDATE tbl SET '
        || quote_ident(colname)
        || ' = $$'
        || newvalue
        || '$$ WHERE key = '
        || quote_literal(keyvalue);

因为它会在 newvalue 的内容碰巧包含 $$ 时中断。您可能选择的任何其他美元引用分隔符都将适用相同的反对意见。因此,要安全地引用预先未知的文本,您必须使用 quote_literalquote_nullablequote_ident,具体取决于情况。

还可以使用 format 函数安全地构造动态 SQL 语句(请参阅 第 9.4.1 节)。例如

EXECUTE format('UPDATE tbl SET %I = %L '
   'WHERE key = %L', colname, newvalue, keyvalue);

%I 等效于 quote_ident%L 等效于 quote_nullableformat 函数可以与 USING 子句结合使用

EXECUTE format('UPDATE tbl SET %I = $1 WHERE key = $2', colname)
   USING newvalue, keyvalue;

此表单更好,因为它以变量的原生数据类型格式处理变量,而不是无条件地将其转换为文本并通过 %L 进行引用。它也更高效。


可以在 示例 41.10 中看到一个更大的动态命令和 EXECUTE 示例,它构建并执行一个 CREATE FUNCTION 命令来定义一个新函数。

41.5.5. 获取结果状态 #

有几种方法可以确定命令的效果。第一种方法是使用 GET DIAGNOSTICS 命令,其形式为

GET [ CURRENT ] DIAGNOSTICS variable { = | := } item [ , ... ];

此命令允许检索系统状态指示器。 CURRENT 是一个噪音词(但也请参阅 第 41.6.8.1 节 中的 GET STACKED DIAGNOSTICS)。每个 item 都是一个关键字,用于标识要分配给指定 variable(应具有正确的类型以接收它)的状态值。当前可用的状态项显示在 表 41.1 中。可以使用冒号等号 (:=) 代替 SQL 标准的 = 令牌。一个例子

GET DIAGNOSTICS integer_var = ROW_COUNT;

表 41.1. 可用的诊断项

名称 类型 描述
ROW_COUNT bigint 最近处理的行数SQL命令
PG_CONTEXT text 描述当前调用堆栈的行(请参阅 第 41.6.9 节
PG_ROUTINE_OID oid 当前函数的 OID

确定命令效果的第二种方法是检查名为 FOUND 的特殊变量,该变量的类型为 boolean。在每个 PL/pgSQL 函数调用中,FOUND 最初为假。它由以下每种类型的语句设置

  • 如果分配了一行,则 SELECT INTO 语句将 FOUND 设置为真,如果未返回任何行,则设置为假。

  • 如果 PERFORM 语句生成(并丢弃)一行或多行,则将其设置为真,如果未生成任何行,则设置为假。

  • UPDATEINSERTDELETEMERGE 语句如果至少影响一行,则将 FOUND 设置为真,如果未影响任何行,则设置为假。

  • 如果 FETCH 语句返回一行,则将其设置为真,如果未返回任何行,则设置为假。

  • 如果 MOVE 语句成功重新定位游标,则将其设置为真,否则设置为假。

  • 如果 FORFOREACH 语句迭代一次或多次,则将其设置为真,否则设置为假。循环退出时,FOUND 以这种方式设置;在循环执行过程中,FOUND 不会被循环语句修改,尽管它可能会被循环体中其他语句的执行更改。

  • RETURN QUERYRETURN QUERY EXECUTE 语句如果查询返回至少一行,则将 FOUND 设置为真,如果未返回任何行,则设置为假。

其他 PL/pgSQL 语句不会更改 FOUND 的状态。请特别注意,EXECUTE 会更改 GET DIAGNOSTICS 的输出,但不会更改 FOUND

FOUND 是每个 PL/pgSQL 函数中的局部变量;对其进行的任何更改仅影响当前函数。

41.5.6. 什么也不做 #

有时,什么也不做的占位符语句很有用。例如,它可以指示 if/then/else 链的一个分支是故意为空的。为此,请使用 NULL 语句

NULL;

例如,以下两个代码片段是等效的

BEGIN
    y := x / 0;
EXCEPTION
    WHEN division_by_zero THEN
        NULL;  -- ignore the error
END;
BEGIN
    y := x / 0;
EXCEPTION
    WHEN division_by_zero THEN  -- ignore the error
END;

哪个更好是品味问题。

注意

在 Oracle 的 PL/SQL 中,不允许使用空语句列表,因此在这种情况下需要 NULL 语句。 PL/pgSQL 允许您只写 nothing。

提交更正

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