2025年9月25日: PostgreSQL 18 发布!
支持版本: 当前 (18) / 17 / 16 / 15 / 14 / 13
开发版本: devel
不支持的版本: 12 / 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.6. 控制结构 #

控制结构可能是 PL/pgSQL 中最有用(也是最重要的)部分。使用 PL/pgSQL 的控制结构,您可以非常灵活且强大地操作 PostgreSQL 数据。

41.6.1. 从函数返回 #

有两个命令可用于从函数返回数据: RETURNRETURN NEXT

41.6.1.1. RETURN #

RETURN expression;

RETURN 后面跟表达式,会终止函数并将 expression 的值返回给调用者。此形式用于不返回集合的 PL/pgSQL 函数。

在返回标量类型的函数中,表达式的结果将自动转换为函数的返回类型,如赋值部分所述。但要返回复合(行)值,您必须编写一个提供完全请求列集的表达式。这可能需要使用显式转换。

如果您声明的函数带有输出参数,则只需编写 RETURN,后面不跟表达式。输出参数变量的当前值将被返回。

如果您声明的函数返回 void,则可以使用 RETURN 语句提前退出函数;但不要在 RETURN 后面写表达式。

函数的返回值不能未定义。如果控制在未遇到 RETURN 语句的情况下到达函数顶层块的末尾,将发生运行时错误。但是,此限制不适用于带有输出参数的函数和返回 void 的函数。在这些情况下,如果顶层块结束,将自动执行 RETURN 语句。

一些例子

-- functions returning a scalar type
RETURN 1 + 2;
RETURN scalar_var;

-- functions returning a composite type
RETURN composite_type_var;
RETURN (1, 2, 'three'::text);  -- must cast columns to correct types

41.6.1.2. RETURN NEXTRETURN QUERY #

RETURN NEXT expression;
RETURN QUERY query;
RETURN QUERY EXECUTE command-string [ USING expression [, ... ] ];

PL/pgSQL 函数声明为返回 SETOF sometype 时,处理方式略有不同。在这种情况下,要返回的单个项由一系列 RETURN NEXTRETURN QUERY 命令指定,然后使用一个不带参数的最终 RETURN 命令来指示函数已执行完毕。RETURN NEXT 可与标量和复合数据类型一起使用;对于复合结果类型,将返回整个结果“”。RETURN QUERY 将执行查询的结果追加到函数的返回集中。RETURN NEXTRETURN QUERY 可以在单个集合返回函数中自由混合使用,在这种情况下,它们的输出将连接起来。

RETURN NEXTRETURN QUERY 实际上并不会从函数返回——它们只是将零行或多行追加到函数的返回集中。然后,执行将继续 PL/pgSQL 函数中的下一个语句。随着连续的 RETURN NEXTRETURN QUERY 命令的执行,结果集将被构建起来。最终的 RETURN(应不带参数)会导致控制退出函数(或者您可以让控制到达函数末尾)。

RETURN QUERY 有一个变体 RETURN QUERY EXECUTE,它指定要动态执行的查询。参数表达式可以通过 USING 插入到计算出的查询字符串中,这与普通 EXECUTE 命令中的方式相同。

如果您声明的函数带有输出参数,则只需编写 RETURN NEXT,后面不跟表达式。每次执行时,输出参数变量的当前值将被保存,以便最终作为结果集中的一行返回。请注意,您必须将函数声明为返回 SETOF record(当有多个输出参数时),或 SETOF sometype(当只有一个类型为 sometype 的输出参数时),才能创建带有输出参数的集合返回函数。

以下是一个使用 RETURN NEXT 的函数示例

CREATE TABLE foo (fooid INT, foosubid INT, fooname TEXT);
INSERT INTO foo VALUES (1, 2, 'three');
INSERT INTO foo VALUES (4, 5, 'six');

CREATE OR REPLACE FUNCTION get_all_foo() RETURNS SETOF foo AS
$BODY$
DECLARE
    r foo%rowtype;
BEGIN
    FOR r IN
        SELECT * FROM foo WHERE fooid > 0
    LOOP
        -- can do some processing here
        RETURN NEXT r; -- return current row of SELECT
    END LOOP;
    RETURN;
