summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruce Momjian <bruce@momjian.us>2023-11-13 14:03:37 -0500
committerBruce Momjian <bruce@momjian.us>2023-11-13 14:03:37 -0500
commit4b48770aeb6dd83df09e1a73dc111850ba19762c (patch)
tree5df165c5d60639a1698692f9afb1ebbe771c56d2
parentf76b975d5887e7e668862e7068eb09073ec23c63 (diff)
doc: correct description of libpq's PQsetnonblocking() mode
Reported-by: Yugo NAGATA Discussion: https://postgr.es/m/20210713115949.702986955f8ccf23fa81073c@sraoss.co.jp Backpatch-through: 12-16, master already done
-rw-r--r--doc/src/sgml/libpq.sgml7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 2225e4e0ef3..f18018693e4 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -5213,11 +5213,12 @@ int PQsetnonblocking(PGconn *conn, int arg);
</para>
<para>
- In the nonblocking state, calls to
+ In the nonblocking state, successful calls to
<xref linkend="libpq-PQsendQuery"/>, <xref linkend="libpq-PQputline"/>,
<xref linkend="libpq-PQputnbytes"/>, <xref linkend="libpq-PQputCopyData"/>,
- and <xref linkend="libpq-PQendcopy"/> will not block but instead return
- an error if they need to be called again.
+ and <xref linkend="libpq-PQendcopy"/> will not block; their changes
+ are stored in the local output buffer until they are flushed.
+ Unsuccessful calls will return an error and must be retried.
</para>
<para>