选择 打开 改范围 完整检索页
受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: 19 / devel
不受支持的版本: 13 / 12 / 11 / 10
当前 PostgreSQL 版本不在支持生命周期内。
您可以参阅当前版本的对应页面,或其他在上面列出的活跃大版本。

42.5. 基本语句 #

在本节和后续各节中,我们描述PL/pgSQL能够明确理解的所有语句类型。凡是不被识别为这些类型之一的内容,都被视为 SQL 命令并发送给主数据库引擎执行,详见Section 42.5.2Section 42.5.3

42.5.1. 赋值 #

PL/pgSQL变量赋值的写法为:

variable { := | = } expression;

如前所述,这种语句中的表达式通过发送给主数据库引擎的 SQLSELECT命令求值。表达式必须产生单个值(如果变量是行变量或记录变量,也可以是行值)。目标变量可以是简单变量(可以用块名限定)、行变量或记录变量的字段,或者由简单变量或字段表示的数组中的元素。可以使用等号(=)代替符合 PL/SQL 的:=

如果该表达式的结果数据类型不匹配变量的数据类型,该值将被强制为变量 的类型,就好像做了赋值类型转换一样(见Section 10.4)。 如果没有用于所涉及到的数据类型的赋值类型转换可用, PL/pgSQL解释器将尝试以文本的方式转换结果值,也就 是在应用结果类型的输出函数之后再应用变量类型的输入函数。注意如果结果 值的字符串形式无法被输入函数所接受,这可能会导致由输入函数产生的运行 时错误。

例如:

tax := subtotal * 0.06;
my_record.user_id := 20;

42.5.2. 执行没有结果的命令 #

对于不返回行的 SQL 命令,例如没有RETURNING子句的INSERT,只需写出命令,就可以在PL/pgSQL函数中执行它。

命令文本中出现的任何PL/pgSQL变量名都被视为参数,然后在运行时将变量的当前值作为参数值提供。这与前面描述的表达式处理完全相同;详情见Section 42.11.1

以这种方式执行 SQL 命令时,PL/pgSQL可能会缓存和复用命令的执行计划,详见Section 42.11.2

有时,对表达式或SELECT查询求值但丢弃结果会很有用,例如调用有副作用但没有有用结果值的函数时。要在PL/pgSQL中这样做,可以使用PERFORM语句:

PERFORM query;

这会执行query并丢弃结果。编写query的方式与编写 SQLSELECT命令相同,只需把开头的关键字SELECT替换为PERFORM。对于WITH查询,使用PERFORM,然后用圆括号括住查询。(此时查询只能返回一行。)PL/pgSQL变量会被替换到查询中,方式与不返回结果的命令相同,计划也会以相同方式缓存。另外,特殊变量FOUND在查询至少产生一行时设为真,没有产生行时设为假(见Section 42.5.5)。

Note

我们可能期望直接写SELECT能实现这个结果,但是当前唯一被接受的方式是PERFORM。一个能返回行的 SQL 命令(例如SELECT)将被当成一个错误拒绝,除非它像下一节中讨论的有一个INTO子句。

一个示例:

PERFORM create_mv('cs_session_page_requests_mv', my_query);

42.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;

其中,target可以是记录变量、行变量,或逗号分隔的简单变量及记录/行字段列表。PL/pgSQL变量会被替换到查询的其余部分,计划也会被缓存,正如上面描述的不返回行的命令一样。这适用于SELECTINSERT/UPDATE/DELETE带有RETURNING的情况,以及返回行集结果的工具命令(例如EXPLAIN)。除了INTO子句以外,SQL 命令的写法与在PL/pgSQL之外的写法相同。

Tip

注意带INTOSELECT的这种解释和PostgreSQL常规的SELECT INTO命令有很大的不同,后者的INTO目标是一个新创建的表。如果你想要在一个PL/pgSQL函数中从一个SELECT的结果创建一个表,请使用语法CREATE TABLE ... AS SELECT

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

INTO子句几乎可以出现在 SQL 命令中的任何位置。通常它被写成刚好在SELECT命令中的select_expressions列表之前或之后,或者在其他命令类型的命令最后。我们推荐你遵循这种惯例,以防PL/pgSQL的解析器在未来的版本中变得更严格。

