控制结构可能是 PL/pgSQL 中最有用的(也是最重要的)部分。使用 PL/pgSQL 的控制结构,您可以非常灵活且高效地操作 PostgreSQL 数据。
有两个命令可用于从函数返回数据:RETURN
和 RETURN NEXT
。
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
RETURN NEXT
和 RETURN QUERY
#RETURN NEXTexpression
; RETURN QUERYquery
; RETURN QUERY EXECUTEcommand-string
[ USINGexpression
[, ... ] ];
当 PL/pgSQL 函数被声明为返回 SETOF
时,要遵循的过程略有不同。在这种情况下,要返回的各个项由一系列 sometype
RETURN NEXT
或 RETURN QUERY
命令指定,然后使用不带参数的最终 RETURN
命令来指示函数已完成执行。 RETURN NEXT
可用于标量和复合数据类型;对于复合结果类型,将返回整个 “表” 的结果。 RETURN QUERY
将执行查询的结果附加到函数的结果集中。 RETURN NEXT
和 RETURN QUERY
可以自由地混合在一个返回集的函数中,在这种情况下,它们的结果将被连接起来。
RETURN NEXT
和 RETURN QUERY
实际上不会从函数返回——它们只是将零行或多行附加到函数的结果集中。然后执行 PL/pgSQL 函数中下一条语句。随着连续执行 RETURN NEXT
或 RETURN 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 NEXT
和 RETURN QUERY
的当前实现会在从函数返回之前存储整个结果集。这意味着如果 PL/pgSQL 函数生成一个非常大的结果集,则性能可能会很差:数据将被写入磁盘以避免内存耗尽,但函数本身在整个结果集生成之前不会返回。未来的 PL/pgSQL 版本可能会允许用户定义没有此限制的集合返回函数。目前,开始将数据写入磁盘的点由 work_mem 配置变量控制。有足够内存来在内存中存储较大结果集的管理员应考虑增加此参数。
过程没有返回值。因此,过程可以在没有 RETURN
语句的情况下结束。如果您希望使用 RETURN
语句提前退出代码,只需编写 RETURN
,而无需表达式。
如果过程具有输出参数,则输出参数变量的最终值将返回给调用方。
PL/pgSQL 函数、过程或 DO
块可以使用 CALL
调用过程。输出参数的处理方式与 CALL
在普通 SQL 中的工作方式不同。过程的每个 OUT
或 INOUT
参数都必须对应于 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; $$;
对应于输出参数的变量可以是简单变量或复合类型变量的字段。目前,它不能是数组的元素。
IF
和 CASE
语句允许您根据特定条件执行备用命令。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
IF-THEN
#IFboolean-expression
THENstatements
END IF;
IF-THEN
语句是 IF
的最简单形式。如果条件为真,则将在 THEN
和 END IF
之间的语句执行。否则,将跳过它们。
示例
IF v_user_id <> 0 THEN UPDATE users SET email = v_email WHERE user_id = v_user_id; END IF;
IF-THEN-ELSE
#IFboolean-expression
THENstatements
ELSEstatements
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;
IF-THEN-ELSIF
#IFboolean-expression
THENstatements
[ ELSIFboolean-expression
THENstatements
[ ELSIFboolean-expression
THENstatements
... ] ] [ ELSEstatements
] 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
繁琐得多。
CASE
#CASEsearch-expression
WHENexpression
[,expression
[ ... ]] THENstatements
[ WHENexpression
[,expression
[ ... ]] THENstatements
... ] [ ELSEstatements
] 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;
CASE
#CASE WHENboolean-expression
THENstatements
[ WHENboolean-expression
THENstatements
... ] [ ELSEstatements
] 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;
此形式的 CASE
与 IF-THEN-ELSIF
完全等效,除了以下规则:达到一个被省略的 ELSE
子句会导致一个错误,而不是什么都不做。
使用 LOOP
、EXIT
、CONTINUE
、WHILE
、FOR
和 FOREACH
语句,你可以安排你的 PL/pgSQL 函数重复一系列命令。
LOOP
#[ <<label
>> ] LOOPstatements
END LOOP [label
];
LOOP
定义一个无条件循环,该循环会无限重复,直到被 EXIT
或 RETURN
语句终止。可选的 label
可由嵌套循环中的 EXIT
和 CONTINUE
语句使用,以指定这些语句所引用的循环。
EXIT
#EXIT [label
] [ WHENboolean-expression
];
如果没有给出 label
,则最内层循环将被终止,并且 END LOOP
之后的语句将被执行。如果给出了 label
,则它必须是当前或某些外部嵌套循环或块的标签。然后,命名的循环或块将被终止,并且控制权将继续执行循环/块的相应 END
之后的语句。
如果指定了 WHEN
,则仅当 boolean-expression
为 true 时,才会退出循环。否则,控制权将传递给 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;
CONTINUE
#CONTINUE [label
] [ WHENboolean-expression
];
如果没有给出 label
,则将开始最内层循环的下一个迭代。也就是说,循环体中剩余的所有语句都将被跳过,并且控制权将返回到循环控制表达式(如果有)以确定是否需要另一个循环迭代。如果存在 label
,则它将指定要继续执行的循环的标签。
如果指定了 WHEN
,则仅当 boolean-expression
为 true 时,才会开始循环的下一个迭代。否则,控制权将传递给 CONTINUE
之后的语句。
CONTINUE
可用于所有类型的循环;它不限于与无条件循环一起使用。
示例
LOOP -- some computations EXIT WHEN count > 100; CONTINUE WHEN count < 50; -- some computations for count IN [50 .. 100] END LOOP;
WHILE
#[ <<label
>> ] WHILEboolean-expression
LOOPstatements
END LOOP [label
];
WHILE
语句会重复一系列语句,只要 boolean-expression
求值为 true。该表达式在每次进入循环体之前都会被检查。
例如
WHILE amount_owed > 0 AND gift_certificate_balance > 0 LOOP -- some computations here END LOOP; WHILE NOT done LOOP -- some computations here END LOOP;
FOR
(整数变体)#[ <<label
>> ] FORname
IN [ REVERSE ]expression
..expression
[ BYexpression
] LOOPstatements
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
)引用整数循环变量。
使用不同类型的 FOR
循环,您可以遍历查询结果并相应地处理该数据。语法如下
[ <<label
>> ] FORtarget
INquery
LOOPstatements
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
是最常见的情况,但您还可以使用 INSERT
、UPDATE
或 DELETE
,并带有 RETURNING
子句。某些实用命令(如 EXPLAIN
)也可以使用。
PL/pgSQL 变量将被查询参数替换,并且查询计划将被缓存以备可能重新使用,如 第 43.11.1 节 和 第 43.11.2 节 中详细讨论的。
FOR-IN-EXECUTE
语句是遍历行的另一种方式
[ <<label
>> ] FORtarget
IN EXECUTEtext_expression
[ USINGexpression
[, ... ] ] LOOPstatements
END LOOP [label
];
这类似于之前的形式,不同之处在于源查询指定为一个字符串表达式,该表达式在每次进入 FOR
循环时进行求值和重新规划。这允许程序员选择预规划查询的速度或动态查询的灵活性,就像使用普通 EXECUTE
语句一样。与 EXECUTE
一样,可以通过 USING
将参数值插入动态命令。
指定应迭代其结果的查询的另一种方法是将其声明为游标。这在 第 43.7.4 节 中进行了描述。
FOREACH
循环与 FOR
循环非常相似,但它不遍历 SQL 查询返回的行,而是遍历数组值中的元素。(通常,FOREACH
用于遍历复合值表达式的组件;除了数组之外,未来可能会添加用于遍历复合体的变体。)用于遍历数组的 FOREACH
语句是
[ <<label
>> ] FOREACHtarget
[ SLICEnumber
] IN ARRAYexpression
LOOPstatements
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}
默认情况下,PL/pgSQL 函数中发生的任何错误都会中止函数和周围事务的执行。您可以使用带有 BEGIN
块和 EXCEPTION
子句来捕获错误并从中恢复。语法是 BEGIN
块的正常语法的扩展
[ <<label
>> ] [ DECLAREdeclarations
] BEGINstatements
EXCEPTION WHENcondition
[ ORcondition
... ] THENhandler_statements
[ WHENcondition
[ ORcondition
... ] THENhandler_statements
... ] END;
如果没有发生错误,这种形式的块只会执行所有 语句
,然后控制权会传递给 END
之后的下一条语句。但是,如果 语句
中发生错误,则会放弃对 语句
的进一步处理,并且控制权会传递给 EXCEPTION
列表。该列表将搜索第一个与发生的错误匹配的 条件
。如果找到匹配项,则会执行相应的 处理程序语句
,然后控制权会传递给 END
之后的下一条语句。如果找不到匹配项,则错误将传播出去,就好像根本没有 EXCEPTION
子句一样:错误可以被带有 EXCEPTION
的封闭块捕获,或者如果没有,它将中止函数的处理。
条件
名称可以是 附录 A 中显示的任何名称。类别名称与类别中的任何错误匹配。特殊条件名称 OTHERS
匹配除 QUERY_CANCELED
和 ASSERT_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
子句的块进入和退出要昂贵得多。因此,不要在不需要时使用 EXCEPTION
。
示例 43.2. 使用 UPDATE
/INSERT
的异常
此示例使用异常处理来执行 UPDATE
或 INSERT
(视情况而定)。建议应用程序使用 INSERT
和 ON CONFLICT DO UPDATE
,而不是实际使用此模式。此示例主要用于说明 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
引起的。如果表上有多个唯一索引,它也可能出现异常,因为它会重试操作,而不管哪个索引导致了错误。通过使用接下来讨论的功能来检查捕获的错误是否为预期的错误,可以获得更高的安全性。
异常处理程序经常需要识别发生的特定错误。在 PL/pgSQL 中有两种方法可以获取有关当前异常的信息:特殊变量和 GET STACKED DIAGNOSTICS
命令。
在异常处理程序中,特殊变量 SQLSTATE
包含与引发的异常相对应的错误代码(有关可能的错误代码列表,请参阅 表 A.1)。特殊变量 SQLERRM
包含与异常关联的错误消息。这些变量在异常处理程序之外未定义。
在异常处理程序中,还可以使用 GET STACKED DIAGNOSTICS
命令检索有关当前异常的信息,其形式为
GET STACKED DIAGNOSTICSvariable
{ = | := }item
[ , ... ];
每个 item
是一个关键字,用于标识要分配给指定 variable
(应为正确的数据类型以接收它)的状态值。当前可用的状态项显示在 表 43.2 中。
表 43.2. 错误诊断项
名称 | 类型 | 描述 |
---|---|---|
RETURNED_SQLSTATE |
文本 |
异常的 SQLSTATE 错误代码 |
COLUMN_NAME |
文本 |
与异常相关的列的名称 |
CONSTRAINT_NAME |
文本 |
与异常相关的约束的名称 |
PG_DATATYPE_NAME |
文本 |
与异常相关的数据类型的名称 |
MESSAGE_TEXT |
文本 |
异常主要消息的文本 |
TABLE_NAME |
文本 |
与异常相关的表的名称 |
SCHEMA_NAME |
文本 |
与异常相关的模式的名称 |
PG_EXCEPTION_DETAIL |
文本 |
异常的详细信息消息的文本(如果有) |
PG_EXCEPTION_HINT |
文本 |
异常的提示消息的文本(如果有) |
PG_EXCEPTION_CONTEXT |
文本 |
异常发生时的调用堆栈描述文本行(参见第 43.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;
之前在第 43.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
返回相同类型的堆栈跟踪,但描述的是检测到错误的位置,而不是当前位置。