diff options
| author | Bruce Momjian <bruce@momjian.us> | 2023-11-13 14:03:37 -0500 |
|---|---|---|
| committer | Bruce Momjian <bruce@momjian.us> | 2023-11-13 14:03:37 -0500 |
| commit | 403f4f4fa1b1fc32b6884890ba7c4242f54ec2a6 (patch) | |
| tree | d9dcba481b405b5494b124ef0095e845d3ffb282 | |
| parent | 4c73ec604844ad2c0b496e401a339b09edd8ef3e (diff) | |
| download | postgresql-403f4f4fa1b1fc32b6884890ba7c4242f54ec2a6.tar.gz postgresql-403f4f4fa1b1fc32b6884890ba7c4242f54ec2a6.zip | |
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.sgml | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 76afcffbdfe..8b51d9ecc14 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -4934,11 +4934,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> |