FIX: auto_explain docs

Started by Tomas Vondraover 12 years ago2 messages
#1Tomas Vondra
tv@fuzzy.cz
1 attachment(s)

Hi,

I've just noticed that this patch in 2012-01 commitfest

https://commitfest.postgresql.org/action/patch_view?id=729

added log_timing option to auto_explain, but it never actually made it
to the docs. Attached is a patch for current master, but 9.2 should be
patched too.

regards
Tomas

Attachments:

auto_explain_doc.patchtext/x-diff; name=auto_explain_doc.patchDownload
diff --git a/doc/src/sgml/auto-explain.sgml b/doc/src/sgml/auto-explain.sgml
index 8325f03..03b2309 100644
--- a/doc/src/sgml/auto-explain.sgml
+++ b/doc/src/sgml/auto-explain.sgml
@@ -141,6 +141,27 @@ LOAD 'auto_explain';
 
    <varlistentry>
     <term>
+     <varname>auto_explain.log_timing</varname> (<type>boolean</type>)
+    </term>
+    <indexterm>
+     <primary><varname>auto_explain.log_timing</> configuration parameter</primary>
+    </indexterm>
+    <listitem>
+     <para>
+      <varname>auto_explain.log_timing</varname> causes <command>EXPLAIN
+      (ANALYZE, TIMING off)</> output, rather than just <command>EXPLAIN (ANALYZE)</>
+      output. The overhead of repeatedly reading the system clock can slow down the
+      query significantly on some systems, so it may be useful to set this
+      parameter to <literal>FALSE</literal> when only actual row counts, and not
+      exact times, are needed.
+      This parameter is only effective when <varname>auto_explain.log_analyze</varname>
+      is also enabled.  It defaults to <literal>TRUE</literal>.
+     </para>
+    </listitem>
+   </varlistentry>
+   
+   <varlistentry>
+    <term>
      <varname>auto_explain.log_nested_statements</varname> (<type>boolean</type>)
     </term>
     <indexterm>
#2Robert Haas
robertmhaas@gmail.com
In reply to: Tomas Vondra (#1)
Re: FIX: auto_explain docs

On Tue, May 28, 2013 at 5:43 PM, Tomas Vondra <tv@fuzzy.cz> wrote:

Hi,

I've just noticed that this patch in 2012-01 commitfest

https://commitfest.postgresql.org/action/patch_view?id=729

added log_timing option to auto_explain, but it never actually made it
to the docs. Attached is a patch for current master, but 9.2 should be
patched too.

Good catch. Committed and back-patched.

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers