This patch makes a few minor improvements to the docs: make the
authorBruce Momjian
Thu, 11 Sep 2003 17:31:45 +0000 (17:31 +0000)
committerBruce Momjian
Thu, 11 Sep 2003 17:31:45 +0000 (17:31 +0000)
 conventions more consistent, and improve the ANALYZE ref page.

Neil Conway

doc/src/sgml/perform.sgml
doc/src/sgml/plpgsql.sgml
doc/src/sgml/ref/analyze.sgml
doc/src/sgml/ref/create_user.sgml
doc/src/sgml/ref/postmaster.sgml
doc/src/sgml/ref/reset.sgml

index 1b8e442b0b0e76f2f93bd5507df0c6c95e77e373..a31d3aa5caa4c765b27e25ac324e85a40299e299 100644 (file)
@@ -1,5 +1,5 @@
 
 
  
@@ -603,7 +603,7 @@ SELECT * FROM a, b, c WHERE a.id = b.id AND b.ref = c.id;
    PostgreSQL planner will switch from exhaustive
    search to a genetic probabilistic search
    through a limited number of possibilities.  (The switch-over threshold is
-   set by the geqo_threshold run-time
+   set by the GEQO_THRESHOLD run-time
    parameter.)
    The genetic search takes less time, but it won't
    necessarily find the best possible plan.
index e9573736ab794c5a974001775495f689735cc5e3..945d1d86dc86cfd72103f61dfc49752dcd1b3b0f 100644 (file)
@@ -1,5 +1,5 @@
 
 
  
@@ -1350,7 +1350,7 @@ SELECT * FROM some_func();
        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
-       sort_mem configuration variable.  Administrators
+       SORT_MEM configuration variable.  Administrators
        who have sufficient memory to store larger result sets in
        memory should consider increasing this parameter.
       
index f0be5af1dbdab40aceba6dc10ac964b15e2803f7..cf472d4a0ef089860753894f71764c602ac60135 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -28,10 +28,10 @@ ANALYZE [ VERBOSE ] [ table [ (
   Description
 
   
-   ANALYZE collects statistics about the contents of
-   tables in the database, and stores the results in
-   the system table pg_statistic.  Subsequently,
-   the query planner uses the statistics to help determine the most efficient
+   ANALYZE collects statistics about the contents
+   of tables in the database, and stores the results in the system
+   table pg_statistic.  Subsequently, the query
+   planner uses these statistics to help determine the most efficient
    execution plans for queries.
   
 
@@ -90,49 +90,56 @@ ANALYZE [ VERBOSE ] [ table [ (
   
 
   
-   Unlike VACUUM FULL,
-   ANALYZE requires
-   only a read lock on the target table, so it can run in parallel with
-   other activity on the table.
+   Unlike VACUUM FULLANALYZE
+   requires only a read lock on the target table, so it can run in
+   parallel with other activity on the table.
   
 
   
-   For large tables, ANALYZE 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 ANALYZE 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 EXPLAIN.
+   The statistics collected by ANALYZE 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
+   ANALYZE 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 
+   linkend="maintenance">.
   
 
   
-   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
-   ANALYZE 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 .
+   For large tables, ANALYZE 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 ANALYZE 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
+   EXPLAIN. In rare situations, this
+   non-determinism will cause the query optimizer to choose a
+   different query plan between runs of ANALYZE. To
+   avoid this, raise the amount of statistics collected by
+   ANALYZE, as described below.
   
 
   
    The extent of analysis can be controlled by adjusting the
-   default_statistics_target parameter variable, or on a
-   column-by-column basis by setting the per-column
-   statistics target with ALTER TABLE ... ALTER COLUMN ... SET
-   STATISTICS (see
-   ).  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
-   ANALYZE and the amount of space occupied
-   in pg_statistic.
-   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 WHERE, GROUP BY, or ORDER BY clauses of
-   queries, since the planner will have no use for statistics on such columns.
+   DEFAULT_STATISTICS_TARGET parameter variable, or
+   on a column-by-column basis by setting the per-column statistics
+   target with ALTER TABLE ... ALTER COLUMN ... SET
+   STATISTICS (see 
+   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
+   ANALYZE and the amount of space occupied in
+   pg_statistic.  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 WHERE, GROUP BY,
+   or ORDER BY clauses of queries, since the planner will
+   have no use for statistics on such columns.
   
 
   
index ff294c63eae9af6fba258d46f942b727de14689e..209d67d6ee4a877d7b2421bebfc0afa6e4af9086 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -98,7 +98,7 @@ where option can be:
    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 password_encryption.)  If the
+   parameter PASSWORD_ENCRYPTION.)  If the
    presented password string is already in MD5-encrypted format,
    then it is stored encrypted as-is, regardless of whether
    ENCRYPTED or UNENCRYPTED is specified
index 12d879d44f01ebc22150f2bdd1c4fb3c212fb20d..07c6f2bfc024536b4bfb2df11a7f9eb0574301a3 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -376,7 +376,7 @@ PostgreSQL documentation
 
     
      
-      Default value of the <literal>datestyle> run-time
+      Default value of the <varname>DATESTYLE> run-time
       parameter.  (The use of this environment variable is deprecated.)
      
     
@@ -563,7 +563,7 @@ PostgreSQL documentation
 $ postmaster -c sort_mem=1234
 $ postmaster --sort-mem=1234
 
-   Either form overrides whatever setting might exist for <literal>sort_mem
+   Either form overrides whatever setting might exist for <varname>SORT_MEM
    in postgresql.conf.  Notice that underscores in parameter
    names can be written as either underscore or dash on the command line.
   
index 58169d17de00e7e53d6a15f31a13a56576b3e0bf..6f8fc85883d5cd21e2cc7467a44e660b28ae3642 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -85,14 +85,14 @@ SET parameter TO DEFAULT
   Examples
 
   
-   Set datestyle to its default value:
+   Set DATESTYLE to its default value:
 
 RESET datestyle;
 
   
 
   
-   Set geqo to its default value:
+   Set GEQO to its default value:
 
 RESET geqo;