END;
$BODY$
LANGUAGE plpgsql;

SELECT * FROM get_all_foo();

以下是一个使用 RETURN QUERY 的函数示例

CREATE FUNCTION get_available_flightid(date) RETURNS SETOF integer AS
$BODY$
BEGIN
    RETURN QUERY SELECT flightid
                   FROM flight
                  WHERE flightdate >= $1
                    AND flightdate < ($1 + 1);

    -- Since execution is not finished, we can check whether rows were returned
    -- and raise exception if not.
    IF NOT FOUND THEN
        RAISE EXCEPTION 'No flight at %.', $1;
    END IF;

    RETURN;
 END;
$BODY$
LANGUAGE plpgsql;

-- Returns available flights or raises exception if there are no
-- available flights.
SELECT * FROM get_available_flightid(CURRENT_DATE);

注意

如上所述,RETURN NEXTRETURN QUERY 的当前实现是在函数返回之前存储整个结果集。这意味着,如果 PL/pgSQL 函数产生非常大的结果集,性能可能会很差:数据将被写入磁盘以避免内存不足,但函数本身在生成整个结果集之前不会返回。未来版本的 PL/pgSQL 可能会允许用户定义没有此限制的集合返回函数。当前,数据开始写入磁盘的点由 work_mem 配置变量控制。具有足够内存将更大结果集存储在内存中的管理员应考虑增加此参数。

41.6.2. 从过程返回 #

过程没有返回值。因此,过程可以在没有 RETURN 语句的情况下结束。如果您希望使用 RETURN 语句提前退出代码,则只需编写 RETURN,后面不跟表达式。

如果过程有输出参数,则输出参数变量的最终值将返回给调用者。

41.6.3. 调用过程 #

PL/pgSQL 函数、过程或 DO 块可以使用 CALL 调用过程。输出参数的处理方式与普通 SQL 中的 CALL 工作方式不同。过程的每个 OUTINOUT 参数必须对应于 CALL 语句中的一个变量,并且无论过程返回什么,都会在过程返回后将其分配回该变量。例如

CREATE PROCEDURE triple(INOUT x int)
LANGUAGE plpgsql
AS $$
BEGIN
    x := x * 3;
END;
$$;

DO $$
DECLARE myvar int := 5;
BEGIN
  CALL triple(myvar);
  RAISE NOTICE 'myvar = %', myvar;  -- prints 15
END;
$$;

对应于输出参数的变量可以是简单变量,也可以是复合类型变量的字段。当前,它不能是数组的元素。

41.6.4. 条件语句 #

IFCASE 语句允许您根据特定条件执行替代命令。PL/pgSQL 有三种形式的 IF

  • IF ... THEN ... END IF

  • IF ... THEN ... ELSE ... END IF

  • IF ... THEN ... ELSIF ... THEN ... ELSE ... END IF

以及两种形式的 CASE

  • CASE ... WHEN ... THEN ... ELSE ... END CASE

  • CASE WHEN ... THEN ... ELSE ... END CASE

41.6.4.1. IF-THEN #

IF boolean-expression THEN
    statements
END IF;

IF-THEN 语句是最简单的 IF 形式。如果条件为真,则执行 THENEND IF 之间的语句。否则,将跳过它们。

示例:

IF v_user_id <> 0 THEN
    UPDATE users SET email = v_email WHERE user_id = v_user_id;
END IF;

41.6.4.2. IF-THEN-ELSE #

IF boolean-expression THEN
    statements
ELSE
    statements
END IF;

IF-THEN-ELSE 语句在 IF-THEN 的基础上增加了功能,允许您指定当条件不为真时应执行的替代语句集。(请注意,这包括条件评估为 NULL 的情况。)

示例

IF parentid IS NULL OR parentid = ''
THEN
    RETURN fullname;
ELSE
    RETURN hp_true_filename(parentid) || '/' || fullname;
END IF;
IF v_count > 0 THEN
    INSERT INTO users_count (count) VALUES (v_count);
    RETURN 't';
ELSE
    RETURN 'f';
END IF;

41.6.4.3. IF-THEN-ELSIF #

IF boolean-expression THEN
    statements
