This patch makes a few minor improvements to the docs: make the
<varname> conventions more consistent, and improve the ANALYZE ref page.
-Neil
Index: doc/src/sgml/perform.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/perform.sgml,v
retrieving revision 1.31
diff -c -r1.31 perform.sgml
*** doc/src/sgml/perform.sgml 31 Aug 2003 17:32:19 -0000 1.31
--- doc/src/sgml/perform.sgml 5 Sep 2003 00:15:21 -0000
***************
*** 603,609 ****
<productname>PostgreSQL</productname> planner will switch from exhaustive
search to a <firstterm>genetic</firstterm> probabilistic search
through a limited number of possibilities. (The switch-over threshold is
! set by the <varname>geqo_threshold</varname> run-time
parameter.)
The genetic search takes less time, but it won't
necessarily find the best possible plan.
--- 603,609 ----
<productname>PostgreSQL</productname> planner will switch from exhaustive
search to a <firstterm>genetic</firstterm> probabilistic search
through a limited number of possibilities. (The switch-over threshold is
! set by the <varname>GEQO_THRESHOLD</varname> run-time
parameter.)
The genetic search takes less time, but it won't
necessarily find the best possible plan.
Index: doc/src/sgml/plpgsql.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/plpgsql.sgml,v
retrieving revision 1.22
diff -c -r1.22 plpgsql.sgml
*** doc/src/sgml/plpgsql.sgml 3 Sep 2003 22:17:07 -0000 1.22
--- doc/src/sgml/plpgsql.sgml 5 Sep 2003 00:11:49 -0000
***************
*** 1350,1356 ****
allow users to allow users to define set-returning functions
that do not have this limitation. Currently, the point at
which data begins being written to disk is controlled by the
! <varname>sort_mem</> configuration variable. Administrators
who have sufficient memory to store larger result sets in
memory should consider increasing this parameter.
</para>
--- 1350,1356 ----
allow users to allow users to define set-returning functions
that do not have this limitation. Currently, the point at
which data begins being written to disk is controlled by the
! <varname>SORT_MEM</> configuration variable. Administrators
who have sufficient memory to store larger result sets in
memory should consider increasing this parameter.
</para>
Index: doc/src/sgml/ref/analyze.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/ref/analyze.sgml,v
retrieving revision 1.13
diff -c -r1.13 analyze.sgml
*** doc/src/sgml/ref/analyze.sgml 31 Aug 2003 17:32:21 -0000 1.13
--- doc/src/sgml/ref/analyze.sgml 5 Sep 2003 00:02:12 -0000
***************
*** 28,37 ****
<title>Description</title>
<para>
! <command>ANALYZE</command> collects statistics about the contents of
! tables in the database, and stores the results in
! the system table <literal>pg_statistic</literal>. Subsequently,
! the query planner uses the statistics to help determine the most efficient
execution plans for queries.
</para>
--- 28,37 ----
<title>Description</title>
<para>
! <command>ANALYZE</command> collects statistics about the contents
! of tables in the database, and stores the results in the system
! table <literal>pg_statistic</literal>. Subsequently, the query
! planner uses these statistics to help determine the most efficient
execution plans for queries.
</para>
***************
*** 105,153 ****
</para>
<para>
! Unlike <command>VACUUM FULL</command>,
! <command>ANALYZE</command> requires
! only a read lock on the target table, so it can run in parallel with
! other activity on the table.
</para>
<para>
! For large tables, <command>ANALYZE</command> takes a random sample of the
! table contents, rather than examining every row. This allows even very
! large tables to be analyzed in a small amount of time. Note, however,
! that the statistics are only approximate, and will change slightly each
! time <command>ANALYZE</command> is run, even if the actual table contents
! did not change. This may result in small changes in the planner's
! estimated costs shown by <command>EXPLAIN</command>.
</para>
<para>
! The collected statistics usually include a list of some of the most common
! values in each column and a histogram showing the approximate data
! distribution in each column. One or both of these may be omitted if
! <command>ANALYZE</command> deems them uninteresting (for example, in
! a unique-key column, there are no common values) or if the column
! data type does not support the appropriate operators. There is more
! information about the statistics in <xref linkend="maintenance">.
</para>
<para>
The extent of analysis can be controlled by adjusting the
! <literal>default_statistics_target</> parameter variable, or on a
! column-by-column basis by setting the per-column
! statistics target with <command>ALTER TABLE ... ALTER COLUMN ... SET
! STATISTICS</command> (see
! <xref linkend="sql-altertable" endterm="sql-altertable-title">). The
! target value sets the maximum number of entries in the most-common-value
! list and the maximum number of bins in the histogram. The default
! target value is 10, but this can be adjusted up or down to trade off
! accuracy of planner estimates against the time taken for
! <command>ANALYZE</command> and the amount of space occupied
! in <literal>pg_statistic</literal>.
! In particular, setting the statistics target to zero disables collection of
! statistics for that column. It may be useful to do that for columns that
! are never used as part of the <literal>WHERE</>, <literal>GROUP BY</>, or <literal>ORDER BY</> clauses of
! queries, since the planner will have no use for statistics on such columns.
</para>
<para>
--- 105,160 ----
</para>
<para>
! Unlike <command>VACUUM FULL</command>, <command>ANALYZE</command>
! requires only a read lock on the target table, so it can run in
! parallel with other activity on the table.
</para>
<para>
! The statistics collected by <command>ANALYZE</command> usually
! include a list of some of the most common values in each column and
! a histogram showing the approximate data distribution in each
! column. One or both of these may be omitted if
! <command>ANALYZE</command> deems them uninteresting (for example,
! in a unique-key column, there are no common values) or if the
! column data type does not support the appropriate operators. There
! is more information about the statistics in <xref
! linkend="maintenance">.
</para>
<para>
! For large tables, <command>ANALYZE</command> takes a random sample
! of the table contents, rather than examining every row. This
! allows even very large tables to be analyzed in a small amount of
! time. Note, however, that the statistics are only approximate, and
! will change slightly each time <command>ANALYZE</command> is run,
! even if the actual table contents did not change. This may result
! 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>
The extent of analysis can be controlled by adjusting the
! <varname>DEFAULT_STATISTICS_TARGET</varname> parameter variable, or
! on a column-by-column basis by setting the per-column statistics
! target with <command>ALTER TABLE ... ALTER COLUMN ... SET
! STATISTICS</command> (see <xref linkend="sql-altertable"
! endterm="sql-altertable-title">). The target value sets the
! maximum number of entries in the most-common-value list and the
! maximum number of bins in the histogram. The default target value
! is 10, but this can be adjusted up or down to trade off accuracy of
! planner estimates against the time taken for
! <command>ANALYZE</command> and the amount of space occupied in
! <literal>pg_statistic</literal>. In particular, setting the
! statistics target to zero disables collection of statistics for
! that column. It may be useful to do that for columns that are
! never used as part of the <literal>WHERE</>, <literal>GROUP BY</>,
! or <literal>ORDER BY</> clauses of queries, since the planner will
! have no use for statistics on such columns.
</para>
<para>
Index: doc/src/sgml/ref/create_user.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/ref/create_user.sgml,v
retrieving revision 1.27
diff -c -r1.27 create_user.sgml
*** doc/src/sgml/ref/create_user.sgml 31 Aug 2003 17:32:22 -0000 1.27
--- doc/src/sgml/ref/create_user.sgml 5 Sep 2003 00:08:59 -0000
***************
*** 98,104 ****
These key words control whether the password is stored
encrypted in the system catalogs. (If neither is specified,
the default behavior is determined by the configuration
! parameter <varname>password_encryption</varname>.) If the
presented password string is already in MD5-encrypted format,
then it is stored encrypted as-is, regardless of whether
<literal>ENCRYPTED</> or <literal>UNENCRYPTED</> is specified
--- 98,104 ----
These key words control whether the password is stored
encrypted in the system catalogs. (If neither is specified,
the default behavior is determined by the configuration
! parameter <varname>PASSWORD_ENCRYPTION</varname>.) If the
presented password string is already in MD5-encrypted format,
then it is stored encrypted as-is, regardless of whether
<literal>ENCRYPTED</> or <literal>UNENCRYPTED</> is specified
Index: doc/src/sgml/ref/postmaster.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/ref/postmaster.sgml,v
retrieving revision 1.37
diff -c -r1.37 postmaster.sgml
*** doc/src/sgml/ref/postmaster.sgml 31 Aug 2003 17:32:24 -0000 1.37
--- doc/src/sgml/ref/postmaster.sgml 5 Sep 2003 00:12:50 -0000
***************
*** 376,382 ****
<listitem>
<para>
! Default value of the <literal>datestyle</literal> run-time
parameter. (The use of this environment variable is deprecated.)
</para>
</listitem>
--- 376,382 ----
<listitem>
<para>
! Default value of the <varname>DATESTYLE</varname> run-time
parameter. (The use of this environment variable is deprecated.)
</para>
</listitem>
***************
*** 563,569 ****
<prompt>$</prompt> <userinput>postmaster -c sort_mem=1234</userinput>
<prompt>$</prompt> <userinput>postmaster --sort-mem=1234</userinput>
</screen>
! Either form overrides whatever setting might exist for <literal>sort_mem</>
in <filename>postgresql.conf</>. Notice that underscores in parameter
names can be written as either underscore or dash on the command line.
</para>
--- 563,569 ----
<prompt>$</prompt> <userinput>postmaster -c sort_mem=1234</userinput>
<prompt>$</prompt> <userinput>postmaster --sort-mem=1234</userinput>
</screen>
! Either form overrides whatever setting might exist for <varname>SORT_MEM</>
in <filename>postgresql.conf</>. Notice that underscores in parameter
names can be written as either underscore or dash on the command line.
</para>
Index: doc/src/sgml/ref/reset.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/ref/reset.sgml,v
retrieving revision 1.21
diff -c -r1.21 reset.sgml
*** doc/src/sgml/ref/reset.sgml 31 Aug 2003 17:32:24 -0000 1.21
--- doc/src/sgml/ref/reset.sgml 5 Sep 2003 00:16:07 -0000
***************
*** 93,106 ****
<title>Examples</title>
<para>
! Set <varname>datestyle</> to its default value:
<screen>
RESET datestyle;
</screen>
</para>
<para>
! Set <varname>geqo</> to its default value:
<screen>
RESET geqo;
</screen>
--- 93,106 ----
<title>Examples</title>
<para>
! Set <varname>DATESTYLE</> to its default value:
<screen>
RESET datestyle;
</screen>
</para>
<para>
! Set <varname>GEQO</> to its default value:
<screen>
RESET geqo;
</screen>
---------------------------(end of broadcast)---------------------------
TIP 3: if posting/reading through Usenet, please send an appropriate
subscribe-nomail command to [EMAIL PROTECTED] so that your
message can get through to the mailing list cleanly
