Skip to content

Commit 40ed59b

Browse files
committed
Clarify that connection parameters aren't totally meaningless for PQping.
Per discussion with Phil Sorber.
1 parent ac2e967 commit 40ed59b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/src/sgml/libpq.sgml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -648,9 +648,10 @@ PostgresPollingStatusType PQresetPoll(PGconn *conn);
648648
<para>
649649
<function>PQpingParams</function> reports the status of the
650650
server. It accepts connection parameters identical to those of
651-
<function>PQconnectdbParams</>, described above. It is not, however,
651+
<function>PQconnectdbParams</>, described above. It is not
652652
necessary to supply correct user name, password, or database name
653-
values to obtain the server status.
653+
values to obtain the server status; however, if incorrect values
654+
are provided, the server will log a failed connection attempt.
654655

655656
<synopsis>
656657
PGPing PQpingParams(const char * const *keywords,
@@ -716,9 +717,10 @@ PGPing PQpingParams(const char * const *keywords,
716717
<para>
717718
<function>PQping</function> reports the status of the
718719
server. It accepts connection parameters identical to those of
719-
<function>PQconnectdb</>, described above. It is not, however,
720+
<function>PQconnectdb</>, described above. It is not
720721
necessary to supply correct user name, password, or database name
721-
values to obtain the server status.
722+
values to obtain the server status; however, if incorrect values
723+
are provided, the server will log a failed connection attempt.
722724

723725
<synopsis>
724726
PGPing PQping(const char *conninfo);

0 commit comments

Comments
 (0)