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 / 7.3 / 7.2 / 7.1

32.4. 异步命令处理 #

在普通的同步应用程序中,PQexec 函数足以提交命令。但是,它有一些缺点,对于某些用户来说可能很重要

  • PQexec 会等待命令完成。应用程序可能还有其他工作要做(例如维护用户界面),在这种情况下,它不希望阻塞等待响应。

  • 由于客户端应用程序在等待结果时会暂停执行,因此应用程序很难决定是否要尝试取消正在执行的命令。(这可以通过信号处理程序来完成,但不能通过其他方式完成。)

  • PQexec 只能返回一个 PGresult 结构。如果提交的命令字符串包含多个SQL命令,除了最后一个 PGresult 之外,所有其他 PGresult 都会被 PQexec 丢弃。

  • PQexec 始终收集命令的完整结果,并将其缓冲在一个 PGresult 中。虽然这简化了应用程序的错误处理逻辑,但对于包含许多行的结果来说,它可能是不切实际的。

不喜欢这些限制的应用程序可以使用 PQexec 所基于的底层函数:PQsendQueryPQgetResult。还有 PQsendQueryParamsPQsendPreparePQsendQueryPreparedPQsendDescribePreparedPQsendDescribePortalPQsendClosePreparedPQsendClosePortal,它们可以与 PQgetResult 一起使用来复制 PQexecParamsPQpreparePQexecPreparedPQdescribePreparedPQdescribePortal PQclosePreparedPQclosePortal 的功能。

PQsendQuery #

将命令提交到服务器,而不等待结果。如果命令成功分派,则返回 1,否则返回 0(在这种情况下,使用 PQerrorMessage 获取有关失败的更多信息)。

int PQsendQuery(PGconn *conn, const char *command);

成功调用 PQsendQuery 后,调用 PQgetResult 一次或多次以获取结果。PQsendQuery 无法再次调用(在同一个连接上),直到 PQgetResult 返回空指针,表明命令已完成。

在管道模式下,此函数不允许使用。

PQsendQueryParams #

将命令和单独的参数提交到服务器,而不等待结果。

int PQsendQueryParams(PGconn *conn,
                      const char *command,
                      int nParams,
                      const Oid *paramTypes,
                      const char * const *paramValues,
                      const int *paramLengths,
                      const int *paramFormats,
                      int resultFormat);

这等效于 PQsendQuery,只是查询参数可以与查询字符串分开指定。该函数的参数处理方式与 PQexecParams 完全相同。与 PQexecParams 一样,它只允许在查询字符串中使用一个命令。

PQsendPrepare #

发送一个请求,使用给定的参数创建准备好的语句,而不等待完成。

int PQsendPrepare(PGconn *conn,
                  const char *stmtName,
                  const char *query,
                  int nParams,
                  const Oid *paramTypes);

这是 PQprepare 的异步版本:如果它能够分派请求,则返回 1,否则返回 0。成功调用后,调用 PQgetResult 以确定服务器是否成功创建了准备好的语句。该函数的参数处理方式与 PQprepare 完全相同。

PQsendQueryPrepared #

发送一个请求,使用给定的参数执行准备好的语句,而不等待结果。

int PQsendQueryPrepared(PGconn *conn,
                        const char *stmtName,
                        int nParams,
                        const char * const *paramValues,
                        const int *paramLengths,
                        const int *paramFormats,
                        int resultFormat);

这类似于 PQsendQueryParams,但要执行的命令是通过命名先前准备好的语句来指定的,而不是提供查询字符串。该函数的参数处理方式与 PQexecPrepared 完全相同。

PQsendDescribePrepared #

提交一个请求,获取有关指定准备好的语句的信息,而不等待完成。

int PQsendDescribePrepared(PGconn *conn, const char *stmtName);

