↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发中的版本: 19 / 20devel
已结束支持的版本: 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
历史版本。 PostgreSQL 10 已结束支持。 2022-11-10. 请参阅 当前版本手册.

42.8. 错误和消息 #

42.8.1. 报告错误和消息 #

使用 RAISE 语句报告消息和抛出错误。

RAISE [ level ] 'format' [, expression [, ... ]] [ USING option = expression [, ... ] ];
RAISE [ level ] condition_name [ USING option = expression [, ... ] ];
RAISE [ level ] SQLSTATE 'sqlstate' [ USING option = expression [, ... ] ];
RAISE [ level ] USING option = expression [, ... ];
RAISE ;

其中,level 选项指定错误的严重程度。允许的级别为 DEBUG,LOG,INFO,NOTICE,WARNING 以及 EXCEPTION,其中 EXCEPTION 是默认值。EXCEPTION 会抛出错误(通常会中止当前事务);其他级别只会生成不同优先级的消息。特定优先级的消息是报告给客户端、写入服务器日志,还是两者都做,由 log_min_messages 和 client_min_messages 配置变量控制。更多信息见第 19 章中的说明。

在 level(如果有)之后,可以指定一个 format 字符串(必须是简单的字符串字面量,不能是表达式)。格式字符串指定要报告的错误消息文本。格式字符串之后可以跟上可选的参数表达式,其值将被插入消息中。在格式字符串内,% 会被替换为下一个可选参数值的字符串表示。写成%% 可以输出一个字面的%。参数个数必须与格式字符串中% 占位符的个数匹配,否则会在函数编译期间报错。

在这个示例中,v_job_id 的值将替换字符串中的%:

RAISE NOTICE 'Calling cs_create_job(%)', v_job_id;

可以为错误报告附加额外信息,方法是写出 USING,后面跟上 option = expression 项目。每个 expression 都可以是任意字符串值表达式。允许的 option 关键字为:

MESSAGE

设置错误消息文本。该选项不能用于在 USING 之前包含格式字符串的 RAISE 形式。

DETAIL

提供错误的详细信息。

HINT

提供一个提示消息。

ERRCODE

指定要报告的错误代码(SQLSTATE),可以用附录 A 中所示的条件名,或者直接作为一个五字符 SQLSTATE 代码。

COLUMN
CONSTRAINT
DATATYPE
TABLE
SCHEMA

提供一个相关对象的名称。

这个例子会中止事务,并给出指定的错误消息和提示:

RAISE EXCEPTION 'Nonexistent ID --> %', user_id
      USING HINT = 'Please check your user ID';

这两个示例展示了设置 SQLSTATE 的两种等价的方法:

RAISE 'Duplicate user ID: %', user_id USING ERRCODE = 'unique_violation';
RAISE 'Duplicate user ID: %', user_id USING ERRCODE = '23505';

还有第二种 RAISE 语法,其中主参数是要报告的条件名或 SQLSTATE,例如:

RAISE division_by_zero;
RAISE SQLSTATE '22012';

在这种语法中,USING 可以用来提供自定义的错误消息、细节或提示。另一种达到前面示例同样效果的方式是:

RAISE unique_violation USING MESSAGE = 'Duplicate user ID: ' || user_id;

还有另一种变体是写 RAISE USING 或 RAISE level USING,并把其余内容都放在 USING 列表里。

RAISE 的最后一种变体根本没有参数。这种形式只能被用在一个 BEGIN 块的 EXCEPTION 子句中,它导致当前正在被处理的错误被重新抛出。

注意

在 PostgreSQL 9.1 之前,没有参数的 RAISE 被解释为重新抛出来自包含活动异常处理器的块的错误。因此一个嵌套在那个处理器中的 EXCEPTION 子句无法捕捉它,即使 RAISE 位于嵌套 EXCEPTION 子句的块中也是这样。这种行为很奇怪,也并不兼容 Oracle 的 PL/SQL。

如果在 RAISE EXCEPTION 命令中没有指定条件名称或 SQLSTATE,则默认使用 ERRCODE_RAISE_EXCEPTION (P0001)。如果没有指定消息文本,则默认使用条件名称或 SQLSTATE 作为消息文本。

注意

当用 SQLSTATE 代码指定错误代码时,你并不受限于预定义错误代码,而是可以选择任何由五位数字和/或大写 ASCII 字母构成的错误代码,唯一不能使用的是 00000。我们建议尽量避免抛出以三个零结尾的错误代码,因为这些是类别代码,只能通过捕获整个类别来捕获这类错误。

42.8.2. 检查断言 #

ASSERT 语句是一种向 PL/pgSQL 函数中插入调试检查的方便方法。

ASSERT condition [ , message ];

condition 是一个布尔表达式,它被期望总是计算为真。如果确实如此,ASSERT 语句不会再做什么。但如果结果是假或者空值,那么将发生一个 ASSERT_FAILURE 异常(如果在计算 condition 时发生错误,它会被报告为一个普通错误)。

如果提供了可选的 message,它是一个结果(如果不为 NULL)被用来替换默认错误消息文本“assertion failed”的表达式(如果 condition 失败)。message 表达式在断言成功的普通情况下不会被计算。

通过配置参数 plpgsql.check_asserts 可以启用或者禁用断言测试,这个参数接受布尔值且默认为 on。如果这个参数为 off,则 ASSERT 语句什么也不做。

注意 ASSERT 是为了检测程序的 bug,而不是报告普通的错误情况。如果要报告普通错误,请使用前面介绍的 RAISE 语句。

报告文档问题

阅读 上游文档. 反馈更正前请先核对 当前版本手册.