plpgsql: Add new option print_strict_params.
authorRobert Haas
Mon, 7 Oct 2013 19:38:49 +0000 (15:38 -0400)
committerRobert Haas
Mon, 7 Oct 2013 19:38:49 +0000 (15:38 -0400)
This option provides more detailed error messages when STRICT is used
and the number of rows returned is not one.

Marko Tiikkaja, reviewed by Ian Lawrence Barwick

doc/src/sgml/plpgsql.sgml
src/pl/plpgsql/src/pl_comp.c
src/pl/plpgsql/src/pl_exec.c
src/pl/plpgsql/src/pl_gram.y
src/pl/plpgsql/src/pl_handler.c
src/pl/plpgsql/src/pl_scanner.c
src/pl/plpgsql/src/plpgsql.h
src/test/regress/expected/plpgsql.out
src/test/regress/sql/plpgsql.sql

index 0fe6bcf470d86e5f66fcb346e05e914006872b4d..ca2c2b5851b6910a194531308a2909cd61622b0a 100644 (file)
@@ -1076,6 +1076,30 @@ END;
      always sets FOUND to true.
     
 
+    
+     If print_strict_params is enabled for the function,
+     you will get information about the parameters passed to the
+     query in the DETAIL part of the error message produced
+     when the requirements of STRICT are not met.  You can change this
+     setting on a system-wide basis by setting
+     plpgsql.print_strict_params, though only subsequent
+     function compilations will be affected.  You can also enable it
+     on a per-function basis by using a compiler option:
+
+CREATE FUNCTION get_userid(username text) RETURNS int
+AS $$
+#print_strict_params on
+DECLARE
+userid int;
+BEGIN
+    SELECT users.userid INTO STRICT userid
+        FROM users WHERE users.username = get_userid.username;
+    RETURN userid;
+END
+$$ LANGUAGE plpgsql;
+
+    
+
     
      For INSERT/UPDATE/DELETE with
      RETURNING, PL/pgSQL reports
index d2e832fa678acb8349fd68c1d5aee17d40e5cd6e..426aeb53f5888c1c1f7348ca4aaabda1925dc18d 100644 (file)
@@ -351,6 +351,7 @@ do_compile(FunctionCallInfo fcinfo,
    function->fn_cxt = func_cxt;
    function->out_param_varno = -1;     /* set up for no OUT param */
    function->resolve_option = plpgsql_variable_conflict;
+   function->print_strict_params = plpgsql_print_strict_params;
 
    if (is_dml_trigger)
        function->fn_is_trigger = PLPGSQL_DML_TRIGGER;
@@ -847,6 +848,7 @@ plpgsql_compile_inline(char *proc_source)
    function->fn_cxt = func_cxt;
    function->out_param_varno = -1;     /* set up for no OUT param */
    function->resolve_option = plpgsql_variable_conflict;
+   function->print_strict_params = plpgsql_print_strict_params;
 
    plpgsql_ns_init();
    plpgsql_ns_push(func_name);
index 3b2919c5433edc2e2f7706cc0534a92b921591cc..f9d7a049ab72b5f61175a251988c56cc554511de 100644 (file)
@@ -221,6 +221,11 @@ static Portal exec_dynquery_with_params(PLpgSQL_execstate *estate,
                          PLpgSQL_expr *dynquery, List *params,
                          const char *portalname, int cursorOptions);
 
+static char *format_expr_params(PLpgSQL_execstate *estate,
+                               const PLpgSQL_expr *expr);
+static char *format_preparedparamsdata(PLpgSQL_execstate *estate,
+                                      const PreparedParamsData *ppd);
+
 
 /* ----------
  * plpgsql_exec_function   Called by the call handler for
@@ -3391,18 +3396,40 @@ exec_stmt_execsql(PLpgSQL_execstate *estate,
        if (n == 0)
        {
            if (stmt->strict)
+           {
+               char *errdetail;
+
+               if (estate->func->print_strict_params)
+                   errdetail = format_expr_params(estate, expr);
+               else
+                   errdetail = NULL;
+
                ereport(ERROR,
                        (errcode(ERRCODE_NO_DATA_FOUND),
-                        errmsg("query returned no rows")));
+                        errmsg("query returned no rows"),
+                        errdetail ?
+                           errdetail_internal("parameters: %s", errdetail) : 0));
+           }
            /* set the target to NULL(s) */
            exec_move_row(estate, rec, row, NULL, tuptab->tupdesc);
        }
        else
        {
            if (n > 1 && (stmt->strict || stmt->mod_stmt))
+           {
+               char *errdetail;
+
+               if (estate->func->print_strict_params)
+                   errdetail = format_expr_params(estate, expr);
+               else
+                   errdetail = NULL;
+
                ereport(ERROR,
                        (errcode(ERRCODE_TOO_MANY_ROWS),
-                        errmsg("query returned more than one row")));
+                        errmsg("query returned more than one row"),
+                        errdetail ?
+                           errdetail_internal("parameters: %s", errdetail) : 0));
+           }
            /* Put the first result row into the target */
            exec_move_row(estate, rec, row, tuptab->vals[0], tuptab->tupdesc);
        }
