diff options
-rw-r--r-- | doc/src/sgml/libpq.sgml | 45 | ||||
-rw-r--r-- | doc/src/sgml/ref/psql-ref.sgml | 8 | ||||
-rw-r--r-- | src/bin/psql/help.c | 4 | ||||
-rw-r--r-- | src/bin/psql/startup.c | 8 | ||||
-rw-r--r-- | src/bin/psql/tab-complete.c | 2 | ||||
-rw-r--r-- | src/interfaces/libpq/fe-protocol3.c | 18 | ||||
-rw-r--r-- | src/interfaces/libpq/libpq-fe.h | 3 | ||||
-rw-r--r-- | src/test/regress/expected/psql.out | 20 | ||||
-rw-r--r-- | src/test/regress/sql/psql.sql | 15 |
9 files changed, 98 insertions, 25 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> diff --git a/src/bin/psql/help.c b/src/bin/psql/help.c index eb3a0f36d94..63b115fe018 100644 --- a/src/bin/psql/help.c +++ b/src/bin/psql/help.c @@ -340,7 +340,7 @@ helpVariables(unsigned short int pager) * Windows builds currently print one more line than non-Windows builds. * Using the larger number is fine. */ - output = PageOutput(156, pager ? &(pset.popt.topt) : NULL); + output = PageOutput(158, pager ? &(pset.popt.topt) : NULL); fprintf(output, _("List of specially treated variables\n\n")); @@ -414,7 +414,7 @@ helpVariables(unsigned short int pager) fprintf(output, _(" USER\n" " the currently connected database user\n")); fprintf(output, _(" VERBOSITY\n" - " controls verbosity of error reports [default, verbose, terse]\n")); + " controls verbosity of error reports [default, verbose, terse, sqlstate]\n")); fprintf(output, _(" VERSION\n" " VERSION_NAME\n" " VERSION_NUM\n" diff --git a/src/bin/psql/startup.c b/src/bin/psql/startup.c index ac82087445e..855133bbcb4 100644 --- a/src/bin/psql/startup.c +++ b/src/bin/psql/startup.c @@ -1110,13 +1110,15 @@ verbosity_hook(const char *newval) Assert(newval != NULL); /* else substitute hook messed up */ if (pg_strcasecmp(newval, "default") == 0) pset.verbosity = PQERRORS_DEFAULT; - else if (pg_strcasecmp(newval, "terse") == 0) - pset.verbosity = PQERRORS_TERSE; else if (pg_strcasecmp(newval, "verbose") == 0) pset.verbosity = PQERRORS_VERBOSE; + else if (pg_strcasecmp(newval, "terse") == 0) + pset.verbosity = PQERRORS_TERSE; + else if (pg_strcasecmp(newval, "sqlstate") == 0) + pset.verbosity = PQERRORS_SQLSTATE; else { - PsqlVarEnumError("VERBOSITY", newval, "default, terse, verbose"); + PsqlVarEnumError("VERBOSITY", newval, "default, verbose, terse, sqlstate"); return false; } diff --git a/src/bin/psql/tab-complete.c b/src/bin/psql/tab-complete.c index 22576adc51e..7c4e5fbacbe 100644 --- a/src/bin/psql/tab-complete.c +++ b/src/bin/psql/tab-complete.c @@ -3652,7 +3652,7 @@ psql_completion(const char *text, int start, int end) else if (TailMatchesCS("SHOW_CONTEXT")) COMPLETE_WITH_CS("never", "errors", "always"); else if (TailMatchesCS("VERBOSITY")) - COMPLETE_WITH_CS("default", "verbose", "terse"); + COMPLETE_WITH_CS("default", "verbose", "terse", "sqlstate"); } else if (TailMatchesCS("\\sf*")) COMPLETE_WITH_SCHEMA_QUERY(Query_for_list_of_routines, NULL); diff --git a/src/interfaces/libpq/fe-protocol3.c b/src/interfaces/libpq/fe-protocol3.c index ec51fee383d..d582cfd4e9c 100644 --- a/src/interfaces/libpq/fe-protocol3.c +++ b/src/interfaces/libpq/fe-protocol3.c @@ -1017,6 +1017,24 @@ pqBuildErrorMessage3(PQExpBuffer msg, const PGresult *res, val = PQresultErrorField(res, PG_DIAG_SEVERITY); if (val) appendPQExpBuffer(msg, "%s: ", val); + + if (verbosity == PQERRORS_SQLSTATE) + { + /* + * If we have a SQLSTATE, print that and nothing else. If not (which + * shouldn't happen for server-generated errors, but might possibly + * happen for libpq-generated ones), fall back to TERSE format, as + * that seems better than printing nothing at all. + */ + val = PQresultErrorField(res, PG_DIAG_SQLSTATE); + if (val) + { + appendPQExpBuffer(msg, "%s\n", val); + return; + } + verbosity = PQERRORS_TERSE; + } + if (verbosity == PQERRORS_VERBOSE) { val = PQresultErrorField(res, PG_DIAG_SQLSTATE); diff --git a/src/interfaces/libpq/libpq-fe.h b/src/interfaces/libpq/libpq-fe.h index 27047ddd1f3..f44030b4b0d 100644 --- a/src/interfaces/libpq/libpq-fe.h +++ b/src/interfaces/libpq/libpq-fe.h @@ -112,7 +112,8 @@ typedef enum { PQERRORS_TERSE, /* single-line error messages */ PQERRORS_DEFAULT, /* recommended style */ - PQERRORS_VERBOSE /* all the facts, ma'am */ + PQERRORS_VERBOSE, /* all the facts, ma'am */ + PQERRORS_SQLSTATE /* only error severity and SQLSTATE code */ } PGVerbosity; typedef enum diff --git a/src/test/regress/expected/psql.out b/src/test/regress/expected/psql.out index aa101de9063..c8b0ae3ede4 100644 --- a/src/test/regress/expected/psql.out +++ b/src/test/regress/expected/psql.out @@ -4491,6 +4491,26 @@ number of rows: 0 last error message: table "this_table_does_not_exist" does not exist \echo 'last error code:' :LAST_ERROR_SQLSTATE last error code: 42P01 +-- nondefault verbosity error settings (except verbose, which is too unstable) +\set VERBOSITY terse +SELECT 1 UNION; +ERROR: syntax error at or near ";" at character 15 +\echo 'error:' :ERROR +error: true +\echo 'error code:' :SQLSTATE +error code: 42601 +\echo 'last error message:' :LAST_ERROR_MESSAGE +last error message: syntax error at or near ";" +\set VERBOSITY sqlstate +SELECT 1/0; +ERROR: 22012 +\echo 'error:' :ERROR +error: true +\echo 'error code:' :SQLSTATE +error code: 22012 +\echo 'last error message:' :LAST_ERROR_MESSAGE +last error message: division by zero +\set VERBOSITY default -- working \gdesc SELECT 3 AS three, 4 AS four \gdesc Column | Type diff --git a/src/test/regress/sql/psql.sql b/src/test/regress/sql/psql.sql index fb7d17fc76e..a8b2cdc7416 100644 --- a/src/test/regress/sql/psql.sql +++ b/src/test/regress/sql/psql.sql @@ -1001,6 +1001,21 @@ DROP TABLE this_table_does_not_exist; \echo 'last error message:' :LAST_ERROR_MESSAGE \echo 'last error code:' :LAST_ERROR_SQLSTATE +-- nondefault verbosity error settings (except verbose, which is too unstable) +\set VERBOSITY terse +SELECT 1 UNION; +\echo 'error:' :ERROR +\echo 'error code:' :SQLSTATE +\echo 'last error message:' :LAST_ERROR_MESSAGE + +\set VERBOSITY sqlstate +SELECT 1/0; +\echo 'error:' :ERROR +\echo 'error code:' :SQLSTATE +\echo 'last error message:' :LAST_ERROR_MESSAGE + +\set VERBOSITY default + -- working \gdesc SELECT 3 AS three, 4 AS four \gdesc \echo 'error:' :ERROR |