如果STRICT没有在INTO子句中指定,那么target会被设为查询返回的第一行;如果查询没有返回行,则设为空值。(注意,第一行并没有明确定义,除非使用了ORDER BY。)第一行之后的所有结果行都会被丢弃。可以检查特殊的FOUND变量(见Section 42.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设为真。

对于带有RETURNINGINSERT/UPDATE/DELETE/即使没有指定STRICTPL/pgSQL也会针对多于一个返回行的情况报告一个错误。这是因为没有类似于ORDER BY的选项可以用来决定应该返回哪个被影响的行。

如果print_strict_params已为该函数启用,那么当不满足STRICT要求而抛出错误时,错误消息的DETAIL部分将包含传给查询的参数信息。可以为所有函数更改print_strict_params设置,方法是设置plpgsql.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

Note

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

对于需要处理 SQL 查询的多个结果行的情况,请参见Section 42.6.6

42.5.4. 执行动态命令 #

很多时候你将想要在PL/pgSQL函数中产生动态命令,也就是每次执行中会涉及到不同表或不同数据类型的命令。PL/pgSQL通常对于命令所做的缓存计划尝试(如Section 42.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;

参数符号的另一个限制是,它们只能用于SELECTINSERTUPDATE以及DELETE命令。在其他语句类型(统称为工具语句)中,即使只是数据值,也必须以文本形式插入。

在上面第一个示例中,带有一个简单的常量命令字符串和一些USING参数的EXECUTE命令在功能上等效于直接用PL/pgSQL写的命令,并且允许自动发生PL/pgSQL变量替换。重要的不同之处在于,EXECUTE会在每一次执行时根据当前的参数值重新计划该命令,而PL/pgSQL则是创建一个通用计划并且将其缓存以便重用。在最佳计划强依赖于参数值的情况中,使用EXECUTE来明确地保证不会选择一个通用计划是很有帮助的。

EXECUTE目前不支持SELECT INTO。但是可以执行一个纯的SELECT命令并且指定INTO作为EXECUTE本身的一部分。

Note

PL/pgSQL中的EXECUTE语句与EXECUTE这一由PostgreSQL服务器支持的 SQL 语句无关。服务器的EXECUTE语句不能直接在PL/pgSQL函数中使用(并且也没有必要)。

Example 42.1. 在动态查询中为值加引号

在使用动态命令时,经常需要处理单引号的转义。我们推荐在函数体中使用美元引用来引用固定文本。(如果你有未使用美元引用的旧代码,请参阅Section 42.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函数的用法(见Section 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);

如果正在处理的参数值可能为空,那么通常应该用quote_nullable来代替quote_literal

通常,必须小心地确保查询中的空值不会递送意料之外的结果。例如如果keyvalue为空,下面的WHERE子句

'WHERE key = ' || quote_nullable(keyvalue)

永远不会成功,因为在=操作符中使用空操作数得到的结果总是为空。如果想让空和一个普通键值一样工作,你应该将上面的命令重写成

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

(目前,IS NOT DISTINCT FROM的处理效率不如=,因此只有在非常必要时才这样做。关于空和IS DISTINCT的详细信息请见Section 9.2)。

请注意美元符号引用只对引用固定文本有用。尝试写出下面这个示例是一个非常糟糕的主意:

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

因为如果newvalue的内容碰巧含有$$,那么这段代码就会出问题。同样的缺点可能适用于你选择的任何其他美元符号引用定界符。因此,要想安全地引用事先不知道的文本,必须恰当地使用quote_literalquote_nullablequote_ident

动态 SQL 语句也可以使用format(见Section 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引用它们。这也效率 更高。


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

42.5.5. 获取结果状态 #

有好几种方法可以判断一条命令的效果。第一种方法是使用GET DIAGNOSTICS命令,其形式如下:

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

这条命令允许检索系统状态指示符。CURRENT是一个噪声词(另见Section 42.6.8.1中的GET STACKED DIAGNOSTICS)。每个item是一个关键字, 它标识一个要被赋予给指定变量的状态值(变量应具有正确的数据类型来接收状态值)。Table 42.1中展示了当前可用的状态项。冒号等号(:=)可以被用来取代 SQL 标准的=符号。例如:

GET DIAGNOSTICS integer_var = ROW_COUNT;

Table 42.1. 可用的诊断项

名称 类型 描述
ROW_COUNT bigint 最近的SQL命令处理的行数
PG_CONTEXT text 描述当前调用栈的文本行(见Section 42.6.9

确定命令执行效果的第二种方法是检查名为FOUND的特殊变量,其类型为booleanFOUND的初始值为假,这适用于每次PL/pgSQL函数调用。以下各类语句都会设置它:

  • SELECT INTO语句在分配行时将FOUND设置为true, 如果没有返回行则设置为false。

  • PERFORM语句在生成(和丢弃)一个或多个行时将FOUND设置为true, 如果没有生成行则设置为false。

  • UPDATEINSERTDELETE语句在至少影响一行时将FOUND设置为真,如果没有影响行则设置为假。

  • FETCH语句在返回行时将FOUND设置为true, 如果没有返回行则设置为false。

  • MOVE语句在成功重新定位游标时将FOUND设置为true, 否则设置为false。

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

  • RETURN QUERYRETURN QUERY EXECUTE语句在查询返回至少一行时将FOUND设置为true, 如果没有返回行则设置为false。

其他PL/pgSQL语句不会改变以下变量的状态:FOUND。特别要注意的是,EXECUTE会改变GET DIAGNOSTICS的输出,但不会改变FOUND

FOUND是每个PL/pgSQL函数的局部变量;任何对它的修改只影响当前的函数。

42.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;

选用哪一种取决于个人偏好。

Note

在 Oracle 的 PL/SQL 中,不允许出现空语句列表,并且因此在这种情况下必须使用NULL语句。而PL/pgSQL允许你什么也不写。