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 | 66d9a4a207cf36ab0f53d2bfb6f5131716244134 (patch) | |
| tree | 97c4d369cc24b9e271d94d1c794f99975d59e65d | |
| parent | c859d688b18b44d7d0dfb2b3a67d5644d9d8dbf1 (diff) | |
| download | postgresql-66d9a4a207cf36ab0f53d2bfb6f5131716244134.tar.gz postgresql-66d9a4a207cf36ab0f53d2bfb6f5131716244134.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 72150c57cc0..584a6dadb74 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -4790,11 +4790,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> |