diff options
| author | Alvaro Herrera <alvherre@alvh.no-ip.org> | 2024-03-11 17:20:36 +0100 |
|---|---|---|
| committer | Alvaro Herrera <alvherre@alvh.no-ip.org> | 2024-03-11 17:20:36 +0100 |
| commit | 095493a3771a99d0e4c906ad1cc33791efaa7248 (patch) | |
| tree | de19161509dc75a01902132e82b56cd7b7a2fed9 /doc/src | |
| parent | 648928c79bed975a89fa2e4ef8bc0bade8e0e0d8 (diff) | |
| download | postgresql-095493a3771a99d0e4c906ad1cc33791efaa7248.tar.gz postgresql-095493a3771a99d0e4c906ad1cc33791efaa7248.zip | |
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
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/libpq.sgml | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 1d8998efb2a..a2bbf33d029 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -428,11 +428,11 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); </listitem> </varlistentry> - <varlistentry id="libpq-connection-setenv"> - <term><symbol>CONNECTION_SETENV</symbol></term> + <varlistentry id="libpq-connection-gss-startup"> + <term><symbol>CONNECTION_GSS_STARTUP</symbol></term> <listitem> <para> - Negotiating environment-driven parameter settings. + Negotiating GSS encryption. </para> </listitem> </varlistentry> @@ -446,6 +446,15 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); </listitem> </varlistentry> + <varlistentry id="libpq-connection-check-standby"> + <term><symbol>CONNECTION_CHECK_STANDBY</symbol></term> + <listitem> + <para> + Checking if connection is to a server in standby mode. + </para> + </listitem> + </varlistentry> + <varlistentry id="libpq-connection-consume"> <term><symbol>CONNECTION_CONSUME</symbol></term> <listitem> |