mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

This patch makes a few minor improvements to the docs: make the

Browse Source 
<varname> conventions more consistent, and improve the ANALYZE ref page.

Neil Conway
This commit is contained in:
Bruce Momjian 2003-09-11 17:31:45 +00:00
parent 64a7b58aa0
commit 8e27be4310
6 changed files with 57 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/src/sgml/perform.sgml
View File

@ -1,5 +1,5 @@
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/perform.sgml,v 1.31 2003/08/31 17:32:19 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/perform.sgml,v 1.32 2003/09/11 17:31:45 momjian Exp $
--> -->
<chapter id="performance-tips"> <chapter id="performance-tips">
@ -603,7 +603,7 @@ SELECT * FROM a, b, c WHERE a.id = b.id AND b.ref = c.id;
<productname>PostgreSQL</productname> planner will switch from exhaustive <productname>PostgreSQL</productname> planner will switch from exhaustive
search to a <firstterm>genetic</firstterm> probabilistic search search to a <firstterm>genetic</firstterm> probabilistic search
through a limited number of possibilities. (The switch-over threshold is through a limited number of possibilities. (The switch-over threshold is
set by the <varname>geqo_threshold</varname> run-time set by the <varname>GEQO_THRESHOLD</varname> run-time
parameter.) parameter.)
The genetic search takes less time, but it won't The genetic search takes less time, but it won't
necessarily find the best possible plan. necessarily find the best possible plan.

4
doc/src/sgml/plpgsql.sgml
View File

@ -1,5 +1,5 @@
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/plpgsql.sgml,v 1.22 2003/09/03 22:17:07 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/plpgsql.sgml,v 1.23 2003/09/11 17:31:45 momjian Exp $
--> -->
<chapter id="plpgsql"> <chapter id="plpgsql">
@ -1350,7 +1350,7 @@ SELECT * FROM some_func();
allow users to allow users to define set-returning functions allow users to allow users to define set-returning functions
that do not have this limitation. Currently, the point at that do not have this limitation. Currently, the point at
which data begins being written to disk is controlled by the which data begins being written to disk is controlled by the
<varname>sort_mem</> configuration variable. Administrators <varname>SORT_MEM</> configuration variable. Administrators
who have sufficient memory to store larger result sets in who have sufficient memory to store larger result sets in
memory should consider increasing this parameter. memory should consider increasing this parameter.
</para> </para>

83
doc/src/sgml/ref/analyze.sgml
View File

