2024年9月26日: PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 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 后跟表达式将终止函数并将 表达式 的值返回给调用方。此形式用于不返回集合的 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,或者当只有一个类型为 sometype 的输出参数时,声明为返回 SETOF 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 之前版本的一个变化,这些版本允许无标签的 EXITBEGIN 代码块匹配。)

示例

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 循环,则可以使用限定名称(使用该 label)引用整数循环变量。

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 是最常见的情况,但您也可以使用 INSERTUPDATEDELETEMERGE 以及 RETURNING 子句。一些实用程序命令(如 EXPLAIN)也可以使用。

PL/pgSQL 变量将被查询参数替换,并且查询计划会被缓存以供可能的重复使用,如 第 41.11.1 节第 41.11.2 节 中详细讨论。

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

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

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

指定要遍历其结果的查询的另一种方法是将其声明为游标。这在 第 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;

如果未发生错误,这种形式的代码块会简单地执行所有语句,然后控制权传递到END之后的下一条语句。但是,如果在语句中发生错误,则会放弃对语句的进一步处理,并将控制权传递到EXCEPTION列表。该列表将搜索与发生的错误匹配的第一个条件。如果找到匹配项,则执行相应的处理程序语句,然后控制权传递到END之后的下一条语句。如果未找到匹配项,则错误会像EXCEPTION子句不存在一样传播出去:该错误可以被包含EXCEPTION的外部代码块捕获,或者如果没有外部代码块,则会中止函数的处理。

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

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

如果在选定的处理程序语句中发生新的错误,则此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包含与引发异常相对应的错误代码(有关可能的错误代码列表,请参阅表 A.1)。特殊变量SQLERRM包含与异常关联的错误消息。这些变量在异常处理程序之外未定义。

在异常处理程序中,还可以使用GET STACKED DIAGNOSTICS命令检索有关当前异常的信息,该命令具有以下形式

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

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

表 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 描述异常发生时调用堆栈的行(请参阅第 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. 获取执行位置信息 #

前面在第 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返回相同类型的堆栈跟踪,但描述的是检测到错误的位置,而不是当前位置。

提交更正

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