@@ -3442,6 +3469,7 @@ exec_stmt_dynexecute(PLpgSQL_execstate *estate,
    Oid         restype;
    char       *querystr;
    int         exec_res;
+   PreparedParamsData *ppd = NULL;
 
    /*
     * First we evaluate the string expression after the EXECUTE keyword. Its
@@ -3466,14 +3494,11 @@ exec_stmt_dynexecute(PLpgSQL_execstate *estate,
     */
    if (stmt->params)
    {
-       PreparedParamsData *ppd;
-
        ppd = exec_eval_using_params(estate, stmt->params);
        exec_res = SPI_execute_with_args(querystr,
                                         ppd->nargs, ppd->types,
                                         ppd->values, ppd->nulls,
                                         estate->readonly_func, 0);
-       free_params_data(ppd);
    }
    else
        exec_res = SPI_execute(querystr, estate->readonly_func, 0);
@@ -3565,18 +3590,41 @@ exec_stmt_dynexecute(PLpgSQL_execstate *estate,
        if (n == 0)
        {
            if (stmt->strict)
+           {
+               char *errdetail;
+
+               if (estate->func->print_strict_params)
+                   errdetail = format_preparedparamsdata(estate, ppd);
+               else
+                   errdetail = NULL;
+
                ereport(ERROR,
                        (errcode(ERRCODE_NO_DATA_FOUND),
-                        errmsg("query returned no rows")));
+                        errmsg("query returned no rows"),
+                        errdetail ?
+                           errdetail_internal("parameters: %s", errdetail) : 0));
+           }
            /* set the target to NULL(s) */
            exec_move_row(estate, rec, row, NULL, tuptab->tupdesc);
        }
        else
        {
            if (n > 1 && stmt->strict)
+           {
+               char *errdetail;
+
+               if (estate->func->print_strict_params)
+                   errdetail = format_preparedparamsdata(estate, ppd);
+               else
+                   errdetail = NULL;
+
                ereport(ERROR,
                        (errcode(ERRCODE_TOO_MANY_ROWS),
-                        errmsg("query returned more than one row")));
+                        errmsg("query returned more than one row"),
+                        errdetail ?
+                           errdetail_internal("parameters: %s", errdetail) : 0));
+           }
+
            /* Put the first result row into the target */
            exec_move_row(estate, rec, row, tuptab->vals[0], tuptab->tupdesc);
        }
@@ -3592,6 +3640,9 @@ exec_stmt_dynexecute(PLpgSQL_execstate *estate,
         */
    }
 
+   if (ppd)
+       free_params_data(ppd);
+
    /* Release any result from SPI_execute, as well as the querystring */
    SPI_freetuptable(SPI_tuptable);
    pfree(querystr);
@@ -6456,3 +6507,103 @@ exec_dynquery_with_params(PLpgSQL_execstate *estate,
 
    return portal;
 }
