2024年9月26日: PostgreSQL 17 发布!
支持版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不受支持的版本: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

32.13. 通知处理 #

服务器生成的通知和警告消息不会由查询执行函数返回,因为它们并不意味着查询失败。相反,它们会被传递给一个通知处理函数,并且在处理程序返回后,执行将正常继续。默认的通知处理函数会在 stderr 上打印消息,但应用程序可以通过提供自己的处理函数来覆盖此行为。

出于历史原因,存在两个级别的通知处理,称为通知接收器和通知处理器。默认行为是通知接收器格式化通知并将字符串传递给通知处理器进行打印。但是,选择提供自己通知接收器的应用程序通常会忽略通知处理器层,而只在通知接收器中完成所有工作。

函数 PQsetNoticeReceiver 设置或检查连接对象的当前通知接收器。类似地,PQsetNoticeProcessor 设置或检查当前的通知处理器。

typedef void (*PQnoticeReceiver) (void *arg, const PGresult *res);

PQnoticeReceiver
PQsetNoticeReceiver(PGconn *conn,
                    PQnoticeReceiver proc,
                    void *arg);

typedef void (*PQnoticeProcessor) (void *arg, const char *message);

PQnoticeProcessor
PQsetNoticeProcessor(PGconn *conn,
                     PQnoticeProcessor proc,
                     void *arg);

每个函数都返回先前的通知接收器或处理器函数指针,并设置新值。如果您提供一个空函数指针,则不会执行任何操作,但会返回当前指针。

当从服务器接收或由 libpq 内部生成通知或警告消息时,将调用通知接收器函数。它以 PGRES_NONFATAL_ERROR PGresult 的形式传递消息。(这允许接收器使用 PQresultErrorField 提取各个字段,或使用 PQresultErrorMessagePQresultVerboseErrorMessage 获取完整的预格式化消息。)传递给 PQsetNoticeReceiver 的相同 void 指针也会被传递。(如果需要,此指针可用于访问特定于应用程序的状态。)

默认的通知接收器只需提取消息(使用 PQresultErrorMessage)并将其传递给通知处理器。

通知处理器负责处理以文本形式给出的通知或警告消息。它被传递消息的字符串文本(包括尾随换行符),以及一个与传递给 PQsetNoticeProcessor 的相同的 void 指针。(如果需要,此指针可用于访问特定于应用程序的状态。)

默认的通知处理器很简单:

static void
defaultNoticeProcessor(void *arg, const char *message)
{
    fprintf(stderr, "%s", message);
}

设置通知接收器或处理器后,您应该期望只要 PGconn 对象或由此对象创建的 PGresult 对象存在,该函数就可能被调用。在创建 PGresult 时,PGconn 的当前通知处理指针会被复制到 PGresult 中,以便像 PQgetvalue 这样的函数可能使用。

提交更正

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