9.3 9.4 9.5 9.6 10 11 12 13 14
阿里云PostgreSQL 问题报告 纠错本页面

33.10. 控制函数

这些函数控制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模式包括所有可以可用的域。修改细节模式不会影响来自已有PGresult对象中的可用消息。 只有随后创建的PGresult对象才受到影响。 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对象项中得到的消息,只会影响后续创建的PGresult对象 (如果想要用不同的详细程度打印之前的错误,请见PQresultVerboseErrorMessage)。

PQtrace

启用对客户端/服务器通讯的跟踪,把跟踪信息输出到一个调试文件流中。

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

注意

在 Windows上,如果libpq库和应用使用了不同的标志编译,那么这个函数调用会导致应用崩溃,因为FILE指针的内部表达是不一样的。特别是多线程/单线程、发布/调试 以及静态/动态标志应该是库和所有使用库的应用都一致。

PQuntrace

禁用PQtrace打开的跟踪。

void PQuntrace(PGconn *conn);