30.2. Функции, описывающие текущее состояние подключения
Эти функции могут использоваться для опроса состояния объекта, описывающего существующее подключение к базе данных.
Подсказка
Разработчики приложений на основе libpq должны тщательно поддерживать абстракцию PGconn. Следует использовать функции доступа, описанные ниже, для получения содержимого PGconn. Обращение напрямую к внутренним полям PGconn, используя сведения из libpq-int.h, не рекомендуется, поскольку они могут измениться в будущем.
Следующие функции возвращают значения параметров, установленные при подключении. Эти значения фиксированы на время жизни объекта PGconn.
-
PQdb Возвращает имя базы данных, с которой установлено соединение.
char *PQdb(const PGconn *conn);
-
PQuser Возвращает имя пользователя, который установил соединение.
char *PQuser(const PGconn *conn);
-
PQpass Возвращает пароль, использованный для подключения.
char *PQpass(const PGconn *conn);
-
PQhost Возвращает имя сервера для текущего соединения. Это может быть имя компьютера, IP-адрес или путь к каталогу, если подключение установлено через Unix-сокет. (Подключение к сокету можно распознать, потому что путь всегда абсолютный и начинается с
/.)char *PQhost(const PGconn *conn);
-
PQport Возвращает номер порта, на котором установлено соединение.
char *PQport(const PGconn *conn);
-
PQtty Возвращает имя отладочного терминала (TTY), связанного с данным соединением. (Это устаревшая функция, поскольку сервер более не обращает внимания на установку TTY, но она остаётся для обеспечения обратной совместимости.)
char *PQtty(const PGconn *conn);
-
PQoptions Возвращает параметры командной строки, переданные в запросе на подключение.
char *PQoptions(const PGconn *conn);
Следующие функции возвращают данные статуса, который может измениться в процессе выполнения операций на объекте PGconn.
-
PQstatus Возвращает состояние подключения.
ConnStatusType PQstatus(const PGconn *conn);
Статус может принимать одно из ряда значений. Однако только два из них видны извне процедуры асинхронного подключения:
CONNECTION_OKиCONNECTION_BAD. Успешное подключение к базе данных имеет статусCONNECTION_OK. О неудачной попытке подключения сигнализирует статусCONNECTION_BAD. Обычно статус OK остаётся таковым до вызоваPQfinish, но сбой в коммуникации может привести к тому, что статус изменится наCONNECTION_BADпреждевременно. В таком случае приложение может попытаться восстановиться, вызвавPQreset.О других кодах состояния, которые могут выдать эти функции, можно узнать в описании
PQconnectStartParams,PQconnectStartиPQconnectPoll.-
PQtransactionStatus Возвращает текущий статус сервера, отражающий процесс выполнения транзакций.
PGTransactionStatusType PQtransactionStatus(const PGconn *conn);
Статус может быть одним из
PQTRANS_IDLE(в настоящее время не занят обработкой транзакции),PQTRANS_ACTIVE(команда в процессе обработки),PQTRANS_INTRANS(не выполняет работу, но находится в рамках действительной транзакции) илиPQTRANS_INERROR(не выполняет работу, но находится в рамках транзакции, завершившейся сбоем). Статус принимает значениеPQTRANS_UNKNOWN, если соединение не работает. Статус принимает значениеPQTRANS_ACTIVEтолько тогда, когда запрос был отправлен серверу, но ещё не завершён.-
PQparameterStatus Отыскивает текущее значение параметра сервера.
const char *PQparameterStatus(const PGconn *conn, const char *paramName);
Значения определённых параметров сервер сообщает автоматически в начале процедуры подключения или тогда, когда их значения изменяются.
PQparameterStatusможно использовать, чтобы запросить эти значения. Функция возвращает текущее значение параметра, если оно известно, илиNULL, если параметр неизвестен.Параметры, значения которых сообщает сервер, в текущей версии включают
server_version,server_encoding,client_encoding,application_name,is_superuser,session_authorization,DateStyle,IntervalStyle,TimeZone,integer_datetimesиstandard_conforming_strings. (Значения параметровserver_encoding,TimeZoneиinteger_datetimesсервер до версии 8.0 не сообщал;standard_conforming_stringsсервер до версии 8.1 не сообщал;IntervalStyleсервер до версии 8.4 не сообщал;application_nameсервер до версии 9.0 не сообщал.) Учтите, чтоserver_version,server_encodingиinteger_datetimesнельзя изменить после запуска.Серверы, поддерживающие протокол только до версии 3.0, не могут сообщать установки параметров, но libpq включает средства, чтобы получить значения для
server_versionиclient_encodingв любом случае. Поощряется использование в приложенияхPQparameterStatus, а не специально написанного (ad hoc) кода, для определения этих значений. (Примите к сведению, однако, что в соединениях, основанных на протоколе версии до 3.0, изменениеclient_encodingпосредством командыSETпосле начала процедуры подключения не будет отражаться функциейPQparameterStatus.) Сведения оserver_versionприведены также в описании функцииPQserverVersion, возвращающей информацию в числовой форме, в которой гораздо легче выполнять сравнение.Если для
standard_conforming_stringsне передано никакого значения, то приложения могут принять его равнымoff. Это означает, что символы обратной косой черты в строковых литералах интерпретируются в качестве спецсимволов. Также, наличие этого параметра может рассматриваться как указание на то, что синтаксис escape-строк (E'...') является приемлемым.Хотя возвращаемый указатель объявлен со спецификатором
const, фактически он указывает на изменяемое хранилище, связанное со структуройPGconn. Не стоит рассчитывать на то, что указатель останется действительным при последующих запросах.-
PQprotocolVersion Запрашивает протокол, используемый между клиентом и сервером.
int PQprotocolVersion(const PGconn *conn);
Приложения могут использовать эту функцию, чтобы определить, поддерживаются ли опредёленные функциональные возможности. В настоящее время возможными значениями являются 2 (протокол версии 2.0), 3 (протокол версии 3.0) или ноль (проблемы в подключении). Версия протокола не будет изменяться после завершения процедуры подключения, но теоретически она могла бы измениться в процессе переподключения. Версия протокола 3.0 обычно используется при взаимодействии с серверами PostgreSQL версии 7.4 или более поздними; серверы до версии 7.4 поддерживают только протокол версии 2.0. (Протокол версии 1.0 является устаревшим и не поддерживается библиотекой libpq.)
-
PQserverVersion Возвращает целое число, представляющее версию сервера.
int PQserverVersion(const PGconn *conn);
Приложения могут использовать эту функцию, чтобы определить версию сервера баз данных, к которому они подключены. Число формируется путём преобразования номеров старшей, младшей и корректирующей версий в двузначные десятичные числа и соединения их вместе. Например, для версии 8.1.5 будет возвращено число 80105, а для версии 8.2 будет возвращено число 80200 (ведущие нули не показаны). Если соединение не работает, то возвращается ноль.
-
PQerrorMessage Возвращает сообщение об ошибке, наиболее недавно сгенерированное операцией, выполненной в рамках текущего подключения.
char *PQerrorMessage(const PGconn *conn);
Почти все функции библиотеки libpq в случае сбоя сформируют сообщение для
PQerrorMessage. Обратите внимание, что по соглашениям, принятым в libpq, непустой результат функцииPQerrorMessageможет состоять из нескольких строк и будет включать завершающий символ новой строки. Вызывающая функция не должна освобождать память, на которую указывает возвращаемое значение, напрямую. Она будет освобождена, когда связанный с ней дескрипторPGconnбудет передан функцииPQfinish. Не стоит ожидать, что результирующая строка останется той же самой при выполнении нескольких операций со структуройPGconn.PQsocketПолучает номер файлового дескриптора для сокета соединения с сервером. Действительный дескриптор будет больше или равен 0; значение -1 показывает, что в данный момент не открыто ни одного соединения с сервером. (Значение не изменится во время обычной работы, но может измениться во время установки или переустановки подключения.)
int PQsocket(const PGconn *conn);
PQbackendPIDВозвращает ID (PID) серверного процесса, обрабатывающего это подключение.
int PQbackendPID(const PGconn *conn);
PID серверного процесса полезен для отладочных целей и для сопоставления с сообщениями команды
NOTIFY(которые включают PID уведомляющего серверного процесса). Примите к сведению, что PID принадлежит процессу, выполняющемуся на компьютере сервера баз данных, а не на локальном компьютере.PQconnectionNeedsPasswordВозвращает true (1), если метод аутентификации соединения требовал пароля, однако он не был предоставлен. Возвращает false (0), если пароль не требовался.
int PQconnectionNeedsPassword(const PGconn *conn);
Эту функцию можно применить после неудачной попытки подключения, чтобы решить, нужно ли предлагать пользователю ввести пароль.
PQconnectionUsedPasswordВозвращает true (1), если метод аутентификации соединения использовал пароль. Возвращает false (0) в противном случае.
int PQconnectionUsedPassword(const PGconn *conn);
Эту функцию можно применить как после неудачной, так и после успешной попытки подключения, чтобы определить, требовал ли сервер предоставления пароля.
Следующие функции возвращают информацию, относящуюся к SSL. Эта информация обычно не меняется после того, как подключение установлено.
PQsslInUseВозвращает true (1), если для текущего подключения используется SSL, и false (0) в противном случае.
int PQsslInUse(const PGconn *conn);
PQsslAttributeВозвращает связанную с SSL информацию о соединении.
const char *PQsslAttribute(const PGconn *conn, const char *attribute_name);
Список доступных атрибутов зависит от применяемой библиотеки SSL и типа подключения. Если атрибут недоступен, возвращается NULL.
Обычно доступны следующие атрибуты:
libraryИмя используемой реализации SSL. (В настоящее время поддерживается только
"OpenSSL")protocolПрименяемая версия SSL/TLS. Наиболее распространены варианты
"SSLv2","SSLv3","TLSv1","TLSv1.1"и"TLSv1.2", но реализация может возвращать и другие строки, если применяется какой-то другой протокол.key_bitsЧисло бит в ключе, используемом алгоритмом шифрования.
cipherКраткое имя применяемого комплекта шифров, например:
"DHE-RSA-DES-CBC3-SHA". Эти имена могут быть разными в разных реализациях SSL.compressionЕсли применяется сжатие SSL, возвращает имя алгоритма сжатия, либо «on», если сжатие используется, но его алгоритм неизвестен. Если сжатие не применяется, возвращает «off».
PQsslAttributeNamesВозвращает массив имён доступных атрибутов SSL. Завершается массив указателем NULL.
const char * const * PQsslAttributeNames(const PGconn *conn);
PQsslStructВозвращает указатель на специфичный для реализации SSL объект, описывающий подключение.
void *PQsslStruct(const PGconn *conn, const char *struct_name);
Доступная структура (или структуры) зависит от того, какая реализация SSL применяется. Для OpenSSL выдаётся одна структура под именем «OpenSSL», и эта структура, на которую указывает возвращённый указатель, имеет тип
SSL(определённый в OpenSSL). Для обращения к этой функции можно воспользоваться кодом в следующих строках:#include <libpq-fe.h> #include <openssl/ssl.h> ... SSL *ssl; dbconn = PQconnectdb(...); ... ssl = PQsslStruct(dbconn, "OpenSSL"); if (ssl) { /* use OpenSSL functions to access ssl */ }Эта структура может использоваться, чтобы сличить уровни шифрования, проверить сертификаты сервера и т. д. За информацией об этой структуре обратитесь к документации по OpenSSL.
PQgetsslВозвращает структуру SSL, использовавшуюся в соединении, или null, если SSL не используется.
void *PQgetssl(const PGconn *conn);
Эта функция равнозначна
PQsslStruct(conn, "OpenSSL"). Её не следует применять в новых приложениях, так как возвращаемая структура специфична для OpenSSL и её нельзя будет получить с другой реализацией SSL. Чтобы проверить, использует ли подключение SSL, лучше вызватьPQsslInUse, а чтобы получить свойства подключения —PQsslAttribute.
30.2. Connection Status Functions
These functions can be used to interrogate the status of an existing database connection object.
Tip
libpq application programmers should be careful to maintain the PGconn abstraction. Use the accessor functions described below to get at the contents of PGconn. Reference to internal PGconn fields using libpq-int.h is not recommended because they are subject to change in the future.
The following functions return parameter values established at connection. These values are fixed for the life of the PGconn object.
-
PQdb Returns the database name of the connection.
char *PQdb(const PGconn *conn);
-
PQuser Returns the user name of the connection.
char *PQuser(const PGconn *conn);
-
PQpass Returns the password of the connection.
char *PQpass(const PGconn *conn);
-
PQhost Returns the server host name of the connection. This can be a host name, an IP address, or a directory path if the connection is via Unix socket. (The path case can be distinguished because it will always be an absolute path, beginning with
/.)char *PQhost(const PGconn *conn);
-
PQport Returns the port of the connection.
char *PQport(const PGconn *conn);
-
PQtty Returns the debug TTY of the connection. (This is obsolete, since the server no longer pays attention to the TTY setting, but the function remains for backward compatibility.)
char *PQtty(const PGconn *conn);
-
PQoptions Returns the command-line options passed in the connection request.
char *PQoptions(const PGconn *conn);
The following functions return status data that can change as operations are executed on the PGconn object.
-
PQstatus Returns the status of the connection.
ConnStatusType PQstatus(const PGconn *conn);
The status can be one of a number of values. However, only two of these are seen outside of an asynchronous connection procedure:
CONNECTION_OKandCONNECTION_BAD. A good connection to the database has the statusCONNECTION_OK. A failed connection attempt is signaled by statusCONNECTION_BAD. Ordinarily, an OK status will remain so untilPQfinish, but a communications failure might result in the status changing toCONNECTION_BADprematurely. In that case the application could try to recover by callingPQreset.See the entry for
PQconnectStartParams,PQconnectStartandPQconnectPollwith regards to other status codes that might be returned.-
PQtransactionStatus Returns the current in-transaction status of the server.
PGTransactionStatusType PQtransactionStatus(const PGconn *conn);
The status can be
PQTRANS_IDLE(currently idle),PQTRANS_ACTIVE(a command is in progress),PQTRANS_INTRANS(idle, in a valid transaction block), orPQTRANS_INERROR(idle, in a failed transaction block).PQTRANS_UNKNOWNis reported if the connection is bad.PQTRANS_ACTIVEis reported only when a query has been sent to the server and not yet completed.-
PQparameterStatus Looks up a current parameter setting of the server.
const char *PQparameterStatus(const PGconn *conn, const char *paramName);
Certain parameter values are reported by the server automatically at connection startup or whenever their values change.
PQparameterStatuscan be used to interrogate these settings. It returns the current value of a parameter if known, orNULLif the parameter is not known.Parameters reported as of the current release include
server_version,server_encoding,client_encoding,application_name,is_superuser,session_authorization,DateStyle,IntervalStyle,TimeZone,integer_datetimes, andstandard_conforming_strings. (server_encoding,TimeZone, andinteger_datetimeswere not reported by releases before 8.0;standard_conforming_stringswas not reported by releases before 8.1;IntervalStylewas not reported by releases before 8.4;application_namewas not reported by releases before 9.0.) Note thatserver_version,server_encodingandinteger_datetimescannot change after startup.Pre-3.0-protocol servers do not report parameter settings, but libpq includes logic to obtain values for
server_versionandclient_encodinganyway. Applications are encouraged to usePQparameterStatusrather than ad hoc code to determine these values. (Beware however that on a pre-3.0 connection, changingclient_encodingviaSETafter connection startup will not be reflected byPQparameterStatus.) Forserver_version, see alsoPQserverVersion, which returns the information in a numeric form that is much easier to compare against.If no value for
standard_conforming_stringsis reported, applications can assume it isoff, that is, backslashes are treated as escapes in string literals. Also, the presence of this parameter can be taken as an indication that the escape string syntax (E'...') is accepted.Although the returned pointer is declared
const, it in fact points to mutable storage associated with thePGconnstructure. It is unwise to assume the pointer will remain valid across queries.-
PQprotocolVersion Interrogates the frontend/backend protocol being used.
int PQprotocolVersion(const PGconn *conn);
Applications might wish to use this function to determine whether certain features are supported. Currently, the possible values are 2 (2.0 protocol), 3 (3.0 protocol), or zero (connection bad). The protocol version will not change after connection startup is complete, but it could theoretically change during a connection reset. The 3.0 protocol will normally be used when communicating with PostgreSQL 7.4 or later servers; pre-7.4 servers support only protocol 2.0. (Protocol 1.0 is obsolete and not supported by libpq.)
-
PQserverVersion Returns an integer representing the backend version.
int PQserverVersion(const PGconn *conn);
Applications might use this function to determine the version of the database server they are connected to. The number is formed by converting the major, minor, and revision numbers into two-decimal-digit numbers and appending them together. For example, version 8.1.5 will be returned as 80105, and version 8.2 will be returned as 80200 (leading zeroes are not shown). Zero is returned if the connection is bad.
-
PQerrorMessage Returns the error message most recently generated by an operation on the connection.
char *PQerrorMessage(const PGconn *conn);
Nearly all libpq functions will set a message for
PQerrorMessageif they fail. Note that by libpq convention, a nonemptyPQerrorMessageresult can consist of multiple lines, and will include a trailing newline. The caller should not free the result directly. It will be freed when the associatedPGconnhandle is passed toPQfinish. The result string should not be expected to remain the same across operations on thePGconnstructure.PQsocketObtains the file descriptor number of the connection socket to the server. A valid descriptor will be greater than or equal to 0; a result of -1 indicates that no server connection is currently open. (This will not change during normal operation, but could change during connection setup or reset.)
int PQsocket(const PGconn *conn);
PQbackendPIDReturns the process ID (PID) of the backend process handling this connection.
int PQbackendPID(const PGconn *conn);
The backend PID is useful for debugging purposes and for comparison to
NOTIFYmessages (which include the PID of the notifying backend process). Note that the PID belongs to a process executing on the database server host, not the local host!PQconnectionNeedsPasswordReturns true (1) if the connection authentication method required a password, but none was available. Returns false (0) if not.
int PQconnectionNeedsPassword(const PGconn *conn);
This function can be applied after a failed connection attempt to decide whether to prompt the user for a password.
PQconnectionUsedPasswordReturns true (1) if the connection authentication method used a password. Returns false (0) if not.
int PQconnectionUsedPassword(const PGconn *conn);
This function can be applied after either a failed or successful connection attempt to detect whether the server demanded a password.
The following functions return information related to SSL. This information usually doesn't change after a connection is established.
PQsslInUseReturns true (1) if the connection uses SSL, false (0) if not.
int PQsslInUse(const PGconn *conn);
PQsslAttributeReturns SSL-related information about the connection.
const char *PQsslAttribute(const PGconn *conn, const char *attribute_name);
The list of available attributes varies depending on the SSL library being used, and the type of connection. If an attribute is not available, returns NULL.
The following attributes are commonly available:
libraryName of the SSL implementation in use. (Currently, only
"OpenSSL"is implemented)protocolSSL/TLS version in use. Common values are
"SSLv2","SSLv3","TLSv1","TLSv1.1"and"TLSv1.2", but an implementation may return other strings if some other protocol is used.key_bitsNumber of key bits used by the encryption algorithm.
cipherA short name of the ciphersuite used, e.g.,
"DHE-RSA-DES-CBC3-SHA". The names are specific to each SSL implementation.compressionIf SSL compression is in use, returns the name of the compression algorithm, or "on" if compression is used but the algorithm is not known. If compression is not in use, returns "off".
PQsslAttributeNamesReturn an array of SSL attribute names available. The array is terminated by a NULL pointer.
const char * const * PQsslAttributeNames(const PGconn *conn);
PQsslStructReturn a pointer to an SSL-implementation-specific object describing the connection.
void *PQsslStruct(const PGconn *conn, const char *struct_name);
The struct(s) available depend on the SSL implementation in use. For OpenSSL, there is one struct, available under the name "OpenSSL", and it returns a pointer to the OpenSSL
SSLstruct. To use this function, code along the following lines could be used:#include <libpq-fe.h> #include <openssl/ssl.h> ... SSL *ssl; dbconn = PQconnectdb(...); ... ssl = PQsslStruct(dbconn, "OpenSSL"); if (ssl) { /* use OpenSSL functions to access ssl */ }This structure can be used to verify encryption levels, check server certificates, and more. Refer to the OpenSSL documentation for information about this structure.
PQgetsslReturns the SSL structure used in the connection, or null if SSL is not in use.
void *PQgetssl(const PGconn *conn);
This function is equivalent to
PQsslStruct(conn, "OpenSSL"). It should not be used in new applications, because the returned struct is specific to OpenSSL and will not be available if another SSL implementation is used. To check if a connection uses SSL, callPQsslInUseinstead, and for more details about the connection, usePQsslAttribute.