diff options
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/libpq.sgml | 42 |
1 files changed, 41 insertions, 1 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index be674fbaa92..3ec458ce09d 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -6459,12 +6459,27 @@ PGContextVisibility PQsetErrorContextVisibility(PGconn *conn, PGContextVisibilit <listitem> <para> - Enables tracing of the client/server communication to a debugging file stream. + Enables tracing of the client/server communication to a debugging file + stream. <synopsis> void PQtrace(PGconn *conn, FILE *stream); </synopsis> </para> + <para> + Each line consists of: an optional timestamp, a direction indicator + (<literal>F</literal> for messages from client to server + or <literal>B</literal> for messages from server to client), + message length, message type, and message contents. + Non-message contents fields (timestamp, direction, length and message type) + are separated by a tab. Message contents are separated by a space. + Protocol strings are enclosed in double quotes, while strings used as data + values are enclosed in single quotes. Non-printable chars are printed as + hexadecimal escapes. + Further message-type-specific detail can be found in + <xref linkend="protocol-message-formats"/>. + </para> + <note> <para> On Windows, if the <application>libpq</application> library and an application are @@ -6479,6 +6494,31 @@ void PQtrace(PGconn *conn, FILE *stream); </listitem> </varlistentry> + <varlistentry id="libpq-PQtraceSetFlags"> + <term><function>PQtraceSetFlags</function><indexterm><primary>PQtraceSetFlags</primary></indexterm></term> + + <listitem> + <para> + Controls the tracing behavior of client/server communication. +<synopsis> +void PQtraceSetFlags(PGconn *conn, int flags); +</synopsis> + </para> + + <para> + <literal>flags</literal> contains flag bits describing the operating mode + of tracing. + If <literal>flags</literal> contains <literal>PQTRACE_SUPPRESS_TIMESTAMPS</literal>, + then the timestamp is not included when printing each message. + If <literal>flags</literal> contains <literal>PQTRACE_REGRESS_MODE</literal>, + then some fields are redacted when printing each message, such as object + OIDs, to make the output more convenient to use in testing frameworks. + This function must be called after calling <function>PQtrace</function>. + </para> + + </listitem> + </varlistentry> + <varlistentry id="libpq-PQuntrace"> <term><function>PQuntrace</function><indexterm><primary>PQuntrace</primary></indexterm></term> |