diff options
author | Robert Haas <rhaas@postgresql.org> | 2012-02-07 11:23:04 -0500 |
---|---|---|
committer | Robert Haas <rhaas@postgresql.org> | 2012-02-07 11:23:04 -0500 |
commit | af7914c6627bcf0b0ca614e9ce95d3f8056602bf (patch) | |
tree | 23633b1c4de9e6bbbc9cea30895f8b4ee74e4c01 /doc/src | |
parent | 1631598ea204a3b05104f25d008b510ff5a5c94a (diff) | |
download | postgresql-af7914c6627bcf0b0ca614e9ce95d3f8056602bf.tar.gz postgresql-af7914c6627bcf0b0ca614e9ce95d3f8056602bf.zip |
Add TIMING option to EXPLAIN, to allow eliminating of timing overhead.
Sometimes it may be useful to get actual row counts out of EXPLAIN
(ANALYZE) without paying the cost of timing every node entry/exit.
With this patch, you can say EXPLAIN (ANALYZE, TIMING OFF) to get that.
Tomas Vondra, reviewed by Eric Theise, with minor doc changes by me.
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/ref/explain.sgml | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index 8a9c9defcac..419b72cad34 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -40,6 +40,7 @@ EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="parameter">statement</replac VERBOSE [ <replaceable class="parameter">boolean</replaceable> ] COSTS [ <replaceable class="parameter">boolean</replaceable> ] BUFFERS [ <replaceable class="parameter">boolean</replaceable> ] + TIMING [ <replaceable class="parameter">boolean</replaceable> ] FORMAT { TEXT | XML | JSON | YAML } </synopsis> </refsynopsisdiv> @@ -172,6 +173,21 @@ ROLLBACK; </varlistentry> <varlistentry> + <term><literal>TIMING</literal></term> + <listitem> + <para> + Include the actual startup time and time spent in the node in the 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 may only be used when <literal>ANALYZE</literal> is also + enabled. It defaults to <literal>TRUE</literal>. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><literal>FORMAT</literal></term> <listitem> <para> |