Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14 / 15 / 16 / 17

32.11. 控制函数 #

这些函数控制 libpq 行为的各种细节。

PQclientEncoding #

返回客户端编码。

int PQclientEncoding(const PGconn *conn);

请注意,它返回编码 ID,而不是符号字符串,如 EUC_JP。如果不成功,则返回 -1。要将编码 ID 转换为编码名称,可以使用

char *pg_encoding_to_char(int encoding_id);
PQsetClientEncoding #

设置客户端编码。

int PQsetClientEncoding(PGconn *conn, const char *encoding);

conn 是与服务器的连接,encoding 是您想要使用的编码。如果该函数成功设置编码,则返回 0,否则返回 -1。可以使用 PQclientEncoding 确定此连接的当前编码。

PQsetErrorVerbosity #

决定由 PQerrorMessagePQresultErrorMessage 返回的消息的详细程度。

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 #

决定由 PQerrorMessagePQresultErrorMessage 返回的消息中的 CONTEXT 字段的处理方式。

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 字段,而不在提示和警告中包含。(但是,如果详细模式设置为 TERSESQLSTATE,则无论上下文显示模式如何,都会省略 CONTEXT 字段。)

更改此模式不会影响现有 PGresult 对象可用的消息,只会影响之后创建的消息。(但如果你想使用不同的显示模式打印之前的错误,请参见 PQresultVerboseErrorMessage。)

PQtrace #

启用将客户端/服务器通信跟踪到调试文件流。

void PQtrace(PGconn *conn, FILE *stream);

每行由以下部分组成:可选时间戳、方向指示器(从客户端到服务器的消息为 F,从服务器到客户端的消息为 B)、消息长度、消息类型和消息内容。非消息内容字段(时间戳、方向、长度和消息类型)使用制表符分隔。消息内容使用空格分隔。协议字符串用双引号引起来,而用作数据值字符串的用单引号引起来。不可打印的字符作为十六进制转义符打印。可以在 第 53.7 节 中找到更多特定消息类型的详细信息。

笔记

在 Windows 上,如果使用不同的标志编译 libpq 库和应用程序,则此函数调用将导致应用程序崩溃,因为 FILE 指针的内部表示形式不同。具体来说,多线程/单线程、发布/调试和静态/动态标志对于库和所有使用该库的应用程序应该相同。

PQsetTraceFlags #

控制客户端/服务器通信的跟踪行为。

void PQsetTraceFlags(PGconn *conn, int flags);

flags 包含描述跟踪操作模式的标志位。如果 flags 包含 PQTRACE_SUPPRESS_TIMESTAMPS,则在打印每条消息时不包括时间戳。如果 flags 包含 PQTRACE_REGRESS_MODE,则在打印每条消息时对一些字段进行编辑,例如对象 OID,以便在测试框架中更方便地使用输出。在调用 PQtrace 之后,必须调用此函数。

PQuntrace #

禁用 PQtrace 启动的追踪。

void PQuntrace(PGconn *conn);