Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14 / 15 / 16

56.2. 在服务器内报告错误 #

应使用 ereport 或其较早的同类项 elog 创建服务器代码内生成的错误、警告和日志消息。此函数的使用非常复杂,需要一些解释。

每个消息都有两个必需元素:严重性级别(范围从 DEBUGPANIC)和一个主消息文本。此外,还有可选元素,最常见的是遵循 SQL 规范的 SQLSTATE 约定的错误标识符代码。 ereport 本身只是一个 shell 宏,主要用于语法方便,使消息生成看起来像 C 源代码中的单个函数调用。 ereport 直接接受的唯一参数是严重性级别。主消息文本和任何可选消息元素都是通过在 ereport 调用中调用辅助函数(例如 errmsg)生成的。

ereport 的典型调用可能如下所示

ereport(ERROR,
        errcode(ERRCODE_DIVISION_BY_ZERO),
        errmsg("division by zero"));

这指定了错误严重性级别 ERROR(一个普通的错误)。 errcode 调用使用在 src/include/utils/errcodes.h 中定义的宏指定 SQLSTATE 错误代码。 errmsg 调用提供主消息文本。

您还经常会看到这种旧样式,其中辅助函数调用周围有一组额外的括号

ereport(ERROR,
        (errcode(ERRCODE_DIVISION_BY_ZERO),
         errmsg("division by zero")));

PostgreSQL 12 版本之前需要额外的括号,但现在是可选的。

这是一个更复杂的示例

ereport(ERROR,
        errcode(ERRCODE_AMBIGUOUS_FUNCTION),
        errmsg("function %s is not unique",
               func_signature_string(funcname, nargs,
                                     NIL, actual_arg_types)),
        errhint("Unable to choose a best candidate function. "
                "You might need to add explicit typecasts."));

这说明了如何使用格式代码将运行时值嵌入到消息文本中。此外,还提供了可选的 提示 消息。辅助函数调用可以按任何顺序编写,但通常 errcodeerrmsg 首先出现。

如果严重性级别为 ERROR 或更高,则 ereport 会中止当前查询的执行,并且不会返回给调用者。如果严重性级别低于 ERROR,则 ereport 会正常返回。

用于 ereport 的可用辅助例程是

注意

ereport 调用中最多只能使用一个函数 errtableerrtablecolerrtableconstrainterrdatatypeerrdomainconstraint。这些函数的存在是为了允许应用程序提取与错误条件关联的数据库对象的名称,而无需检查可能已本地化的错误消息文本。这些函数应用于错误报告,对于这些报告,应用程序可能希望自动处理错误。从 PostgreSQL 9.3 开始,仅对 SQLSTATE 类 23(完整性约束冲突)中的错误提供了完整覆盖,但将来可能会扩展此范围。

有一个较旧的函数 elog,它仍然被大量使用。一个 elog 调用

elog(level, "format string", ...);

与以下内容完全等效

ereport(level, errmsg_internal("format string", ...));

请注意,SQLSTATE 错误代码始终为默认值,并且消息字符串不会翻译。因此,elog 应仅用于内部错误和低级调试日志记录。任何可能对普通用户感兴趣的消息都应通过 ereport 传递。尽管如此,系统中仍有足够的内部 不可能发生 错误检查,因此 elog 仍然被广泛使用;对于那些消息,它因其符号简单而受到青睐。

有关编写良好错误消息的建议,请参见 第 56.3 节



[16] 也就是说,当 ereport 调用被访问时当前的值;辅助报告例程中 errno 的更改不会影响它。如果您要在 errmsg 的参数列表中显式编写 strerror(errno),则情况并非如此;因此,请不要这样做。