[ ELSIF boolean-expression THEN
    statements
[ ELSIF boolean-expression THEN
    statements
    ...
]
]
[ ELSE
    statements ]
END IF;

有时会存在两个以上的选择。IF-THEN-ELSIF 提供了一种方便的方法来依次检查多个选项。IF 条件按顺序测试,直到找到第一个为真的条件。然后执行关联的语句,之后控制传递到 END IF 之后的下一个语句。(任何后续的 IF 条件将 不会 进行测试。)如果所有 IF 条件都不为真,则执行 ELSE 块(如果存在)。

以下是一个例子

IF number = 0 THEN
    result := 'zero';
ELSIF number > 0 THEN
    result := 'positive';
ELSIF number < 0 THEN
    result := 'negative';
ELSE
    -- hmm, the only other possibility is that number is null
    result := 'NULL';
END IF;

关键字 ELSIF 也可以拼写为 ELSEIF

另一种完成相同任务的方法是嵌套 IF-THEN-ELSE 语句,如下面的示例所示

IF demo_row.sex = 'm' THEN
    pretty_sex := 'man';
ELSE
    IF demo_row.sex = 'f' THEN
        pretty_sex := 'woman';
    END IF;
END IF;

然而,这种方法需要为每个 IF 编写匹配的 END IF,因此当存在许多选项时,它比使用 ELSIF 更加麻烦。

41.6.4.4. 简单 CASE #

CASE search-expression
    WHEN expression [, expression [ ... ]] THEN
      statements
  [ WHEN expression [, expression [ ... ]] THEN
      statements
    ... ]
  [ ELSE
      statements ]
END CASE;

简单形式的 CASE 基于操作数的相等性提供条件执行。search-expression 被(仅一次)计算,并依次与 WHEN 子句中的每个 expression 进行比较。如果找到匹配项,则执行相应的 statements,然后控制传递到 END CASE 之后的下一个语句。(后续的 WHEN 表达式不会被评估。)如果未找到匹配项,则执行 ELSE statements;但如果 ELSE 不存在,则会引发 CASE_NOT_FOUND 异常。

以下是一个简单的例子

CASE x
    WHEN 1, 2 THEN
        msg := 'one or two';
    ELSE
        msg := 'other value than one or two';
END CASE;

41.6.4.5. 搜索式 CASE #

CASE
    WHEN boolean-expression THEN
      statements
  [ WHEN boolean-expression THEN
      statements
    ... ]
  [ ELSE
      statements ]
END CASE;

搜索式形式的 CASE 基于布尔表达式的真伪提供条件执行。WHEN 子句的每个 boolean-expression 按顺序评估,直到找到一个产生 true 的表达式。然后执行相应的 statements,然后控制传递到 END CASE 之后的下一个语句。(后续的 WHEN 表达式不会被评估。)如果没有找到真结果,则执行 ELSE statements;但如果 ELSE 不存在,则会引发 CASE_NOT_FOUND 异常。

以下是一个例子

CASE
    WHEN x BETWEEN 0 AND 10 THEN
        msg := 'value is between zero and ten';
    WHEN x BETWEEN 11 AND 20 THEN
        msg := 'value is between eleven and twenty';
END CASE;

这种形式的 CASEIF-THEN-ELSIF 完全等价,除了规则是:到达一个省略的 ELSE 子句会引发错误,而不是什么都不做。

41.6.5. 简单循环 #

使用 LOOPEXITCONTINUEWHILEFORFOREACH 语句,您可以安排您的 PL/pgSQL 函数重复执行一系列命令。

41.6.5.1. LOOP #

[ <<label>> ]
LOOP
    statements
END LOOP [ label ];

LOOP 定义一个无条件循环,该循环将无限重复,直到被 EXITRETURN 语句终止。可选的 label 可以被嵌套循环内的 EXITCONTINUE 语句使用,以指定这些语句引用哪个循环。

41.6.5.2. EXIT #

EXIT [ label ] [ WHEN boolean-expression ];

如果没有给出 label,则终止最内层循环,并接着执行 END LOOP 之后的语句。如果给出了 label,则它必须是当前或某个外层嵌套循环或块的标签。然后,指定的循环或块将被终止,并且控制将继续执行循环/块的相应 END 之后的语句。

如果指定了 WHEN,则仅当 boolean-expression 为真时才会发生循环退出。否则,控制将传递到 EXIT 之后的语句。

EXIT 可用于所有类型的循环;它不限于用于无条件循环。

当与 BEGIN 块一起使用时,EXIT 将控制传递到块末尾之后的下一个语句。请注意,为此目的必须使用标签;未标记的 EXIT 永远不会被视为匹配 BEGIN 块。(这是对 PostgreSQL 8.4 之前的版本的更改,当时允许未标记的 EXIT 匹配 BEGIN 块。)

示例

LOOP
    -- some computations
    IF count > 0 THEN
        EXIT;  -- exit loop
    END IF;
END LOOP;

LOOP
    -- some computations
    EXIT WHEN count > 0;  -- same result as previous example
END LOOP;

<<ablock>>
BEGIN
    -- some computations
    IF stocks > 100000 THEN
        EXIT ablock;  -- causes exit from the BEGIN block
    END IF;
    -- computations here will be skipped when stocks > 100000
END;

41.6.5.3. CONTINUE #

CONTINUE [ label ] [ WHEN boolean-expression ];

如果没有给出 label,则开始最内层循环的下一次迭代。也就是说,循环体中剩余的所有语句都将被跳过,并且控制将返回到循环控制表达式(如果存在)以确定是否需要另一次循环迭代。如果存在 label,则它指定了将继续执行的循环的标签。

如果指定了 WHEN,则仅当 boolean-expression 为真时才会开始循环的下一次迭代。否则,控制将传递到 CONTINUE 之后的语句。

CONTINUE 可用于所有类型的循环;它不限于用于无条件循环。

示例

LOOP
    -- some computations
    EXIT WHEN count > 100;
    CONTINUE WHEN count < 50;
    -- some computations for count IN [50 .. 100]
END LOOP;

41.6.5.4. WHILE #

[ <<label>> ]
WHILE boolean-expression LOOP
    statements
END LOOP [ label ];

WHILE 语句在 boolean-expression 评估为真时重复执行一系列语句。表达式在每次进入循环体之前进行检查。

例如

WHILE amount_owed > 0 AND gift_certificate_balance > 0 LOOP
    -- some computations here
END LOOP;

WHILE NOT done LOOP
    -- some computations here
END LOOP;

41.6.5.5. FOR(整数变体) #

[ <<label>> ]
FOR name IN [ REVERSE ] expression .. expression [ BY expression ] LOOP
    statements
END LOOP [ label ];

此形式的 FOR 创建一个循环,该循环在整数值范围内迭代。变量 name 被自动定义为 integer 类型,并且仅在循环内部存在(在循环内部,忽略该变量名的任何现有定义)。给出范围的下限和上限的两个表达式在进入循环时被评估一次。如果未指定 BY 子句,则迭代步长为 1,否则为 BY 子句中指定的值,该值在循环进入时被评估一次。如果指定了 REVERSE,则在每次迭代后减去步长值,而不是加。

整数 FOR 循环的一些示例

FOR i IN 1..10 LOOP
    -- i will take on the values 1,2,3,4,5,6,7,8,9,10 within the loop
END LOOP;

FOR i IN REVERSE 10..1 LOOP
    -- i will take on the values 10,9,8,7,6,5,4,3,2,1 within the loop
END LOOP;

FOR i IN REVERSE 10..1 BY 2 LOOP
    -- i will take on the values 10,8,6,4,2 within the loop
END LOOP;

如果下限大于上限(在 REVERSE 的情况下小于),则根本不执行循环体。不会引发错误。

如果 label 附加到 FOR 循环,则可以使用带标签的限定名称引用整数循环变量。

41.6.6. 遍历查询结果循环 #

使用不同类型的 FOR 循环,您可以遍历查询结果并相应地操作这些数据。语法是

[ <<label>> ]
FOR target IN query LOOP
    statements
END LOOP [ label ];

target 是一个记录变量、行变量或逗号分隔的标量变量列表。target 被依次赋值 query 返回的每一行,并且循环体为每一行执行。例如

CREATE FUNCTION refresh_mviews() RETURNS integer AS $$
DECLARE
    mviews RECORD;