@ -1,5 +1,5 @@
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.14 2003/09/09 18:28:52 tgl Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.15 2003/09/11 17:31:45 momjian Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
@ -28,10 +28,10 @@ ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<rep
<title>Description</title> <title>Description</title>
<para> <para>
<command>ANALYZE</command> collects statistics about the contents of <command>ANALYZE</command> collects statistics about the contents
tables in the database, and stores the results in of tables in the database, and stores the results in the system
the system table <literal>pg_statistic</literal>. Subsequently, table <literal>pg_statistic</literal>. Subsequently, the query
the query planner uses the statistics to help determine the most efficient planner uses these statistics to help determine the most efficient
execution plans for queries. execution plans for queries.
</para> </para>
@ -90,49 +90,56 @@ ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<rep
</para> </para>
<para> <para>
Unlike <command>VACUUM FULL</command>, Unlike <command>VACUUM FULL</command>, <command>ANALYZE</command>
<command>ANALYZE</command> requires requires only a read lock on the target table, so it can run in
only a read lock on the target table, so it can run in parallel with parallel with other activity on the table.
other activity on the table.
</para> </para>
<para> <para>
For large tables, <command>ANALYZE</command> takes a random sample of the The statistics collected by <command>ANALYZE</command> usually
table contents, rather than examining every row. This allows even very include a list of some of the most common values in each column and
large tables to be analyzed in a small amount of time. Note, however, a histogram showing the approximate data distribution in each
that the statistics are only approximate, and will change slightly each column. One or both of these may be omitted if
time <command>ANALYZE</command> is run, even if the actual table contents <command>ANALYZE</command> deems them uninteresting (for example,
did not change. This may result in small changes in the planner's in a unique-key column, there are no common values) or if the
estimated costs shown by <command>EXPLAIN</command>. column data type does not support the appropriate operators. There
is more information about the statistics in <xref
linkend="maintenance">.
</para> </para>
<para> <para>
The collected statistics usually include a list of some of the most common For large tables, <command>ANALYZE</command> takes a random sample
values in each column and a histogram showing the approximate data of the table contents, rather than examining every row. This
distribution in each column. One or both of these may be omitted if allows even very large tables to be analyzed in a small amount of
<command>ANALYZE</command> deems them uninteresting (for example, in time. Note, however, that the statistics are only approximate, and
a unique-key column, there are no common values) or if the column will change slightly each time <command>ANALYZE</command> is run,
data type does not support the appropriate operators. There is more even if the actual table contents did not change. This may result
information about the statistics in <xref linkend="maintenance">. in small changes in the planner's estimated costs shown by
<command>EXPLAIN</command>. In rare situations, this
non-determinism will cause the query optimizer to choose a
different query plan between runs of <command>ANALYZE</command>. To
avoid this, raise the amount of statistics collected by
<command>ANALYZE</command>, as described below.
</para> </para>
<para> <para>
The extent of analysis can be controlled by adjusting the The extent of analysis can be controlled by adjusting the
<literal>default_statistics_target</> parameter variable, or on a <varname>DEFAULT_STATISTICS_TARGET</varname> parameter variable, or
column-by-column basis by setting the per-column on a column-by-column basis by setting the per-column statistics
statistics target with <command>ALTER TABLE ... ALTER COLUMN ... SET target with <command>ALTER TABLE ... ALTER COLUMN ... SET
STATISTICS</command> (see STATISTICS</command> (see <xref linkend="sql-altertable"
<xref linkend="sql-altertable" endterm="sql-altertable-title">). The endterm="sql-altertable-title">). The target value sets the
target value sets the maximum number of entries in the most-common-value maximum number of entries in the most-common-value list and the
list and the maximum number of bins in the histogram. The default maximum number of bins in the histogram. The default target value
target value is 10, but this can be adjusted up or down to trade off is 10, but this can be adjusted up or down to trade off accuracy of
accuracy of planner estimates against the time taken for planner estimates against the time taken for
<command>ANALYZE</command> and the amount of space occupied <command>ANALYZE</command> and the amount of space occupied in
in <literal>pg_statistic</literal>. <literal>pg_statistic</literal>. In particular, setting the
In particular, setting the statistics target to zero disables collection of statistics target to zero disables collection of statistics for
statistics for that column. It may be useful to do that for columns that that column. It may be useful to do that for columns that are
are never used as part of the <literal>WHERE</>, <literal>GROUP BY</>, or <literal>ORDER BY</> clauses of never used as part of the <literal>WHERE</>, <literal>GROUP BY</>,
queries, since the planner will have no use for statistics on such columns. or <literal>ORDER BY</> clauses of queries, since the planner will
have no use for statistics on such columns.
</para> </para>
<para> <para>

4
doc/src/sgml/ref/create_user.sgml
View File

@ -1,5 +1,5 @@
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_user.sgml,v 1.28 2003/09/09 18:28:53 tgl Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_user.sgml,v 1.29 2003/09/11 17:31:45 momjian Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
@ -98,7 +98,7 @@ where <replaceable class="PARAMETER">option</replaceable> can be:
These key words control whether the password is stored These key words control whether the password is stored
encrypted in the system catalogs. (If neither is specified, encrypted in the system catalogs. (If neither is specified,
the default behavior is determined by the configuration the default behavior is determined by the configuration
parameter <varname>password_encryption</varname>.) If the parameter <varname>PASSWORD_ENCRYPTION</varname>.) If the
presented password string is already in MD5-encrypted format, presented password string is already in MD5-encrypted format,
then it is stored encrypted as-is, regardless of whether then it is stored encrypted as-is, regardless of whether
<literal>ENCRYPTED</> or <literal>UNENCRYPTED</> is specified <literal>ENCRYPTED</> or <literal>UNENCRYPTED</> is specified

6
doc/src/sgml/ref/postmaster.sgml
View File

@ -1,5 +1,5 @@
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.37 2003/08/31 17:32:24 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.38 2003/09/11 17:31:45 momjian Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
@ -376,7 +376,7 @@ PostgreSQL documentation
<listitem> <listitem>
<para> <para>
Default value of the <literal>datestyle</literal> run-time Default value of the <varname>DATESTYLE</varname> run-time
parameter. (The use of this environment variable is deprecated.) parameter. (The use of this environment variable is deprecated.)
</para> </para>
</listitem> </listitem>
@ -563,7 +563,7 @@ PostgreSQL documentation
<prompt>$</prompt> <userinput>postmaster -c sort_mem=1234</userinput> <prompt>$</prompt> <userinput>postmaster -c sort_mem=1234</userinput>
<prompt>$</prompt> <userinput>postmaster --sort-mem=1234</userinput> <prompt>$</prompt> <userinput>postmaster --sort-mem=1234</userinput>
</screen> </screen>
Either form overrides whatever setting might exist for <literal>sort_mem</> Either form overrides whatever setting might exist for <varname>SORT_MEM</>
in <filename>postgresql.conf</>. Notice that underscores in parameter in <filename>postgresql.conf</>. Notice that underscores in parameter
names can be written as either underscore or dash on the command line. names can be written as either underscore or dash on the command line.
</para> </para>

6
doc/src/sgml/ref/reset.sgml
View File

@ -1,5 +1,5 @@
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.22 2003/09/09 18:28:53 tgl Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.23 2003/09/11 17:31:45 momjian Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
@ -85,14 +85,14 @@ SET <replaceable class="parameter">parameter</replaceable> TO DEFAULT
<title>Examples</title> <title>Examples</title>
<para> <para>
Set <varname>datestyle</> to its default value: Set <varname>DATESTYLE</> to its default value:
<screen> <screen>
RESET datestyle; RESET datestyle;
</screen> </screen>
</para> </para>
<para> <para>
Set <varname>geqo</> to its default value: Set <varname>GEQO</> to its default value:
<screen> <screen>
RESET geqo; RESET geqo;
</screen> </screen>