Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.89) (envelope-from ) id 1hNusG-0003Gd-H6 for pgsql-hackers@arkaria.postgresql.org; Tue, 07 May 2019 07:50:52 +0000 Received: from localhost ([127.0.0.1] helo=malur.postgresql.org) by malur.postgresql.org with esmtp (Exim 4.89) (envelope-from ) id 1hNusF-00010F-6I for pgsql-hackers@arkaria.postgresql.org; Tue, 07 May 2019 07:50:51 +0000 Received: from magus.postgresql.org ([2a02:c0:301:0:ffff::29]) by malur.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.89) (envelope-from ) id 1hNusE-000101-Tm for pgsql-hackers@lists.postgresql.org; Tue, 07 May 2019 07:50:50 +0000 Received: from xvm-110-146.dc2.ghst.net ([46.226.110.146] helo=fetter.org) by magus.postgresql.org with esmtp (Exim 4.89) (envelope-from ) id 1hNusC-0006gU-C2 for pgsql-hackers@postgresql.org; Tue, 07 May 2019 07:50:50 +0000 Received: by fetter.org (Postfix, from userid 1001) id 1045842BC4; Tue, 7 May 2019 09:50:48 +0200 (CEST) Date: Tue, 7 May 2019 09:50:47 +0200 From: David Fetter To: PostgreSQL Development Subject: Re: New EXPLAIN option: ALL Message-ID: <20190507075047.GJ28936@fetter.org> References: <20190507073046.GI28936@fetter.org> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="GIP5y49pbaVPin6k" Content-Disposition: inline In-Reply-To: <20190507073046.GI28936@fetter.org> User-Agent: Mutt/1.9.4 (2018-02-28) List-Id: List-Help: List-Subscribe: List-Post: List-Owner: List-Archive: Precedence: bulk --GIP5y49pbaVPin6k Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Tue, May 07, 2019 at 09:30:47AM +0200, David Fetter wrote: > Folks, > > It can get a little tedious turning on (or off) all the boolean > options to EXPLAIN, so please find attached a shortcut. > > Best, > David. It helps to have a working patch for this. Best, David. -- David Fetter http://fetter.org/ Phone: +1 415 235 3778 Remember to vote! Consider donating to Postgres: http://www.postgresql.org/about/donate --GIP5y49pbaVPin6k Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="v2-0001-Add-an-ALL-option-to-EXPLAIN.patch" From d62669c5b1d22c18949ad5d6ae3f6b23b49819e3 Mon Sep 17 00:00:00 2001 From: David Fetter Date: Tue, 7 May 2019 00:26:29 -0700 Subject: [PATCH v2] Add an ALL option to EXPLAIN To: hackers MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="------------2.21.0" This is a multi-part message in MIME format. --------------2.21.0 Content-Type: text/plain; charset=UTF-8; format=fixed Content-Transfer-Encoding: 8bit which starts all boolean options at once. diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index 385d10411f..ade3793c5f 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -43,6 +43,7 @@ EXPLAIN [ ANALYZE ] [ VERBOSE ] statementboolean ] TIMING [ boolean ] SUMMARY [ boolean ] + ALL [ boolean ] FORMAT { TEXT | XML | JSON | YAML } @@ -224,6 +225,16 @@ ROLLBACK; + + ALL + + + Include (or exclude) all of the above settings before examining the rest + of the options. It defaults to FALSE. + + + + FORMAT diff --git a/src/backend/commands/explain.c b/src/backend/commands/explain.c index a6c6de78f1..7ad73e4482 100644 --- a/src/backend/commands/explain.c +++ b/src/backend/commands/explain.c @@ -151,6 +151,26 @@ ExplainQuery(ParseState *pstate, ExplainStmt *stmt, const char *queryString, bool summary_set = false; /* Parse options list. */ + /* First, see whether ALL is set */ + foreach(lc, stmt->options) + { + DefElem *opt = (DefElem *) lfirst(lc); + + if (strcmp(opt->defname, "all") == 0) + { + es->analyze = defGetBoolean(opt); + es->verbose = defGetBoolean(opt); + es->costs = defGetBoolean(opt); + es->buffers = defGetBoolean(opt); + es->settings = defGetBoolean(opt); + timing_set = true; + es->timing = defGetBoolean(opt); + summary_set = true; + es->timing = defGetBoolean(opt); + } + } + + /* If you add another boolean option here, remember to add it above, too */ foreach(lc, stmt->options) { DefElem *opt = (DefElem *) lfirst(lc); @@ -194,6 +214,8 @@ ExplainQuery(ParseState *pstate, ExplainStmt *stmt, const char *queryString, opt->defname, p), parser_errposition(pstate, opt->location))); } + else if (strcmp(opt->defname, "all") == 0) + ; /* Do nothing */ else ereport(ERROR, (errcode(ERRCODE_SYNTAX_ERROR), diff --git a/src/backend/parser/gram.y b/src/backend/parser/gram.y index 3dc0e8a4fb..4a69f9711c 100644 --- a/src/backend/parser/gram.y +++ b/src/backend/parser/gram.y @@ -10704,6 +10704,7 @@ explain_option_elem: explain_option_name: NonReservedWord { $$ = $1; } | analyze_keyword { $$ = "analyze"; } + | ALL { $$ = "all"; } ; explain_option_arg: diff --git a/src/bin/psql/tab-complete.c b/src/bin/psql/tab-complete.c index bcddc7601e..8177f9c6da 100644 --- a/src/bin/psql/tab-complete.c +++ b/src/bin/psql/tab-complete.c @@ -2862,9 +2862,9 @@ psql_completion(const char *text, int start, int end) * one word, so the above test is correct. */ if (ends_with(prev_wd, '(') || ends_with(prev_wd, ',')) - COMPLETE_WITH("ANALYZE", "VERBOSE", "COSTS", "BUFFERS", + COMPLETE_WITH("ALL", "ANALYZE", "VERBOSE", "COSTS", "BUFFERS", "TIMING", "SUMMARY", "FORMAT"); - else if (TailMatches("ANALYZE|VERBOSE|COSTS|BUFFERS|TIMING|SUMMARY")) + else if (TailMatches("ALL|ANALYZE|VERBOSE|COSTS|BUFFERS|TIMING|SUMMARY")) COMPLETE_WITH("ON", "OFF"); else if (TailMatches("FORMAT")) COMPLETE_WITH("TEXT", "XML", "JSON", "YAML"); @@ -2874,7 +2874,8 @@ psql_completion(const char *text, int start, int end) "VERBOSE"); else if (Matches("EXPLAIN", "(*)") || Matches("EXPLAIN", "VERBOSE") || - Matches("EXPLAIN", "ANALYZE", "VERBOSE")) + Matches("EXPLAIN", "ANALYZE", "VERBOSE") || + Matches("EXPLAIN", "ALL")) COMPLETE_WITH("SELECT", "INSERT", "DELETE", "UPDATE", "DECLARE"); /* FETCH && MOVE */ --------------2.21.0-- --GIP5y49pbaVPin6k--