BEGIN
    RAISE NOTICE 'Refreshing all materialized views...';

    FOR mviews IN
       SELECT n.nspname AS mv_schema,
              c.relname AS mv_name,
              pg_catalog.pg_get_userbyid(c.relowner) AS owner
         FROM pg_catalog.pg_class c
    LEFT JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace)
        WHERE c.relkind = 'm'
     ORDER BY 1
    LOOP

        -- Now "mviews" has one record with information about the materialized view

        RAISE NOTICE 'Refreshing materialized view %.% (owner: %)...',
                     quote_ident(mviews.mv_schema),
                     quote_ident(mviews.mv_name),
                     quote_ident(mviews.owner);
        EXECUTE format('REFRESH MATERIALIZED VIEW %I.%I', mviews.mv_schema, mviews.mv_name);
    END LOOP;

    RAISE NOTICE 'Done refreshing materialized views.';
    RETURN 1;
END;
$$ LANGUAGE plpgsql;

如果循环被 EXIT 语句终止,则最后一个赋值的行值在循环之后仍然可访问。

此类型 FOR 语句中使用的 query 可以是任何返回行给调用者的 SQL 命令:SELECT 是最常见的情况,但您也可以使用带有 RETURNING 子句的 INSERTUPDATEDELETEMERGE。某些实用程序命令,如 EXPLAIN,也将起作用。

PL/pgSQL 变量被查询参数替换,并且查询计划被缓存以供重用,具体细节请参见 Section 41.11.1Section 41.11.2

FOR-IN-EXECUTE 语句是遍历行的另一种方式

[ <<label>> ]
FOR target IN EXECUTE text_expression [ USING expression [, ... ] ] LOOP
    statements
END LOOP [ label ];

这与前一种形式类似,只是源查询被指定为一个字符串表达式,该表达式在每次进入 FOR 循环时进行评估和重新计划。这允许程序员像使用普通 EXECUTE 语句一样,选择预计划查询的速度或动态查询的灵活性。与 EXECUTE 一样,可以通过 USING 将参数值插入到动态命令中。

指定应遍历其结果的查询的另一种方法是将其声明为游标。这在 Section 41.7.4 中进行了描述。

41.6.7. 遍历数组循环 #

FOREACH 循环非常类似于 FOR 循环,但它不是遍历 SQL 查询返回的行,而是遍历数组值的元素。(通常,FOREACH 用于循环遍历复合值表达式的组件;未来可能会添加用于循环遍历除数组以外的复合类型的变体。)用于遍历数组的 FOREACH 语句是

[ <<label>> ]
FOREACH target [ SLICE number ] IN ARRAY expression LOOP
    statements
END LOOP [ label ];

不带 SLICE,或者如果指定了 SLICE 0,则循环遍历通过评估 expression 生成的数组的单个元素。target 变量按顺序被赋值每个元素的值,并且循环体为每个元素执行。以下是一个遍历整数数组元素的示例

CREATE FUNCTION sum(int[]) RETURNS int8 AS $$
DECLARE
  s int8 := 0;
  x int;
BEGIN
  FOREACH x IN ARRAY $1
  LOOP
    s := s + x;
  END LOOP;
  RETURN s;
END;
$$ LANGUAGE plpgsql;

无论数组维度如何,元素都按存储顺序访问。虽然 target 通常只是一个变量,但在遍历复合值(记录)数组时,它可以是一个变量列表。在这种情况下,对于每个数组元素,变量将从复合值的连续列中赋值。

SLICE 为正值时,FOREACH 遍历数组的切片而不是单个元素。SLICE 值必须是一个不大于数组维数的整数常量。target 变量必须是一个数组,它接收数组值的连续切片,其中每个切片都具有 SLICE 指定的维数。以下是一个遍历一维切片的示例

CREATE FUNCTION scan_rows(int[]) RETURNS void AS $$
DECLARE
  x int[];
BEGIN
  FOREACH x SLICE 1 IN ARRAY $1
  LOOP
    RAISE NOTICE 'row = %', x;
  END LOOP;
END;
$$ LANGUAGE plpgsql;

SELECT scan_rows(ARRAY[[1,2,3],[4,5,6],[7,8,9],[10,11,12]]);

