1- <!-- $PostgreSQL: pgsql/doc/src/sgml/auto-explain.sgml,v 1.2 2008/12/07 23:46:39 alvherre Exp $ -->
1+ <!-- $PostgreSQL: pgsql/doc/src/sgml/auto-explain.sgml,v 1.3 2009/01/02 01:16:02 tgl Exp $ -->
22
33<sect1 id="auto-explain">
44 <title>auto_explain</title>
@@ -38,20 +38,20 @@ LOAD 'auto_explain';
3838 There are several configuration parameters that control the behavior of
3939 <filename>auto_explain</filename>. Note that the default behavior is
4040 to do nothing, so you must set at least
41- <varname>explain .log_min_duration</varname> if you want any results.
41+ <varname>auto_explain .log_min_duration</varname> if you want any results.
4242 </para>
4343
4444 <variablelist>
4545 <varlistentry>
4646 <term>
47- <varname>explain .log_min_duration</varname> (<type>integer</type>)
47+ <varname>auto_explain .log_min_duration</varname> (<type>integer</type>)
4848 </term>
4949 <indexterm>
50- <primary><varname>explain .log_min_duration</> configuration parameter</primary>
50+ <primary><varname>auto_explain .log_min_duration</> configuration parameter</primary>
5151 </indexterm>
5252 <listitem>
5353 <para>
54- <varname>explain .log_min_duration</varname> is the minimum statement
54+ <varname>auto_explain .log_min_duration</varname> is the minimum statement
5555 execution time, in milliseconds, that will cause the statement's plan to
5656 be logged. Setting this to zero logs all plans. Minus-one (the default)
5757 disables logging of plans. For example, if you set it to
@@ -63,14 +63,14 @@ LOAD 'auto_explain';
6363
6464 <varlistentry>
6565 <term>
66- <varname>explain .log_analyze</varname> (<type>boolean</type>)
66+ <varname>auto_explain .log_analyze</varname> (<type>boolean</type>)
6767 </term>
6868 <indexterm>
69- <primary><varname>explain .log_analyze</> configuration parameter</primary>
69+ <primary><varname>auto_explain .log_analyze</> configuration parameter</primary>
7070 </indexterm>
7171 <listitem>
7272 <para>
73- <varname>explain .log_analyze</varname> causes <command>EXPLAIN ANALYZE</>
73+ <varname>auto_explain .log_analyze</varname> causes <command>EXPLAIN ANALYZE</>
7474 output, rather than just <command>EXPLAIN</> output, to be printed
7575 when an execution plan is logged. This parameter is off by default.
7676 Only superusers can change this setting.
@@ -87,14 +87,14 @@ LOAD 'auto_explain';
8787
8888 <varlistentry>
8989 <term>
90- <varname>explain .log_verbose</varname> (<type>boolean</type>)
90+ <varname>auto_explain .log_verbose</varname> (<type>boolean</type>)
9191 </term>
9292 <indexterm>
93- <primary><varname>explain .log_verbose</> configuration parameter</primary>
93+ <primary><varname>auto_explain .log_verbose</> configuration parameter</primary>
9494 </indexterm>
9595 <listitem>
9696 <para>
97- <varname>explain .log_verbose</varname> causes <command>EXPLAIN VERBOSE</>
97+ <varname>auto_explain .log_verbose</varname> causes <command>EXPLAIN VERBOSE</>
9898 output, rather than just <command>EXPLAIN</> output, to be printed
9999 when an execution plan is logged. This parameter is off by default.
100100 Only superusers can change this setting.
@@ -104,14 +104,14 @@ LOAD 'auto_explain';
104104
105105 <varlistentry>
106106 <term>
107- <varname>explain .log_nested_statements</varname> (<type>boolean</type>)
107+ <varname>auto_explain .log_nested_statements</varname> (<type>boolean</type>)
108108 </term>
109109 <indexterm>
110- <primary><varname>explain .log_nested_statements</> configuration parameter</primary>
110+ <primary><varname>auto_explain .log_nested_statements</> configuration parameter</primary>
111111 </indexterm>
112112 <listitem>
113113 <para>
114- <varname>explain .log_nested_statements</varname> causes nested
114+ <varname>auto_explain .log_nested_statements</varname> causes nested
115115 statements (statements executed inside a function) to be considered
116116 for logging. When it is off, only top-level query plans are logged. This
117117 parameter is off by default. Only superusers can change this setting.
@@ -122,16 +122,16 @@ LOAD 'auto_explain';
122122
123123 <para>
124124 In order to set these parameters in your <filename>postgresql.conf</> file,
125- you will need to add <literal>explain </>in
126- <varname>custom_variable_classes</ >. Typical usage might be:
125+ you will need to add <literal>auto_explain </>to
126+ <xref linkend="guc-custom-variable-classes" >. Typical usage might be:
127127 </para>
128128
129129 <programlisting>
130130# postgresql.conf
131131shared_preload_libraries = 'auto_explain'
132132
133- custom_variable_classes = 'explain '
134- explain .log_min_duration = '3s'
133+ custom_variable_classes = 'auto_explain '
134+ auto_explain .log_min_duration = '3s'
135135 </programlisting>
136136 </sect2>
137137
@@ -140,7 +140,7 @@ explain.log_min_duration = '3s'
140140
141141 <programlisting>
142142 postgres=# LOAD 'auto_explain';
143- postgres=# SETexplain .log_min_duration = 0;
143+ postgres=# SETauto_explain .log_min_duration = 0;
144144 postgres=# SELECT count(*)
145145 FROM pg_class, pg_index
146146 WHERE oid = indrelid AND indisunique;