+
+/*
+ * Return a formatted string with information about an expression's parameters,
+ * or NULL if the expression does not take any parameters.
+ */
+static char *
+format_expr_params(PLpgSQL_execstate *estate,
+                  const PLpgSQL_expr *expr)
+{
+   int paramno;
+   int dno;
+   StringInfoData paramstr;
+   Bitmapset *tmpset;
+
+   if (!expr->paramnos)
+       return NULL;
+
+   initStringInfo(¶mstr);
+   tmpset = bms_copy(expr->paramnos);
+   paramno = 0;
+   while ((dno = bms_first_member(tmpset)) >= 0)
+   {
+       Datum paramdatum;
+       Oid paramtypeid;
+       bool paramisnull;
+       int32 paramtypmod;
+       PLpgSQL_var *curvar;
+
+       curvar = (PLpgSQL_var *) estate->datums[dno];
+
+       exec_eval_datum(estate, (PLpgSQL_datum *) curvar, ¶mtypeid,
+                       ¶mtypmod, ¶mdatum, ¶misnull);
+
+       appendStringInfo(¶mstr, "%s%s = ",
+                        paramno > 0 ? ", " : "",
+                        curvar->refname);
+
+       if (paramisnull)
+           appendStringInfoString(¶mstr, "NULL");
+       else
+       {
+           char *value = convert_value_to_string(estate, paramdatum, paramtypeid);
+           char *p;
+           appendStringInfoCharMacro(¶mstr, '\'');
+           for (p = value; *p; p++)
+           {
+               if (*p == '\'') /* double single quotes */
+                   appendStringInfoCharMacro(¶mstr, *p);
+               appendStringInfoCharMacro(¶mstr, *p);
+           }
+           appendStringInfoCharMacro(¶mstr, '\'');
+       }
+
+       paramno++;
+   }
+   bms_free(tmpset);
+
+   return paramstr.data;
+}
+
+/*
+ * Return a formatted string with information about PreparedParamsData, or NULL
+ * if the there are no parameters.
+ */
+static char *
+format_preparedparamsdata(PLpgSQL_execstate *estate,
+                         const PreparedParamsData *ppd)
+{
+   int paramno;
+   StringInfoData paramstr;
+
+   if (!ppd)
+       return NULL;
+
+   initStringInfo(¶mstr);
+   for (paramno = 0; paramno < ppd->nargs; paramno++)
+   {
+       appendStringInfo(¶mstr, "%s$%d = ",
+                        paramno > 0 ? ", " : "",
+                        paramno + 1);
+
+       if (ppd->nulls[paramno] == 'n')
+           appendStringInfoString(¶mstr, "NULL");
+       else
+       {
+           char *value = convert_value_to_string(estate, ppd->values[paramno], ppd->types[paramno]);
+           char *p;
+           appendStringInfoCharMacro(¶mstr, '\'');
+           for (p = value; *p; p++)
+           {
+               if (*p == '\'') /* double single quotes */
+                   appendStringInfoCharMacro(¶mstr, *p);
+               appendStringInfoCharMacro(¶mstr, *p);
+           }
+           appendStringInfoCharMacro(¶mstr, '\'');
+       }
+   }
+
+   return paramstr.data;
+}
index 325d7566d3c20c0b1694dfde95e762ab493660dc..51b8c5f46a69bfcb990b38e5b56614d38413e7a6 100644 (file)
@@ -185,7 +185,7 @@ static  List            *read_raise_options(void);
 %type     for_variable
 %type    for_control
 
-%type         any_identifier opt_block_label opt_label
+%type         any_identifier opt_block_label opt_label option_value 
 
 %type    proc_sect proc_stmts stmt_elsifs stmt_else
 %type   loop_body
@@ -308,6 +308,7 @@ static  List            *read_raise_options(void);
 %token    K_PG_EXCEPTION_CONTEXT
 %token    K_PG_EXCEPTION_DETAIL
 %token    K_PG_EXCEPTION_HINT
+%token    K_PRINT_STRICT_PARAMS
 %token    K_PRIOR
 %token    K_QUERY
 %token    K_RAISE
@@ -354,6 +355,15 @@ comp_option        : '#' K_OPTION K_DUMP
                    {
                        plpgsql_DumpExecTree = true;
                    }
+               | '#' K_PRINT_STRICT_PARAMS option_value
+                   {
+                       if (strcmp($3, "on") == 0)
+                           plpgsql_curr_compile->print_strict_params = true;
+                       else if (strcmp($3, "off") == 0)
+                           plpgsql_curr_compile->print_strict_params = false;
+                       else
+                           elog(ERROR, "unrecognized print_strict_params option %s", $3);
+                   }
                | '#' K_VARIABLE_CONFLICT K_ERROR
                    {
                        plpgsql_curr_compile->resolve_option = PLPGSQL_RESOLVE_ERROR;
@@ -368,6 +378,15 @@ comp_option        : '#' K_OPTION K_DUMP
                    }
                ;
 
+option_value : T_WORD
+               {
+                   $$ = $1.ident;
+               }
+            | unreserved_keyword
+               {
+                   $$ = pstrdup($1);
+               }
+
 opt_semi       :
                | ';'
                ;
@@ -2300,6 +2319,7 @@ unreserved_keyword    :
                | K_PG_EXCEPTION_DETAIL
                | K_PG_EXCEPTION_HINT
                | K_PRIOR
+               | K_PRINT_STRICT_PARAMS
                | K_QUERY
                | K_RELATIVE
                | K_RESULT_OID