NOTICE:  row = {1,2,3}
NOTICE:  row = {4,5,6}
NOTICE:  row = {7,8,9}
NOTICE:  row = {10,11,12}

41.6.8. 捕获错误 #

默认情况下,PL/pgSQL 函数中发生的任何错误都会中止函数和周围事务的执行。您可以使用带有 EXCEPTION 子句的 BEGIN 块来捕获错误并从中恢复。语法是普通 BEGIN 块语法的扩展

[ <<label>> ]
[ DECLARE
    declarations ]
BEGIN
    statements
EXCEPTION
    WHEN condition [ OR condition ... ] THEN
        handler_statements
    [ WHEN condition [ OR condition ... ] THEN
          handler_statements
      ... ]
END;

如果没有发生错误,此形式的块将简单地执行所有 statements,然后控制传递到 END 之后的下一个语句。但是,如果在 statements 中发生错误,则会放弃对 statements 的进一步处理,并将控制传递给 EXCEPTION 列表。列表将被搜索以查找与发生的错误匹配的第一个 condition。如果找到匹配项,则执行相应的 handler_statements,然后控制传递到 END 之后的下一个语句。如果没有找到匹配项,则错误将像没有 EXCEPTION 子句一样传播出去:错误可以被带有 EXCEPTION 的嵌套块捕获,如果没有,则会中止函数的处理。

condition 名称可以是 Appendix A 中显示的任何名称。类别名称匹配其类别内的任何错误。特殊条件名称 OTHERS 匹配除 QUERY_CANCELEDASSERT_FAILURE 之外的所有错误类型。(通过名称捕获这两个错误类型是可能的,但通常不明智。)条件名称不区分大小写。此外,可以通过 SQLSTATE 代码指定错误条件;例如,以下是等效的

WHEN division_by_zero THEN ...
WHEN SQLSTATE '22012' THEN ...

如果在选定的 handler_statements 中发生新错误,它将无法被此 EXCEPTION 子句捕获,但会传播出去。一个围绕的 EXCEPTION 子句可以捕获它。

当错误被 EXCEPTION 子句捕获时,PL/pgSQL 函数的局部变量将保持在错误发生时的状态,但块内对持久数据库状态的所有更改都将被回滚。例如,考虑此片段

INSERT INTO mytab(firstname, lastname) VALUES('Tom', 'Jones');
BEGIN
    UPDATE mytab SET firstname = 'Joe' WHERE lastname = 'Jones';
    x := x + 1;
    y := x / 0;
EXCEPTION
    WHEN division_by_zero THEN
        RAISE NOTICE 'caught division_by_zero';
        RETURN x;
END;

当控制到达对 y 的赋值时,它将因 division_by_zero 错误而失败。这将由 EXCEPTION 子句捕获。在 RETURN 语句中返回的值将是 x 的递增值,但 UPDATE 命令的效果将被回滚。但是,在块之前的 INSERT 命令不会被回滚,因此最终结果是数据库包含 Tom Jones 而不是 Joe Jones

提示

包含 EXCEPTION 子句的块在进入和退出时比没有它的块要昂贵得多。因此,请不要在不需要时使用 EXCEPTION

示例 41.2. 带有 UPDATE/INSERT 的异常

此示例使用异常处理来执行 UPDATEINSERT(视情况而定)。建议应用程序使用带有 ON CONFLICT DO UPDATEINSERT,而不是实际使用此模式。此示例主要用于说明 PL/pgSQL 控制流结构的使用。

CREATE TABLE db (a INT PRIMARY KEY, b TEXT);

CREATE FUNCTION merge_db(key INT, data TEXT) RETURNS VOID AS
$$
BEGIN
    LOOP
        -- first try to update the key
        UPDATE db SET b = data WHERE a = key;
        IF found THEN
            RETURN;
        END IF;
        -- not there, so try to insert the key
        -- if someone else inserts the same key concurrently,
        -- we could get a unique-key failure
        BEGIN
            INSERT INTO db(a,b) VALUES (key, data);
            RETURN;
        EXCEPTION WHEN unique_violation THEN
            -- Do nothing, and loop to try the UPDATE again.
        END;
    END LOOP;
END;
$$
LANGUAGE plpgsql;

