Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 095493a

Browse files
committed
Add missing connection statuses to docs
The list of connection statuses that PQstatus might return during an asynchronous connection attempt was outdated: 1. CONNECTION_SETENV is never returned anymore and is only part of the enum for backwards compatibility, so remove it from the docs. 2. CONNECTION_CHECK_STANDBY and CONNECTION_GSS_STARTUP were not listed, so add them. CONNECTION_NEEDED and CONNECTION_CHECK_TARGET are not listed in the docs on purpose, since these are internal states that can never be observed by a caller of PQstatus. Author: Jelte Fennema-Nio <postgres@jeltef.nl> Discussion: https://postgr.es/m/CAGECzQRb21spiiykQ48rzz8w+Hcykz+mB2_hxR65D9Qk6nnw=w@mail.gmail.com
1 parent 648928c commit 095493a

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

doc/src/sgml/libpq.sgml

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -428,11 +428,11 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn);
428428
</listitem>
429429
</varlistentry>
430430

431-
<varlistentry id="libpq-connection-setenv">
432-
<term><symbol>CONNECTION_SETENV</symbol></term>
431+
<varlistentry id="libpq-connection-gss-startup">
432+
<term><symbol>CONNECTION_GSS_STARTUP</symbol></term>
433433
<listitem>
434434
<para>
435-
Negotiating environment-driven parameter settings.
435+
Negotiating GSS encryption.
436436
</para>
437437
</listitem>
438438
</varlistentry>
@@ -446,6 +446,15 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn);
446446
</listitem>
447447
</varlistentry>
448448

449+
<varlistentry id="libpq-connection-check-standby">
450+
<term><symbol>CONNECTION_CHECK_STANDBY</symbol></term>
451+
<listitem>
452+
<para>
453+
Checking if connection is to a server in standby mode.
454+
</para>
455+
</listitem>
456+
</varlistentry>
457+
449458
<varlistentry id="libpq-connection-consume">
450459
<term><symbol>CONNECTION_CONSUME</symbol></term>
451460
<listitem>

src/interfaces/libpq/libpq-fe.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,12 @@ typedef enum
7373
* backend startup. */
7474
CONNECTION_SETENV, /* This state is no longer used. */
7575
CONNECTION_SSL_STARTUP, /* Negotiating SSL. */
76-
CONNECTION_NEEDED, /* Internal state: connect() needed */
76+
CONNECTION_NEEDED, /* Internal state: connect() needed. */
7777
CONNECTION_CHECK_WRITABLE, /* Checking if session is read-write. */
7878
CONNECTION_CONSUME, /* Consuming any extra messages. */
7979
CONNECTION_GSS_STARTUP, /* Negotiating GSSAPI. */
80-
CONNECTION_CHECK_TARGET, /* Checking target server properties. */
80+
CONNECTION_CHECK_TARGET, /* Internal state: checking target server
81+
* properties. */
8182
CONNECTION_CHECK_STANDBY /* Checking if server is in standby mode. */
8283
} ConnStatusType;
8384

0 commit comments

Comments
 (0)