From 7bac3acab4d5c3f2c35aa3a7bea08411d83fd5bc Mon Sep 17 00:00:00 2001 From: Tom Lane Date: Thu, 4 Apr 2019 17:22:02 -0400 Subject: [PATCH] Add a "SQLSTATE-only" error verbosity option to libpq and psql. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit This is intended for use mostly in test scripts for external tools, which could do without cross-PG-version variations in error message wording. Of course, the SQLSTATE isn't guaranteed stable either, but it should be more so than the error message text. Note: there's a bit of an ABI change for libpq here, but it seems OK because if somebody compiles against a newer version of libpq-fe.h, and then tries to pass PQERRORS_SQLSTATE to PQsetErrorVerbosity() of an older libpq library, it will be accepted and then act like PQERRORS_DEFAULT, thanks to the way the tests in pqBuildErrorMessage3 have historically been phrased. That seems acceptable. Didier Gautheron, reviewed by Dagfinn Ilmari Mannsåker Discussion: https://postgr.es/m/CAJRYxuKyj4zA+JGVrtx8OWAuBfE-_wN4sUMK4H49EuPed=mOBw@mail.gmail.com --- doc/src/sgml/libpq.sgml | 45 +++++++++++++++++++---------- doc/src/sgml/ref/psql-ref.sgml | 8 +++-- src/bin/psql/help.c | 4 +-- src/bin/psql/startup.c | 8 +++-- src/bin/psql/tab-complete.c | 2 +- src/interfaces/libpq/fe-protocol3.c | 18 ++++++++++++ src/interfaces/libpq/libpq-fe.h | 3 +- src/test/regress/expected/psql.out | 20 +++++++++++++ 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 0863a02411..a97af98979 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); - PQsetErrorVerbosity sets the verbosity mode, returning - the connection's previous setting. In TERSE 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 VERBOSE - mode includes all available fields. Changing the verbosity does not - affect the messages available from already-existing - PGresult objects, only subsequently-created ones. + PQsetErrorVerbosity sets the verbosity mode, + returning the connection's previous setting. + In TERSE 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 VERBOSE mode includes all available + fields. The SQLSTATE mode includes only the + error severity and the SQLSTATE error code, if one is + available (if not, the output is like TERSE + mode). + + + + Changing the verbosity setting does not affect the messages available + from already-existing PGresult objects, only + subsequently-created ones. (But see PQresultVerboseErrorMessage if you want to print a previous error with a different verbosity.) @@ -6061,13 +6070,19 @@ PGContextVisibility PQsetErrorContextVisibility(PGconn *conn, PGContextVisibilit PQsetErrorContextVisibility sets the context display mode, returning the connection's previous setting. This mode controls - whether the CONTEXT field is included in messages - (unless the verbosity setting is TERSE, in which - case CONTEXT is never shown). The NEVER mode + whether the CONTEXT field is included in messages. + The NEVER mode never includes CONTEXT, while ALWAYS always includes it if available. In ERRORS mode (the - default), CONTEXT fields are included only for error - messages, not for notices and warnings. Changing this mode does not + default), CONTEXT fields are included only in error + messages, not in notices and warnings. + (However, if the verbosity setting is TERSE + or SQLSTATE, CONTEXT fields + are omitted regardless of the context display mode.) + + + + Changing this mode does not affect the messages available from already-existing PGresult objects, only subsequently-created ones. diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index b29e7547c6..2bc8bbc2a7 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 errors (meaning that context will be shown in error messages, but not in notice or warning messages). This setting has no effect - when VERBOSITY is set to terse. + when VERBOSITY is set to terse + or sqlstate. (See also \errverbose, for use when you want a verbose version of the error you just got.) @@ -3946,8 +3947,9 @@ bar This variable can be set to the values default, - verbose, or terse to control the verbosity - of error reports. + verbose, terse, + or sqlstate to control the verbosity of error + reports. (See also \errverbose, for use when you want a verbose version of the error you just got.) diff --git a/src/bin/psql/help.c b/src/bin/psql/help.c index eb3a0f36d9..63b115fe01 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 ac82087445..855133bbcb 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 22576adc51..7c4e5fbacb 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 ec51fee383..d582cfd4e9 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 27047ddd1f..f44030b4b0 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 aa101de906..c8b0ae3ede 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 fb7d17fc76..a8b2cdc741 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 -- 2.40.0