SELECT merge_db(1, 'david');
SELECT merge_db(1, 'dennis');

此代码假定 unique_violation 错误是由 INSERT 引起的,而不是由表上的触发器函数中的 INSERT 等引起的。它也可能表现不佳,如果表上有多个唯一索引,因为它将重试操作,而不管哪个索引导致了错误。通过使用接下来讨论的功能来检查捕获到的错误是否是预期的错误,可以获得更高的安全性。


41.6.8.1. 获取错误信息 #

异常处理程序经常需要识别发生的特定错误。PL/pgSQL 中获取当前异常信息有两种方法:特殊变量和 GET STACKED DIAGNOSTICS 命令。

在异常处理程序中,特殊变量 SQLSTATE 包含与引发的异常相对应的错误代码(有关可能错误代码的列表,请参阅 Table A.1)。特殊变量 SQLERRM 包含与异常相关的错误消息。这些变量在异常处理程序外部是未定义的。

在异常处理程序中,还可以通过使用 GET STACKED DIAGNOSTICS 命令来检索当前异常的信息,该命令的形式是

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

每个 item 都是一个关键字,用于标识要分配给指定 variable 的状态值(该变量应具有接收它的正确数据类型)。当前可用的状态项显示在 Table 41.2 中。

Table 41.2. 错误诊断项

名称 类型 描述
RETURNED_SQLSTATE text 异常的 SQLSTATE 错误代码
COLUMN_NAME text 与异常相关的列名
CONSTRAINT_NAME text 与异常相关的约束名称
PG_DATATYPE_NAME text 与异常相关的数据类型名称
MESSAGE_TEXT text 异常主消息的文本
TABLE_NAME text 与异常相关的表名
SCHEMA_NAME text 与异常相关的模式名
PG_EXCEPTION_DETAIL text 异常详细消息的文本(如果有)
PG_EXCEPTION_HINT text 异常提示消息的文本(如果有)
PG_EXCEPTION_CONTEXT text 描述异常发生时调用堆栈的文本行(参见 Section 41.6.9

如果异常未为某个项设置值,则返回空字符串。

以下是一个例子

DECLARE
  text_var1 text;
  text_var2 text;
  text_var3 text;
BEGIN
  -- some processing which might cause an exception
  ...
EXCEPTION WHEN OTHERS THEN
  GET STACKED DIAGNOSTICS text_var1 = MESSAGE_TEXT,
                          text_var2 = PG_EXCEPTION_DETAIL,
                          text_var3 = PG_EXCEPTION_HINT;
END;

41.6.9. 获取执行位置信息 #

前面在 Section 41.5.5 中描述的 GET DIAGNOSTICS 命令用于检索有关当前执行状态的信息(而上面讨论的 GET STACKED DIAGNOSTICS 命令报告的是关于先前错误发生时的执行状态的信息)。其 PG_CONTEXT 状态项对于识别当前执行位置非常有用。PG_CONTEXT 返回一个文本字符串,其中包含描述调用堆栈的文本行。第一行指的是当前函数和当前正在执行的 GET DIAGNOSTICS 命令。第二行及后续行指代调用堆栈更上层的调用函数。例如

CREATE OR REPLACE FUNCTION outer_func() RETURNS integer AS $$
BEGIN
  RETURN inner_func();
END;
$$ LANGUAGE plpgsql;

CREATE OR REPLACE FUNCTION inner_func() RETURNS integer AS $$
DECLARE
  stack text;
BEGIN
  GET DIAGNOSTICS stack = PG_CONTEXT;
  RAISE NOTICE E'--- Call Stack ---\n%', stack;
  RETURN 1;
END;
$$ LANGUAGE plpgsql;

SELECT outer_func();

NOTICE:  --- Call Stack ---
PL/pgSQL function inner_func() line 5 at GET DIAGNOSTICS
PL/pgSQL function outer_func() line 3 at RETURN
CONTEXT:  PL/pgSQL function outer_func() line 3 at RETURN
 outer_func
 ------------
           1
(1 row)

GET STACKED DIAGNOSTICS ... PG_EXCEPTION_CONTEXT 返回相同的堆栈跟踪,但描述的是检测到错误的位置,而不是当前位置。

提交更正

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