database/postgres
database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-05-05 09:19:17 +03:00
Code

Doc: remove misleading claim in documentation of PQreset().

Browse Source 
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
This commit is contained in:
Tom Lane 2021-01-22 11:29:43 -05:00
parent 0a9ae44288
commit ab66645628
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/src/sgml/libpq.sgml
View File

@ -645,8 +645,8 @@ void PQreset(PGconn *conn);
<para> <para>
This function will close the connection This function will close the connection
to the server and attempt to reestablish a new to the server and attempt to establish a new
connection to the same server, using all the same connection, using all the same
parameters previously used. This might be useful for parameters previously used. This might be useful for
error recovery if a working connection is lost. error recovery if a working connection is lost.
</para> </para>
@ -669,7 +669,7 @@ PostgresPollingStatusType PQresetPoll(PGconn *conn);
<para> <para>
These functions will close the connection to the server and attempt to 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 parameters previously used. This can be useful for error recovery if a
working connection is lost. They differ from <xref linkend="libpq-PQreset"/> (above) in that they working connection is lost. They differ from <xref linkend="libpq-PQreset"/> (above) in that they
act in a nonblocking manner. These functions suffer from the same act in a nonblocking manner. These functions suffer from the same