这是 PQdescribePrepared 的异步版本:如果它能够分派请求,则返回 1,否则返回 0。成功调用后,调用 PQgetResult 以获取结果。该函数的参数处理方式与 PQdescribePrepared 完全相同。

PQsendDescribePortal #

提交一个请求,获取有关指定门户的信息,而不等待完成。

int PQsendDescribePortal(PGconn *conn, const char *portalName);

这是 PQdescribePortal 的异步版本:如果它能够分派请求,则返回 1,否则返回 0。成功调用后,调用 PQgetResult 以获取结果。该函数的参数处理方式与 PQdescribePortal 完全相同。

PQsendClosePrepared #

提交一个请求,关闭指定的准备好的语句,而不等待完成。

int PQsendClosePrepared(PGconn *conn, const char *stmtName);

这是 PQclosePrepared 的异步版本:如果它能够分派请求,则返回 1,否则返回 0。成功调用后,调用 PQgetResult 以获取结果。该函数的参数处理方式与 PQclosePrepared 完全相同。

PQsendClosePortal #

提交一个请求,关闭指定的门户,而不等待完成。

int PQsendClosePortal(PGconn *conn, const char *portalName);

这是 PQclosePortal 的异步版本:如果它能够分派请求,则返回 1,否则返回 0。成功调用后,调用 PQgetResult 以获取结果。该函数的参数处理方式与 PQclosePortal 完全相同。

PQgetResult #

等待来自先前 PQsendQueryPQsendQueryParamsPQsendPreparePQsendQueryPreparedPQsendDescribePreparedPQsendDescribePortalPQsendClosePreparedPQsendClosePortalPQsendPipelineSyncPQpipelineSync 调用的下一个结果,并返回它。当命令完成并且不再有结果时,将返回一个空指针。

PGresult *PQgetResult(PGconn *conn);

PQgetResult 必须重复调用,直到它返回一个空指针,指示命令已完成。(如果在没有活动命令时调用,PQgetResult 将立即返回一个空指针。)来自 PQgetResult 的每个非空结果都应该使用前面描述的相同 PGresult 访问器函数进行处理。不要忘记在完成后使用 PQclear 释放每个结果对象。请注意,PQgetResult 仅当命令处于活动状态且 PQconsumeInput 尚未读取必要响应数据时才会阻塞。

在管道模式下,PQgetResult 将正常返回,除非发生错误;对于在导致错误的查询之后发送的任何后续查询,直到(不包括)下一个同步点,将返回类型为 PGRES_PIPELINE_ABORTED 的特殊结果,并在其之后返回一个空指针。当到达管道同步点时,将返回类型为 PGRES_PIPELINE_SYNC 的结果。同步点后下一个查询的结果紧随其后(即,在同步点之后不会返回空指针)。

注意

即使 PQresultStatus 指示致命错误,也应该调用 PQgetResult 直到它返回一个空指针,以允许 libpq 完全处理错误信息。

使用 PQsendQueryPQgetResult 可以解决 PQexec 的一个问题:如果命令字符串包含多个SQL命令,则可以分别获取这些命令的结果。(顺便说一句,这允许一种简单的重叠处理形式:客户端可以在服务器仍在处理同一命令字符串中后续查询时处理一个命令的结果。)

可以使用 PQsendQueryPQgetResult 获得的另一个经常需要的功能是一次检索有限数量行的大的查询结果。这在 第 32.6 节 中讨论。

本身,调用 PQgetResult 仍会导致客户端阻塞,直到服务器完成下一个SQL命令。这可以通过正确使用另外两个函数来避免

PQconsumeInput #

如果有来自服务器的输入可用,则使用它。

int PQconsumeInput(PGconn *conn);

PQconsumeInput 通常返回 1 表示“没有错误”,但如果遇到某种问题则返回 0(在这种情况下,可以参考 PQerrorMessage)。请注意,结果并不能说明是否实际收集了任何输入数据。调用 PQconsumeInput 后,应用程序可以检查 PQisBusy 和/或 PQnotifies 以查看其状态是否已更改。

