diff options
Diffstat (limited to 'doc/src/sgml/ref/explain.sgml')
| -rw-r--r-- | doc/src/sgml/ref/explain.sgml | 314 |
1 files changed, 154 insertions, 160 deletions
diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index a1914c75ce..7f57112570 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -1,186 +1,180 @@ -<REFENTRY ID="SQL-EXPLAIN"> -<REFMETA> -<REFENTRYTITLE> -EXPLAIN -</REFENTRYTITLE> -<REFMISCINFO>SQL - Language Statements</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME> -EXPLAIN -</REFNAME> -<REFPURPOSE> -Shows statement execution details -</REFPURPOSE> -</refnamediv> +<refentry id="SQL-EXPLAIN"> + <refmeta> + <refentrytitle> + EXPLAIN + </refentrytitle> + <refmiscinfo>SQL - Language Statements</refmiscinfo> + </refmeta> + <refnamediv> + <refname> + EXPLAIN + </refname> + <refpurpose> + Shows statement execution details + </refpurpose> + </refnamediv> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1998-09-01</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -EXPLAIN [ VERBOSE ] <REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE> -</SYNOPSIS> + <refsynopsisdiv> + <refsynopsisdivinfo> + <date>1998-09-01</date> + </refsynopsisdivinfo> + <synopsis> +EXPLAIN [ VERBOSE ] <replaceable class="PARAMETER">query</replaceable> + </synopsis> -<REFSECT2 ID="R2-SQL-EXPLAIN-1"> -<REFSECT2INFO> -<DATE>1998-09-01</DATE> -</REFSECT2INFO> -<TITLE> -Inputs -</TITLE> -<PARA> + <refsect2 id="R2-SQL-EXPLAIN-1"> + <refsect2info> + <date>1998-09-01</date> + </refsect2info> + <title> + Inputs + </title> + <para> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -VERBOSE -</TERM> -<LISTITEM> -<PARA> -Flag to show detailed query plan. -</para> -</listitem> -</varlistentry> -<VARLISTENTRY> -<TERM> -<REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Any <REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE>. -</para> -</listitem> -</varlistentry> -</VARIABLELIST> -</para> -</REFSECT2> + <variablelist> + <varlistentry> + <term>VERBOSE</term> + <listitem> + <para> + Flag to show detailed query plan. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable class="PARAMETER">query</replaceable></term> + <listitem> + <para> + Any <replaceable class="PARAMETER">query</replaceable>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect2> -<REFSECT2 ID="R2-SQL-EXPLAIN-2"> -<REFSECT2INFO> -<DATE>1998-04-15</DATE> -</REFSECT2INFO> -<TITLE> -Outputs -</TITLE> -<PARA> + <refsect2 id="R2-SQL-EXPLAIN-2"> + <refsect2info> + <date>1998-04-15</date> + </refsect2info> + <title> + Outputs + </title> + <para> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> + <variablelist> + <varlistentry> + <term><computeroutput> NOTICE: QUERY PLAN: <replaceable>plan</replaceable> -</TERM> -<LISTITEM> -<PARA> -Explicit query plan from the <productname>Postgres</productname> backend. -</para> -</listitem> -</varlistentry> -<VARLISTENTRY> -<TERM> + </computeroutput></term> + <listitem> + <para> + Explicit query plan from the <productname>Postgres</productname> backend. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><computeroutput> EXPLAIN -</TERM> -<LISTITEM> -<PARA> -Flag sent after query plan is shown. -</para> -</listitem> -</varlistentry> -</VARIABLELIST> -</para> -</REFSECT2> -</REFSYNOPSISDIV> + </computeroutput></term> + <listitem> + <para> + Flag sent after query plan is shown. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect2> + </refsynopsisdiv> -<REFSECT1 ID="R1-SQL-EXPLAIN-1"> -<REFSECT1INFO> -<DATE>1998-04-15</DATE> -</REFSECT1INFO> -<TITLE> -Description -</TITLE> -<PARA> + <refsect1 id="R1-SQL-EXPLAIN-1"> + <refsect1info> + <date>1998-04-15</date> + </refsect1info> + <title> + Description + </title> + <para> This command outputs details about the supplied query. The default output is the computed query cost. The cost value is only meaningful to the optimizer in comparing various query plans. VERBOSE displays the full query plan and cost to your screen, and pretty-prints the plan to the postmaster log file. -</para> -<REFSECT2 ID="R2-SQL-EXPLAIN-3"> -<REFSECT2INFO> -<DATE>1998-04-15</DATE> -</REFSECT2INFO> -<TITLE> -Notes -</TITLE> -<PARA> -There is only sparse documentation on the optimizer's use of cost -information in <productname>Postgres</productname>. -General information on cost estimation for query optimization -can be found in database textbooks. -Refer to the <citetitle>Programmer's Guide</citetitle> -in the chapters on indexes and the genetic query optimizer for -more information. -</para> -</REFSECT2> -</refsect1> + </para> + + <refsect2 id="R2-SQL-EXPLAIN-3"> + <refsect2info> + <date>1998-04-15</date> + </refsect2info> + <title> + Notes + </title> + <para> + There is only sparse documentation on the optimizer's use of cost + information in <productname>Postgres</productname>. + General information on cost estimation for query optimization + can be found in database textbooks. + Refer to the <citetitle>Programmer's Guide</citetitle> + in the chapters on indexes and the genetic query optimizer for + more information. + </para> + </refsect2> + </refsect1> -<REFSECT1 ID="R1-SQL-EXPLAIN-2"> -<TITLE> -Usage -</TITLE> -<PARA> -To show a query plan for a simple query: + <refsect1 id="R1-SQL-EXPLAIN-2"> + <title> + Usage + </title> + <para> + To show a query plan for a simple query: -<ProgramListing> -postgres=> explain select * from foo; + <programlisting> +EXPLAIN select * from foo; NOTICE: QUERY PLAN: Seq Scan on foo (cost=0.00 rows=0 width=4) EXPLAIN -</ProgramListing> -</para> -</REFSECT1> + </programlisting> + </para> + </refsect1> -<REFSECT1 ID="R1-SQL-EXPLAIN-3"> -<TITLE> -Compatibility -</TITLE> -<PARA> -</PARA> + <refsect1 id="R1-SQL-EXPLAIN-3"> + <title> + Compatibility + </title> + <para> + </para> -<REFSECT2 ID="R2-SQL-EXPLAIN-4"> -<REFSECT2INFO> -<DATE>1998-09-01</DATE> -</REFSECT2INFO> -<TITLE> -SQL92 -</TITLE> -<PARA> - There is no EXPLAIN statement defined in SQL92. -</para> -</refsect2> -</refsect1> -</REFENTRY> + <refsect2 id="R2-SQL-EXPLAIN-4"> + <refsect2info> + <date>1998-09-01</date> + </refsect2info> + <title> + SQL92 + </title> + <para> + There is no <command>EXPLAIN</command> statement defined in SQL92. + </para> + </refsect2> + </refsect1> +</refentry> -<!-- -<REPLACEABLE CLASS="PARAMETER"> -</REPLACEABLE> -<ReturnValue></ReturnValue> -<PARA> -</PARA> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>• -</TERM> -<LISTITEM> -<PARA> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -<PARA> -</PARA> +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:nil +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../reference.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:"/usr/lib/sgml/catalog" +sgml-local-ecat-files:nil +End: --> |