diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/libpq.sgml | 45 | ||||
| -rw-r--r-- | doc/src/sgml/ref/psql-ref.sgml | 8 |
2 files changed, 35 insertions, 18 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 0863a02411d..a97af98979b 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -6014,21 +6014,30 @@ typedef enum { PQERRORS_TERSE, PQERRORS_DEFAULT, - PQERRORS_VERBOSE + PQERRORS_VERBOSE, + PQERRORS_SQLSTATE } PGVerbosity; PGVerbosity PQsetErrorVerbosity(PGconn *conn, PGVerbosity verbosity); </synopsis> - <function>PQsetErrorVerbosity</function> sets the verbosity mode, returning - the connection's previous setting. In <firstterm>TERSE</firstterm> 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 <firstterm>VERBOSE</firstterm> - mode includes all available fields. Changing the verbosity does not - affect the messages available from already-existing - <structname>PGresult</structname> objects, only subsequently-created ones. + <function>PQsetErrorVerbosity</function> sets the verbosity mode, + returning the connection's previous setting. + In <firstterm>TERSE</firstterm> 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 <firstterm>VERBOSE</firstterm> mode includes all available + fields. The <firstterm>SQLSTATE</firstterm> mode includes only the + error severity and the <symbol>SQLSTATE</symbol> error code, if one is + available (if not, the output is like <firstterm>TERSE</firstterm> + mode). + </para> + + <para> + Changing the verbosity setting does not affect the messages available + from already-existing <structname>PGresult</structname> objects, only + subsequently-created ones. (But see <function>PQresultVerboseErrorMessage</function> if you want to print a previous error with a different verbosity.) </para> @@ -6061,13 +6070,19 @@ PGContextVisibility PQsetErrorContextVisibility(PGconn *conn, PGContextVisibilit <function>PQsetErrorContextVisibility</function> sets the context display mode, returning the connection's previous setting. This mode controls - whether the <literal>CONTEXT</literal> field is included in messages - (unless the verbosity setting is <firstterm>TERSE</firstterm>, in which - case <literal>CONTEXT</literal> is never shown). The <firstterm>NEVER</firstterm> mode + whether the <literal>CONTEXT</literal> field is included in messages. + The <firstterm>NEVER</firstterm> mode never includes <literal>CONTEXT</literal>, while <firstterm>ALWAYS</firstterm> always includes it if available. In <firstterm>ERRORS</firstterm> mode (the - default), <literal>CONTEXT</literal> fields are included only for error - messages, not for notices and warnings. Changing this mode does not + default), <literal>CONTEXT</literal> fields are included only in error + messages, not in notices and warnings. + (However, if the verbosity setting is <firstterm>TERSE</firstterm> + or <firstterm>SQLSTATE</firstterm>, <literal>CONTEXT</literal> fields + are omitted regardless of the context display mode.) + </para> + + <para> + Changing this mode does not affect the messages available from already-existing <structname>PGresult</structname> objects, only subsequently-created ones. diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index b29e7547c6a..2bc8bbc2a74 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -3892,7 +3892,8 @@ bar messages from the server. The default is <literal>errors</literal> (meaning that context will be shown in error messages, but not in notice or warning messages). This setting has no effect - when <varname>VERBOSITY</varname> is set to <literal>terse</literal>. + when <varname>VERBOSITY</varname> is set to <literal>terse</literal> + or <literal>sqlstate</literal>. (See also <command>\errverbose</command>, for use when you want a verbose version of the error you just got.) </para> @@ -3946,8 +3947,9 @@ bar <listitem> <para> This variable can be set to the values <literal>default</literal>, - <literal>verbose</literal>, or <literal>terse</literal> to control the verbosity - of error reports. + <literal>verbose</literal>, <literal>terse</literal>, + or <literal>sqlstate</literal> to control the verbosity of error + reports. (See also <command>\errverbose</command>, for use when you want a verbose version of the error you just got.) </para> |