aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorRobert Haas <rhaas@postgresql.org>2013-01-23 11:05:15 -0500
committerRobert Haas <rhaas@postgresql.org>2013-01-23 11:05:15 -0500
commit40ed59b2867fff9b1b4470e430c2d66732a05c2c (patch)
tree06e29f3064f3d84e2e543eadcd615bd91a6ed01a /doc/src
parentac2e9673622591319d107272747a02d2c7f343bd (diff)
downloadpostgresql-40ed59b2867fff9b1b4470e430c2d66732a05c2c.tar.gz
postgresql-40ed59b2867fff9b1b4470e430c2d66732a05c2c.zip
Clarify that connection parameters aren't totally meaningless for PQping.
Per discussion with Phil Sorber.
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/libpq.sgml10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index d03ec40e333..e36dd4b1d12 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -648,9 +648,10 @@ PostgresPollingStatusType PQresetPoll(PGconn *conn);
<para>
<function>PQpingParams</function> reports the status of the
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
- 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>
PGPing PQpingParams(const char * const *keywords,
@@ -716,9 +717,10 @@ PGPing PQpingParams(const char * const *keywords,
<para>
<function>PQping</function> reports the status of the
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
- 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>
PGPing PQping(const char *conninfo);