32.10. Функции управления
Эти функции управляют различными аспектами поведения libpq.
PQclientEncodingВозвращает кодировку клиента.
int PQclientEncoding(const PGconn *
conn);Заметьте, что она возвращает идентификатор кодировки, а не символьную строку вида
EUC_JP. В случае ошибки она возвращает -1. Преобразовать идентификатор кодировки в имя можно, воспользовавшись следующей функцией:char *pg_encoding_to_char(int
encoding_id);PQsetClientEncodingУстанавливает кодировку клиента.
int PQsetClientEncoding(PGconn *
conn, const char *encoding);В
connпередаётся соединение с сервером, а вencoding— имя требуемой кодировки. Если функция устанавливает кодировку успешно, она возвращает 0, или -1 в противном случае. Определить текущую кодировку для соединения можно, воспользовавшись функциейPQclientEncoding.PQsetErrorVerbosityОпределяет уровень детализации сообщений, возвращаемых функциями
PQerrorMessageиPQresultErrorMessage.typedef enum { PQERRORS_TERSE, PQERRORS_DEFAULT, PQERRORS_VERBOSE, PQERRORS_SQLSTATE } PGVerbosity; PGVerbosity PQsetErrorVerbosity(PGconn *conn, PGVerbosity verbosity);PQsetErrorVerbosityустанавливает режим детализации и возвращает предыдущее значение для соединения. В «лаконичном» режиме (TERSE) возвращаемые сообщения содержат только уровень важности, основной текст и позицию; всё это обычно умещается в одной строке. В режиме по умолчанию (DEFAULT) выдаваемые сообщения дополнительно содержат поля подробного описания, подсказки или контекста (они могут занимать несколько строк). В «многословном» режиме (VERBOSE) передаются все доступные поля сообщения. В режиме SQLSTATE выдаётся только уровень важности и код ошибкиSQLSTATE, если он имеется (если же его нет, выводится та же информация, что и в режиме TERSE).Изменение уровня детализации не влияет на сообщения, уже сформированные в существующих объектах
PGresult, а затрагивает только последующие сообщения. (Но можно воспользоватьсяPQresultVerboseErrorMessage, чтобы получить предыдущую ошибку с другим уровнем детализации.)PQsetErrorContextVisibilityОпределяет вариант обработки полей
CONTEXTв сообщениях, возвращаемых функциямиPQerrorMessageиPQresultErrorMessage.typedef enum { PQSHOW_CONTEXT_NEVER, PQSHOW_CONTEXT_ERRORS, PQSHOW_CONTEXT_ALWAYS } PGContextVisibility; PGContextVisibility PQsetErrorContextVisibility(PGconn *conn, PGContextVisibility show_context);PQsetErrorContextVisibilityустанавливает режим вывода контекста и возвращает предыдущее значение для соединения. Этот режим определяет, будет ли полеCONTEXTвключаться в сообщения. В режиме NEVER полеCONTEXTне включается никогда, а в режиме ALWAYS включается всегда, при наличии. В режиме ERRORS (по умолчанию) полеCONTEXTвключается только в сообщения об ошибках, но не в замечания и предупреждения. (Однако при уровне детализации TERSE или SQLSTATE полеCONTEXTопускается вне зависимости от режима вывода контекста.)Смена этого режима не влияет на сообщения, уже сформированные в существующих объектах
PGresult, а затрагивает только последующие сообщения. (Но можно воспользоватьсяPQresultVerboseErrorMessage>, чтобы получить предыдущую ошибку в другом режиме вывода.)PQtraceВключает трассировку клиент-серверного взаимодействия с выводом в поток отладочных сообщений.
void PQtrace(PGconn *conn, FILE *stream);
Примечание
В Windows, если библиотека libpq и приложение скомпилированы с разными флагами, эта функция может вызвать крах приложения из-за различий внутреннего представления указателей
FILE. В частности, флаги многопоточной/однопоточной, выпускаемой/отладочной или статической/динамической сборки должны быть одинаковыми для библиотеки и всех использующих её приложений.PQuntraceВыключает трассировку, запущенную функцией
PQtrace.void PQuntrace(PGconn *conn);
32.10. Control Functions
These functions control miscellaneous details of libpq's behavior.
PQclientEncodingReturns the client encoding.
int PQclientEncoding(const PGconn *
conn);Note that it returns the encoding ID, not a symbolic string such as
EUC_JP. If unsuccessful, it returns -1. To convert an encoding ID to an encoding name, you can use:char *pg_encoding_to_char(int
encoding_id);PQsetClientEncodingSets the client encoding.
int PQsetClientEncoding(PGconn *
conn, const char *encoding);connis a connection to the server, andencodingis the encoding you want to use. If the function successfully sets the encoding, it returns 0, otherwise -1. The current encoding for this connection can be determined by usingPQclientEncoding.PQsetErrorVerbosityDetermines the verbosity of messages returned by
PQerrorMessageandPQresultErrorMessage.typedef enum { PQERRORS_TERSE, PQERRORS_DEFAULT, PQERRORS_VERBOSE, PQERRORS_SQLSTATE } PGVerbosity; PGVerbosity PQsetErrorVerbosity(PGconn *conn, PGVerbosity verbosity);PQsetErrorVerbositysets the verbosity mode, returning the connection's previous setting. In TERSE mode, returned messages include severity, primary text, and position only; this will normally fit on a single line. The DEFAULT mode produces messages that include the above plus any detail, hint, or context fields (these might span multiple lines). The VERBOSE mode includes all available fields. The SQLSTATE mode includes only the error severity and theSQLSTATEerror code, if one is available (if not, the output is like TERSE mode).Changing the verbosity setting does not affect the messages available from already-existing
PGresultobjects, only subsequently-created ones. (But seePQresultVerboseErrorMessageif you want to print a previous error with a different verbosity.)PQsetErrorContextVisibilityDetermines the handling of
CONTEXTfields in messages returned byPQerrorMessageandPQresultErrorMessage.typedef enum { PQSHOW_CONTEXT_NEVER, PQSHOW_CONTEXT_ERRORS, PQSHOW_CONTEXT_ALWAYS } PGContextVisibility; PGContextVisibility PQsetErrorContextVisibility(PGconn *conn, PGContextVisibility show_context);PQsetErrorContextVisibilitysets the context display mode, returning the connection's previous setting. This mode controls whether theCONTEXTfield is included in messages. The NEVER mode never includesCONTEXT, while ALWAYS always includes it if available. In ERRORS mode (the default),CONTEXTfields are included only in error messages, not in notices and warnings. (However, if the verbosity setting is TERSE or SQLSTATE,CONTEXTfields are omitted regardless of the context display mode.)Changing this mode does not affect the messages available from already-existing
PGresultobjects, only subsequently-created ones. (But seePQresultVerboseErrorMessageif you want to print a previous error with a different display mode.)PQtraceEnables tracing of the client/server communication to a debugging file stream.
void PQtrace(PGconn *conn, FILE *stream);
Note
On Windows, if the libpq library and an application are compiled with different flags, this function call will crash the application because the internal representation of the
FILEpointers differ. Specifically, multithreaded/single-threaded, release/debug, and static/dynamic flags should be the same for the library and all applications using that library.PQuntraceDisables tracing started by
PQtrace.void PQuntrace(PGconn *conn);