PQconsumeInput 即使应用程序尚未准备好处理结果或通知也可以调用。该函数将读取可用数据并将其保存在缓冲区中,从而导致 select() 读取就绪指示消失。因此,应用程序可以使用 PQconsumeInput 立即清除 select() 条件,然后从容检查结果。

PQisBusy #

如果命令正忙,则返回 1,即 PQgetResult 会阻塞等待输入。返回值为 0 表示可以放心地调用 PQgetResult 而不会阻塞。

int PQisBusy(PGconn *conn);

PQisBusy 本身不会尝试从服务器读取数据;因此,必须首先调用 PQconsumeInput,否则繁忙状态将永远不会结束。

使用这些函数的典型应用程序将具有一个主循环,该循环使用 select()poll() 来等待它必须响应的所有条件。其中一个条件将是来自服务器的输入可用,就 select() 而言,这意味着 PQsocket 标识的文件描述符上的可读数据。当主循环检测到输入就绪时,它应该调用 PQconsumeInput 来读取输入。然后它可以调用 PQisBusy,如果 PQisBusy 返回 false (0),则随后调用 PQgetResult。它还可以调用 PQnotifies 来检测 NOTIFY 消息(参见 第 32.9 节)。

使用 PQsendQuery/PQgetResult 的客户端还可以尝试取消服务器仍在处理的命令;参见 第 32.7 节。但是,无论 PQcancelBlocking 的返回值如何,应用程序都必须继续使用 PQgetResult 进行正常的读取结果序列。成功的取消只会导致命令比本来应该结束的更早结束。

通过使用上面描述的函数,可以避免在等待来自数据库服务器的输入时阻塞。但是,应用程序仍然可能阻塞等待向服务器发送输出。这种情况相对不常见,但如果发送非常长的 SQL 命令或数据值,则可能会发生。(但是,如果应用程序通过 COPY IN 发送数据,则可能性更大。)为了防止这种情况并实现完全非阻塞的数据库操作,可以使用以下附加函数。

PQsetnonblocking #

设置连接的非阻塞状态。

int PQsetnonblocking(PGconn *conn, int arg);

如果 arg 为 1,则将连接状态设置为非阻塞,如果 arg 为 0,则设置为阻塞。如果成功,则返回 0,如果出错,则返回 -1。

在非阻塞状态下,对 PQsendQueryPQputlinePQputnbytesPQputCopyDataPQendcopy 的成功调用不会阻塞;它们的更改将存储在本地输出缓冲区中,直到它们被刷新。不成功的调用将返回错误,必须重试。

请注意,PQexec 不支持非阻塞模式;如果调用它,它将始终以阻塞方式运行。

PQisnonblocking #

返回数据库连接的阻塞状态。

int PQisnonblocking(const PGconn *conn);

如果连接设置为非阻塞模式,则返回 1;如果为阻塞模式,则返回 0。

PQflush #

尝试将任何排队的输出数据刷新到服务器。如果成功(或发送队列为空),则返回 0;如果由于某种原因失败,则返回 -1;如果尚无法发送发送队列中的所有数据,则返回 1(此情况仅在连接为非阻塞时才会发生)。

int PQflush(PGconn *conn);

在非阻塞连接上发送任何命令或数据后,请调用 PQflush。如果它返回 1,请等待套接字变为可读或可写。如果它变为可写,请再次调用 PQflush。如果它变为可读,请调用 PQconsumeInput,然后再次调用 PQflush。重复此操作,直到 PQflush 返回 0。(需要检查可读性并使用 PQconsumeInput 耗尽输入,因为服务器可能会阻塞尝试向我们发送数据(例如,NOTICE 消息),并且在读取我们的数据之前不会读取我们的数据。)一旦 PQflush 返回 0,请等待套接字变为可读,然后按照上述说明读取响应。

提交更正

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