diff options
| author | Tom Lane <tgl@sss.pgh.pa.us> | 2021-01-22 11:29:43 -0500 |
|---|---|---|
| committer | Tom Lane <tgl@sss.pgh.pa.us> | 2021-01-22 11:29:56 -0500 |
| commit | 878cf600e36796e25a93c75d77c491a048047d27 (patch) | |
| tree | c35141f5af4c7e3baa4a98e8314cd7c1c68d2a2f | |
| parent | 1cce024fd26be40412c41e9ec59f389cf5979da2 (diff) | |
| download | postgresql-878cf600e36796e25a93c75d77c491a048047d27.tar.gz postgresql-878cf600e36796e25a93c75d77c491a048047d27.zip | |
Doc: remove misleading claim in documentation of PQreset().
This text claimed that the reconnection would occur "to the same
server", but there is no such guarantee in the code, nor would
insisting on that be an improvement.
Back-patch to v10 where multi-host connection strings were added.
Discussion: https://postgr.es/m/1095901.1611268376@sss.pgh.pa.us
| -rw-r--r-- | doc/src/sgml/libpq.sgml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index ad8b41720d9..3827e75e3aa 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -645,8 +645,8 @@ void PQreset(PGconn *conn); <para> This function will close the connection - to the server and attempt to reestablish a new - connection to the same server, using all the same + to the server and attempt to establish a new + connection, using all the same parameters previously used. This might be useful for error recovery if a working connection is lost. </para> @@ -669,7 +669,7 @@ PostgresPollingStatusType PQresetPoll(PGconn *conn); <para> These functions will close the connection to the server and attempt to - reestablish a new connection to the same server, using all the same + establish a new connection, using all the same parameters previously used. This can be useful for error recovery if a working connection is lost. They differ from <function>PQreset</function> (above) in that they act in a nonblocking manner. These functions suffer from the same |