database/postgres
database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-04-24 10:47:04 +03:00
Code

Clarify that connection parameters aren't totally meaningless for PQping.

Browse Source 
Per discussion with Phil Sorber.
This commit is contained in:
Robert Haas 2013-01-23 11:05:15 -05:00
parent ac2e967362
commit 40ed59b286
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -648,9 +648,10 @@ PostgresPollingStatusType PQresetPoll(PGconn *conn);
<para> <para>
<function>PQpingParams</function> reports the status of the <function>PQpingParams</function> reports the status of the
server. It accepts connection parameters identical to those of server. It accepts connection parameters identical to those of
<function>PQconnectdbParams</>, described above. It is not, however, <function>PQconnectdbParams</>, described above. It is not
necessary to supply correct user name, password, or database name necessary to supply correct user name, password, or database name
values to obtain the server status. values to obtain the server status; however, if incorrect values
are provided, the server will log a failed connection attempt.
<synopsis> <synopsis>
PGPing PQpingParams(const char * const *keywords, PGPing PQpingParams(const char * const *keywords,
@ -716,9 +717,10 @@ PGPing PQpingParams(const char * const *keywords,
<para> <para>
<function>PQping</function> reports the status of the <function>PQping</function> reports the status of the
server. It accepts connection parameters identical to those of server. It accepts connection parameters identical to those of
<function>PQconnectdb</>, described above. It is not, however, <function>PQconnectdb</>, described above. It is not
necessary to supply correct user name, password, or database name necessary to supply correct user name, password, or database name
values to obtain the server status. values to obtain the server status; however, if incorrect values
are provided, the server will log a failed connection attempt.
<synopsis> <synopsis>
PGPing PQping(const char *conninfo); PGPing PQping(const char *conninfo);