index a9343ade55ba2efbae12a12aaedc482c15962283..912422cd2eb8744cddff731b38f9b8a4011f5c6d 100644 (file)
@@ -37,6 +37,8 @@ static const struct config_enum_entry variable_conflict_options[] = {
 
 int            plpgsql_variable_conflict = PLPGSQL_RESOLVE_ERROR;
 
+bool       plpgsql_print_strict_params = false;
+
 /* Hook for plugins */
 PLpgSQL_plugin **plugin_ptr = NULL;
 
@@ -66,6 +68,14 @@ _PG_init(void)
                             PGC_SUSET, 0,
                             NULL, NULL, NULL);
 
+   DefineCustomBoolVariable("plpgsql.print_strict_params",
+                            gettext_noop("Print information about parameters in the DETAIL part of the error messages generated on INTO .. STRICT failures."),
+                            NULL,
+                            &plpgsql_print_strict_params,
+                            false,
+                            PGC_USERSET, 0,
+                            NULL, NULL, NULL);
+
    EmitWarningsOnPlaceholders("plpgsql");
 
    plpgsql_HashTableInit();
index 35771c2595e0690ca5d1bf328a861ff70eb06dd4..698db59e6f8e52e8e8eea8997ccdad7a9730d673 100644 (file)
@@ -140,6 +140,7 @@ static const ScanKeyword unreserved_keywords[] = {
    PG_KEYWORD("pg_exception_context", K_PG_EXCEPTION_CONTEXT, UNRESERVED_KEYWORD)
    PG_KEYWORD("pg_exception_detail", K_PG_EXCEPTION_DETAIL, UNRESERVED_KEYWORD)
    PG_KEYWORD("pg_exception_hint", K_PG_EXCEPTION_HINT, UNRESERVED_KEYWORD)
+   PG_KEYWORD("print_strict_params", K_PRINT_STRICT_PARAMS, UNRESERVED_KEYWORD)
    PG_KEYWORD("prior", K_PRIOR, UNRESERVED_KEYWORD)
    PG_KEYWORD("query", K_QUERY, UNRESERVED_KEYWORD)
    PG_KEYWORD("relative", K_RELATIVE, UNRESERVED_KEYWORD)
index d49e0b002176d11d4e093b1970e469ea6d823f97..9cb4f533346858609a072a7d2c86a36f065e56fa 100644 (file)
@@ -737,6 +737,8 @@ typedef struct PLpgSQL_function
 
    PLpgSQL_resolve_option resolve_option;
 
+   bool        print_strict_params;
+
    int         ndatums;
    PLpgSQL_datum **datums;
    PLpgSQL_stmt_block *action;
@@ -873,6 +875,8 @@ extern IdentifierLookup plpgsql_IdentifierLookup;
 
 extern int plpgsql_variable_conflict;
 
+extern bool plpgsql_print_strict_params;
+
 extern bool plpgsql_check_syntax;
 extern bool plpgsql_DumpExecTree;
 
index 4d896998396a47250bbfca9ac69f9ae12000ba7a..2890c2d027faf471477d511188bf1aa4525ad70d 100644 (file)
@@ -3104,6 +3104,110 @@ select footest();
 ERROR:  query returned more than one row
 CONTEXT:  PL/pgSQL function footest() line 5 at EXECUTE statement
 drop function footest();
+-- test printing parameters after failure due to STRICT
+set plpgsql.print_strict_params to true;
+create or replace function footest() returns void as $$
+declare
+x record;
+p1 int := 2;
+p3 text := 'foo';
+begin
+  -- no rows
+  select * from foo where f1 = p1 and f1::text = p3 into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+select footest();
+ERROR:  query returned no rows
+DETAIL:  parameters: p1 = '2', p3 = 'foo'
+CONTEXT:  PL/pgSQL function footest() line 8 at SQL statement
+create or replace function footest() returns void as $$
+declare
+x record;
+p1 int := 2;
+p3 text := 'foo';
+begin
+  -- too many rows
+  select * from foo where f1 > p1 or f1::text = p3  into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+select footest();
+ERROR:  query returned more than one row
+DETAIL:  parameters: p1 = '2', p3 = 'foo'
+CONTEXT:  PL/pgSQL function footest() line 8 at SQL statement
+create or replace function footest() returns void as $$
+declare x record;
+begin
+  -- too many rows, no params
+  select * from foo where f1 > 3 into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+select footest();
+ERROR:  query returned more than one row
+CONTEXT:  PL/pgSQL function footest() line 5 at SQL statement
+create or replace function footest() returns void as $$
+declare x record;
+begin
+  -- no rows
+  execute 'select * from foo where f1 = $1 or f1::text = $2' using 0, 'foo' into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+select footest();
+ERROR:  query returned no rows
+DETAIL:  parameters: $1 = '0', $2 = 'foo'
+CONTEXT:  PL/pgSQL function footest() line 5 at EXECUTE statement
+create or replace function footest() returns void as $$
+declare x record;
+begin
+  -- too many rows
+  execute 'select * from foo where f1 > $1' using 1 into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+select footest();
+ERROR:  query returned more than one row
+DETAIL:  parameters: $1 = '1'
+CONTEXT:  PL/pgSQL function footest() line 5 at EXECUTE statement
+create or replace function footest() returns void as $$
+declare x record;
+begin
+  -- too many rows, no parameters
+  execute 'select * from foo where f1 > 3' into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+select footest();
+ERROR:  query returned more than one row
+CONTEXT:  PL/pgSQL function footest() line 5 at EXECUTE statement
+create or replace function footest() returns void as $$
+-- override the global
+#print_strict_params off
+declare
+x record;
+p1 int := 2;
+p3 text := 'foo';
+begin
+  -- too many rows
+  select * from foo where f1 > p1 or f1::text = p3  into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+select footest();
+ERROR:  query returned more than one row
+CONTEXT:  PL/pgSQL function footest() line 10 at SQL statement
+reset plpgsql.print_strict_params;
+create or replace function footest() returns void as $$
+-- override the global
+#print_strict_params on
+declare
+x record;
+p1 int := 2;
+p3 text := 'foo';
+begin
+  -- too many rows
+  select * from foo where f1 > p1 or f1::text = p3  into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+select footest();
+ERROR:  query returned more than one row
+DETAIL:  parameters: p1 = '2', p3 = 'foo'
+CONTEXT:  PL/pgSQL function footest() line 10 at SQL statement
 -- test scrollable cursor support
 create function sc_test() returns setof integer as $$
 declare
index e1f4b2c5c7188ea5ac866b361a19ae3f82d685cc..068b072c901d29dd6d730f8088aa9200c057b1f6 100644 (file)
@@ -2587,6 +2587,108 @@ select footest();
 
 drop function footest();
 
+-- test printing parameters after failure due to STRICT
+
+set plpgsql.print_strict_params to true;
+
+create or replace function footest() returns void as $$
+declare
+x record;
+p1 int := 2;
+p3 text := 'foo';
+begin
+  -- no rows
+  select * from foo where f1 = p1 and f1::text = p3 into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+
+select footest();
+
+create or replace function footest() returns void as $$
+declare
+x record;
+p1 int := 2;
+p3 text := 'foo';
+begin
+  -- too many rows
+  select * from foo where f1 > p1 or f1::text = p3  into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+
+select footest();
+
+create or replace function footest() returns void as $$
+declare x record;
+begin
+  -- too many rows, no params
+  select * from foo where f1 > 3 into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+
+select footest();
+
+create or replace function footest() returns void as $$
+declare x record;
+begin
+  -- no rows
+  execute 'select * from foo where f1 = $1 or f1::text = $2' using 0, 'foo' into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+
+select footest();
+
+create or replace function footest() returns void as $$
+declare x record;
+begin
+  -- too many rows
+  execute 'select * from foo where f1 > $1' using 1 into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+
+select footest();
+
+create or replace function footest() returns void as $$
+declare x record;
+begin
+  -- too many rows, no parameters
+  execute 'select * from foo where f1 > 3' into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+
+select footest();
+
+create or replace function footest() returns void as $$
+-- override the global
+#print_strict_params off
+declare
+x record;
+p1 int := 2;
+p3 text := 'foo';
+begin
+  -- too many rows
+  select * from foo where f1 > p1 or f1::text = p3  into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+
+select footest();
+
+reset plpgsql.print_strict_params;
+
+create or replace function footest() returns void as $$
+-- override the global
+#print_strict_params on
+declare
+x record;
+p1 int := 2;
+p3 text := 'foo';
+begin
+  -- too many rows
+  select * from foo where f1 > p1 or f1::text = p3  into strict x;
+  raise notice 'x.f1 = %, x.f2 = %', x.f1, x.f2;
+end$$ language plpgsql;
+
+select footest();
+
 -- test scrollable cursor support
 
 create function sc_test() returns setof integer as $$