diff options
| -rw-r--r-- | doc/src/sgml/backup.sgml | 6 | ||||
| -rw-r--r-- | doc/src/sgml/charset.sgml | 26 | ||||
| -rw-r--r-- | doc/src/sgml/client-auth.sgml | 26 | ||||
| -rw-r--r-- | doc/src/sgml/datatype.sgml | 16 | ||||
| -rw-r--r-- | doc/src/sgml/func.sgml | 16 | ||||
| -rw-r--r-- | doc/src/sgml/perform.sgml | 14 | ||||
| -rw-r--r-- | doc/src/sgml/problems.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/protocol.sgml | 15 | ||||
| -rw-r--r-- | doc/src/sgml/ref/alter_table.sgml | 9 | ||||
| -rw-r--r-- | doc/src/sgml/ref/analyze.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/checkpoint.sgml | 12 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_table.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_table_as.sgml | 6 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_user.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/explain.sgml | 6 | ||||
| -rw-r--r-- | doc/src/sgml/ref/postmaster.sgml | 13 | ||||
| -rw-r--r-- | doc/src/sgml/ref/select.sgml | 8 | ||||
| -rw-r--r-- | doc/src/sgml/ref/select_into.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/runtime.sgml | 403 | ||||
| -rw-r--r-- | doc/src/sgml/wal.sgml | 47 | ||||
| -rw-r--r-- | doc/src/sgml/xfunc.sgml | 4 |
21 files changed, 344 insertions, 303 deletions
diff --git a/doc/src/sgml/backup.sgml b/doc/src/sgml/backup.sgml index 114d2ea588a..cff69b96a74 100644 --- a/doc/src/sgml/backup.sgml +++ b/doc/src/sgml/backup.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.37 2004/02/17 23:56:07 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.38 2004/03/09 16:57:46 neilc Exp $ --> <chapter id="backup"> <title>Backup and Restore</title> @@ -156,8 +156,8 @@ pg_dump -h <replaceable>host1</> <replaceable>dbname</> | psql -h <replaceable>h <tip> <para> Restore performance can be improved by increasing the - configuration parameter <varname>maintenance_work_mem</varname> - (see <xref linkend="runtime-config-resource-memory">). + configuration parameter <xref + linkend="guc-maintenance-work-mem">. </para> </tip> </sect2> diff --git a/doc/src/sgml/charset.sgml b/doc/src/sgml/charset.sgml index 7a324ea965e..869c4fafd99 100644 --- a/doc/src/sgml/charset.sgml +++ b/doc/src/sgml/charset.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/charset.sgml,v 2.42 2003/12/30 23:36:19 tgl Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/charset.sgml,v 2.43 2004/03/09 16:57:46 neilc Exp $ --> <chapter id="charset"> <title>Localization</> @@ -795,23 +795,23 @@ RESET client_encoding; <listitem> <para> - Using <envar>PGCLIENTENCODING</envar>. - - If environment variable <envar>PGCLIENTENCODING</envar> is defined - in the client's environment, that client encoding is automatically - selected when a connection to the server is made. (This can subsequently - be overridden using any of the other methods mentioned above.) + Using <envar>PGCLIENTENCODING</envar>. If environment variable + <envar>PGCLIENTENCODING</envar> is defined in the client's + environment, that client encoding is automatically selected + when a connection to the server is made. (This can + subsequently be overridden using any of the other methods + mentioned above.) </para> </listitem> <listitem> <para> - Using the configuration variable <varname>client_encoding</varname>. - - If the <varname>client_encoding</> variable in <filename>postgresql.conf</> is set, that - client encoding is automatically selected when a connection to the - server is made. (This can subsequently be overridden using any of the - other methods mentioned above.) + Using the configuration variable <xref + linkend="guc-client-encoding">. If the + <varname>client_encoding</> variable is set, that client + encoding is automatically selected when a connection to the + server is made. (This can subsequently be overridden using any + of the other methods mentioned above.) </para> </listitem> diff --git a/doc/src/sgml/client-auth.sgml b/doc/src/sgml/client-auth.sgml index f1a48817490..4b7846e34f6 100644 --- a/doc/src/sgml/client-auth.sgml +++ b/doc/src/sgml/client-auth.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/client-auth.sgml,v 1.63 2004/01/26 05:35:15 momjian Exp $ +$PostgreSQL: pgsql/doc/src/sgml/client-auth.sgml,v 1.64 2004/03/09 16:57:46 neilc Exp $ --> <chapter id="client-authentication"> @@ -113,8 +113,8 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable> <para> This record matches connection attempts made using TCP/IP. Note that TCP/IP connections are disabled unless the server is - started with the <option>-i</option> option or the - <varname>tcpip_socket</> configuration parameter is + started with the <option>-i</option> option or the <xref + linkend="guc-tcpip-socket"> configuration parameter is enabled. <literal>host</literal> records match either <acronym>SSL</acronym> or non-<acronym>SSL</acronym> connection attempts. @@ -134,8 +134,8 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable> <para> To make use of this option the server must be built with <acronym>SSL</acronym> support enabled. Furthermore, - <acronym>SSL</acronym> must be enabled by setting the - <varname>ssl</varname> configuration parameter (see <xref + <acronym>SSL</acronym> must be enabled by setting the <xref + linkend="guc-ssl"> configuration parameter (see <xref linkend="ssl-tcp"> for more information). </para> </listitem> @@ -677,14 +677,14 @@ local db1,db2,@demodbs all md5 </para> <para> - Make sure that your server key file is readable (and preferably only - readable) by the <productname>PostgreSQL</productname> server - account. (See also <xref linkend="postgres-user">). The location of the - key file is specified with the <varname>krb_server_keyfile</> run-time - configuration parameter. (See also <xref - linkend="runtime-config">.) The default is <filename>/etc/srvtab</> - if you are using Kerberos 4 and - <filename>FILE:/usr/local/pgsql/etc/krb5.keytab</> (or whichever + Make sure that your server key file is readable (and preferably + only readable) by the <productname>PostgreSQL</productname> server + account. (See also <xref linkend="postgres-user">). The location + of the key file is specified by the <xref + linkend="guc-krb-server-keyfile"> run-time configuration + parameter. (See also <xref linkend="runtime-config">.) The default + is <filename>/etc/srvtab</> if you are using Kerberos 4 and + <filename>/usr/local/pgsql/etc/krb5.keytab</> (or whichever directory was specified as <varname>sysconfdir</> at build time) with Kerberos 5. </para> diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml index 2689349b8f5..f0cda231962 100644 --- a/doc/src/sgml/datatype.sgml +++ b/doc/src/sgml/datatype.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.142 2004/02/01 06:55:07 tgl Exp $ +$PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.143 2004/03/09 16:57:46 neilc Exp $ --> <chapter id="datatype"> @@ -1409,7 +1409,7 @@ SELECT b, char_length(b) FROM test2; traditional <productname>POSTGRES</productname>, and others. For some formats, ordering of month, day, and year in date input is ambiguous and there is support for specifying the expected - ordering of these fields. Set the <varname>datestyle</> parameter + ordering of these fields. Set the <xref linkend="guc-datestyle"> parameter to <literal>MDY</> to select month-day-year interpretation, <literal>DMY</> to select day-month-year interpretation, or <literal>YMD</> to select year-month-day interpretation. @@ -1720,7 +1720,7 @@ January 8 04:05:06 1999 PST time zone specified is converted to UTC using the appropriate offset for that time zone. If no time zone is stated in the input string, then it is assumed to be in the time zone indicated by the system's - <varname>timezone</> parameter, and is converted to UTC using the + <xref linkend="guc-timezone"> parameter, and is converted to UTC using the offset for the <varname>timezone</> zone. </para> @@ -1993,8 +1993,8 @@ January 8 04:05:06 1999 PST <para> The date/time styles can be selected by the user using the - <command>SET datestyle</command> command, the - <varname>datestyle</varname> parameter in the + <command>SET datestyle</command> command, the <xref + linkend="guc-datestyle"> parameter in the <filename>postgresql.conf</filename> configuration file, or the <envar>PGDATESTYLE</envar> environment variable on the server or client. The formatting function <function>to_char</function> @@ -2092,8 +2092,8 @@ January 8 04:05:06 1999 PST <listitem> <para> - The <varname>timezone</varname> configuration parameter can be - set in the file <filename>postgresql.conf</>. + The <xref linkend="guc-timezone"> configuration parameter can + be set in the file <filename>postgresql.conf</>. </para> </listitem> @@ -2929,7 +2929,7 @@ SELECT * FROM test; <productname>PostgreSQL</productname> as primary keys for various system tables. An OID system column is also added to user-created tables, unless <literal>WITHOUT OIDS</literal> is specified when - the table is created, or the <varname>default_with_oids</varname> + the table is created, or the <xref linkend="guc-default-with-oids"> configuration variable is set to false. Type <type>oid</> represents an object identifier. There are also several alias types for <type>oid</>: <type>regproc</>, <type>regprocedure</>, diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index a26424372a0..2cd0c505565 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.192 2004/03/07 01:01:44 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.193 2004/03/09 16:57:46 neilc Exp $ PostgreSQL documentation --> @@ -311,7 +311,7 @@ PostgreSQL documentation returns true if <replaceable>expression</replaceable> evaluates to the null value. It is highly recommended that these applications be modified to comply with the SQL standard. However, if that - cannot be done the <varname>transform_null_equals</varname> + cannot be done the <xref linkend="guc-transform-null-equals"> configuration variable is available. If it is enabled, <productname>PostgreSQL</productname> will convert <literal>x = NULL</literal> clauses to <literal>x IS NULL</literal>. This was @@ -2715,12 +2715,12 @@ substring('foobar' from 'o(.)b') <lineannotation>o</lineannotation> <note> <para> - The form of regular expressions accepted by <productname>PostgreSQL</> - can be chosen by setting the <varname>regex_flavor</> run-time parameter - (described in <xref linkend="runtime-config">). The usual setting is - <literal>advanced</>, but one might choose <literal>extended</> for - maximum backwards compatibility with pre-7.4 releases of - <productname>PostgreSQL</>. + The form of regular expressions accepted by + <productname>PostgreSQL</> can be chosen by setting the <xref + linkend="guc-regex-flavor"> run-time parameter. The usual + setting is <literal>advanced</>, but one might choose + <literal>extended</> for maximum backwards compatibility with + pre-7.4 releases of <productname>PostgreSQL</>. </para> </note> diff --git a/doc/src/sgml/perform.sgml b/doc/src/sgml/perform.sgml index c7d947eaf7a..b32b1d615d1 100644 --- a/doc/src/sgml/perform.sgml +++ b/doc/src/sgml/perform.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/perform.sgml,v 1.41 2004/02/03 17:34:02 tgl Exp $ +$PostgreSQL: pgsql/doc/src/sgml/perform.sgml,v 1.42 2004/03/09 16:57:46 neilc Exp $ --> <chapter id="performance-tips"> @@ -508,7 +508,7 @@ SELECT * FROM a, b, c WHERE a.id = b.id AND b.ref = c.id; <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 + set by the <xref linkend="guc-geqo-threshold"> run-time parameter.) The genetic search takes less time, but it won't necessarily find the best possible plan. @@ -549,7 +549,7 @@ SELECT * FROM a JOIN (b JOIN c ON (b.ref = c.id)) ON (a.id = b.id); <para> To force the planner to follow the <literal>JOIN</> order for inner joins, - set the <varname>join_collapse_limit</> run-time parameter to 1. + set the <xref linkend="guc-join-collapse-limit"> run-time parameter to 1. (Other possible values are discussed below.) </para> @@ -599,8 +599,8 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse; problem replacing two separate three-way join problems. Because of the exponential growth of the number of possibilities, this makes a big difference. The planner tries to avoid getting stuck in huge join search - problems by not collapsing a subquery if more than - <varname>from_collapse_limit</> <literal>FROM</> items would result in the parent + problems by not collapsing a subquery if more than <xref linkend="guc-from-collapse-limit"> + <literal>FROM</> items would result in the parent query. You can trade off planning time against quality of plan by adjusting this run-time parameter up or down. </para> @@ -688,11 +688,11 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse; <title>Increase <varname>maintenance_work_mem</varname></title> <para> - Temporarily increasing the <varname>maintenance_work_mem</varname> + Temporarily increasing the <xref linkend="guc-maintenance-work-mem"> configuration variable when restoring large amounts of data can lead to improved performance. This is because when a B-tree index is created from scratch, the existing content of the table needs - to be sorted. Allowing the merge sort to use more memory + to be sorted. Allowing the external merge sort to use more memory means that fewer merge passes will be required. A larger setting for <varname>maintenance_work_mem</varname> may also speed up validation of foreign-key constraints. diff --git a/doc/src/sgml/problems.sgml b/doc/src/sgml/problems.sgml index 02492a1febe..de10f7819ac 100644 --- a/doc/src/sgml/problems.sgml +++ b/doc/src/sgml/problems.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.17 2003/12/14 00:05:29 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.18 2004/03/09 16:57:46 neilc Exp $ --> <sect1 id="bug-reporting"> @@ -173,7 +173,7 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.17 2003/12/14 00:05:29 neilc E form of the message. In <application>psql</>, say <literal>\set VERBOSITY verbose</> beforehand. If you are extracting the message from the server log, set the run-time parameter - <varname>log_error_verbosity</> to <literal>verbose</> so that all + <xref linkend="guc-log-error-verbosity"> to <literal>verbose</> so that all details are logged. </para> </note> diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index ac32b0a2534..a4baff82a4b 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/protocol.sgml,v 1.49 2003/12/14 00:10:32 neilc Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/protocol.sgml,v 1.50 2004/03/09 16:57:46 neilc Exp $ --> <chapter id="protocol"> <title>Frontend/Backend Protocol</title> @@ -390,12 +390,13 @@ <ListItem> <Para> This message informs the frontend about the current (initial) - setting of backend parameters, such as <varname>client_encoding</> - or <varname>DateStyle</>. The frontend may ignore this message, - or record the settings for its future use; see - <xref linkend="protocol-async"> for more detail. - The frontend should not respond to this message, but should - continue listening for a ReadyForQuery message. + setting of backend parameters, such as <xref + linkend="guc-client-encoding"> or <xref linkend="guc-datestyle">. + The frontend may ignore this message, or record the settings + for its future use; see <xref linkend="protocol-async"> for + more details. The frontend should not respond to this + message, but should continue listening for a ReadyForQuery + message. </Para> </ListItem> </VarListEntry> diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_table.sgml index 023f12e606a..3411c1f24a7 100644 --- a/doc/src/sgml/ref/alter_table.sgml +++ b/doc/src/sgml/ref/alter_table.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.65 2004/03/01 17:58:39 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.66 2004/03/09 16:57:47 neilc Exp $ PostgreSQL documentation --> @@ -123,6 +123,11 @@ ALTER TABLE <replaceable class="PARAMETER">name</replaceable> </varlistentry> <varlistentry> + <indexterm> + <primary>TOAST</primary> + <secondary>per-column storage settings</secondary> + </indexterm> + <term><literal>SET STORAGE</literal></term> <listitem> <para> @@ -240,7 +245,7 @@ ALTER TABLE <replaceable class="PARAMETER">name</replaceable> to be altered, but in the current version, this is the default behavior. (In releases before 7.1, <literal>ONLY</> was the default behavior. The default can be altered by changing the - configuration parameter <varname>sql_inheritance</varname>.) + configuration parameter <xref linkend="guc-sql-inheritance">.) </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/analyze.sgml b/doc/src/sgml/ref/analyze.sgml index 102d1dafccc..3d5110e34b8 100644 --- a/doc/src/sgml/ref/analyze.sgml +++ b/doc/src/sgml/ref/analyze.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/analyze.sgml,v 1.18 2003/12/14 00:15:03 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/analyze.sgml,v 1.19 2004/03/09 16:57:47 neilc Exp $ PostgreSQL documentation --> @@ -134,7 +134,7 @@ ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<rep <para> The extent of analysis can be controlled by adjusting the - <varname>default_statistics_target</varname> parameter variable, or + <xref linkend="guc-default-statistics-target"> configuration 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" diff --git a/doc/src/sgml/ref/checkpoint.sgml b/doc/src/sgml/ref/checkpoint.sgml index 4049caf6ae0..8267990c2c4 100644 --- a/doc/src/sgml/ref/checkpoint.sgml +++ b/doc/src/sgml/ref/checkpoint.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.11 2003/11/29 19:51:38 pgsql Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.12 2004/03/09 16:57:47 neilc Exp $ --> <refentry id="sql-checkpoint"> <refmeta> @@ -27,11 +27,11 @@ CHECKPOINT <para> Write-Ahead Logging (WAL) puts a checkpoint in the transaction log every so often. (To adjust the automatic checkpoint interval, see - the run-time - configuration options <varname>checkpoint_segments</varname> - and <varname>checkpoint_timeout</varname>.) - The <command>CHECKPOINT</command> command forces an immediate checkpoint - when the command is issued, without waiting for a scheduled checkpoint. + the run-time configuration options <xref linkend="guc-checkpoint-segments"> + and <xref linkend="guc-checkpoint-timeout">.) The + <command>CHECKPOINT</command> command forces an immediate + checkpoint when the command is issued, without waiting for a + scheduled checkpoint. </para> <para> diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml index 84e99b5a063..bd0ed0e5964 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/create_table.sgml,v 1.78 2004/03/01 17:58:39 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/create_table.sgml,v 1.79 2004/03/09 16:57:47 neilc Exp $ PostgreSQL documentation --> @@ -249,7 +249,7 @@ and <replaceable class="PARAMETER">table_constraint</replaceable> is: should have OIDs (object identifiers) assigned to them. If neither <literal>WITH OIDS</literal> nor <literal>WITHOUT OIDS</literal> is specified, the default value depends upon the - <varname>default_with_oids</varname> configuration parameter. (If + <xref linkend="guc-default-with-oids"> configuration parameter. (If the new table inherits from any tables that have OIDs, then <literal>WITH OIDS</> is forced even if the command says <literal>WITHOUT OIDS</>.) diff --git a/doc/src/sgml/ref/create_table_as.sgml b/doc/src/sgml/ref/create_table_as.sgml index e406bfa4b5d..633e77cbf57 100644 --- a/doc/src/sgml/ref/create_table_as.sgml +++ b/doc/src/sgml/ref/create_table_as.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.20 2004/01/10 23:28:44 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.21 2004/03/09 16:57:47 neilc Exp $ PostgreSQL documentation --> @@ -106,7 +106,7 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE <replaceable>table_name This optional clause specifies whether the table created by <command>CREATE TABLE AS</command> should include OIDs. If neither form of this clause if specified, the value of the - <varname>default_with_oids</varname> configuration parameter is + <xref linkend="guc-default-with-oids"> configuration parameter is used. </para> </listitem> @@ -152,7 +152,7 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE <replaceable>table_name the <command>CREATE TABLE AS</command> command allows the user to explicitely specify whether OIDs should be included. If the presence of OIDs is not explicitely specified, - the <varname>default_with_oids</varname> configuration variable is + the <xref linkend="guc-default-with-oids"> configuration variable is used. While this variable currently defaults to true, the default value may be changed in the future. Therefore, applications that require OIDs in the table created by <command>CREATE TABLE diff --git a/doc/src/sgml/ref/create_user.sgml b/doc/src/sgml/ref/create_user.sgml index a243d611401..84b6b40442b 100644 --- a/doc/src/sgml/ref/create_user.sgml +++ b/doc/src/sgml/ref/create_user.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/create_user.sgml,v 1.32 2003/12/14 00:15:03 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/create_user.sgml,v 1.33 2004/03/09 16:57:47 neilc Exp $ PostgreSQL documentation --> @@ -98,7 +98,7 @@ where <replaceable class="PARAMETER">option</replaceable> 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 <varname>password_encryption</varname>.) If the + parameter <xref linkend="guc-password-encryption">.) 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 diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index 1d98fb7608d..eac8dde375e 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/explain.sgml,v 1.32 2003/11/29 19:51:38 pgsql Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/explain.sgml,v 1.33 2004/03/09 16:57:47 neilc Exp $ PostgreSQL documentation --> @@ -100,8 +100,8 @@ ROLLBACK; than just a summary. Usually this option is only useful for debugging <productname>PostgreSQL</productname>. The <literal>VERBOSE</literal> output is either pretty-printed or - not, depending on the setting of the - <varname>explain_pretty_print</varname> configuration parameter. + not, depending on the setting of the <xref + linkend="guc-explain-pretty-print"> configuration parameter. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index d829a7e2d11..2affe14d613 100644 --- a/doc/src/sgml/ref/postmaster.sgml +++ b/doc/src/sgml/ref/postmaster.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.45 2004/02/03 17:34:02 tgl Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.46 2004/03/09 16:57:47 neilc Exp $ PostgreSQL documentation --> @@ -376,7 +376,7 @@ PostgreSQL documentation <listitem> <para> - Default value of the <varname>DateStyle</varname> run-time + Default value of the <xref linkend="guc-datestyle"> run-time parameter. (The use of this environment variable is deprecated.) </para> </listitem> @@ -429,10 +429,11 @@ PostgreSQL documentation <tip> <para> - You may be able to postpone reconfiguring your kernel by decreasing - <varname>shared_buffers</varname> to reduce the shared memory consumption - of <productname>PostgreSQL</>, and/or by reducing - <varname>max_connections</varname> to reduce the semaphore consumption. + You may be able to postpone reconfiguring your kernel by + decreasing <xref linkend="guc-shared-buffers"> to reduce the + shared memory consumption of <productname>PostgreSQL</>, and/or + by reducing <xref linkend="guc-max-connections"> to reduce the + semaphore consumption. </para> </tip> diff --git a/doc/src/sgml/ref/select.sgml b/doc/src/sgml/ref/select.sgml index 63a85b2a00d..a98efcabd8f 100644 --- a/doc/src/sgml/ref/select.sgml +++ b/doc/src/sgml/ref/select.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/select.sgml,v 1.75 2004/03/03 22:22:24 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/select.sgml,v 1.76 2004/03/09 16:57:47 neilc Exp $ PostgreSQL documentation --> @@ -190,8 +190,8 @@ where <replaceable class="parameter">from_item</replaceable> can be one of: tables are to be scanned, but in the current version, this is the default behavior. (In releases before 7.1, <literal>ONLY</> was the default behavior.) The default - behavior can be modified by changing the - <varname>sql_interitance</varname> configuration option. + behavior can be modified by changing the <xref + linkend="guc-sql-inheritance"> configuration option. </para> </listitem> </varlistentry> @@ -1023,7 +1023,7 @@ SELECT distributors.* FROM distributors d, distributors distributors; <command>SELECT</command> statement that also contains an explicit <literal>FROM</literal> clause. Also, it is possible to disable the implicit-<literal>FROM</literal> feature by setting the - <varname>add_missing_from</> parameter to false. + <xref linkend="guc-add-missing-from"> parameter to false. </para> </refsect2> diff --git a/doc/src/sgml/ref/select_into.sgml b/doc/src/sgml/ref/select_into.sgml index 0585726aac9..ef469876266 100644 --- a/doc/src/sgml/ref/select_into.sgml +++ b/doc/src/sgml/ref/select_into.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/select_into.sgml,v 1.27 2003/12/13 23:59:07 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/select_into.sgml,v 1.28 2004/03/09 16:57:47 neilc Exp $ PostgreSQL documentation --> @@ -103,7 +103,7 @@ SELECT [ ALL | DISTINCT [ ON ( <replaceable class="PARAMETER">expression</replac rapidly incremented. As of <productname>PostgreSQL</> 7.5, the inclusion of OIDs in the table created by <command>SELECT INTO</command> is controlled by the - <varname>default_with_oids</varname> configuration variable. This + <xref linkend="guc-default-with-oids"> configuration variable. This variable currently defaults to true, but will likely default to false in a future release of <productname>PostgreSQL</>. </para> diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml index 335a404f070..d294c36e29b 100644 --- a/doc/src/sgml/runtime.sgml +++ b/doc/src/sgml/runtime.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.246 2004/03/09 04:43:06 momjian Exp $ +$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.247 2004/03/09 16:57:47 neilc Exp $ --> <Chapter Id="runtime"> @@ -570,7 +570,7 @@ SET ENABLE_SEQSCAN TO OFF; <variablelist> - <varlistentry> + <varlistentry id="guc-tcpip-socket" xreflabel="tcpip_socket"> <term><varname>tcpip_socket</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -582,7 +582,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-max-connections" xreflabel="max_connections"> <term><varname>max_connections</varname> (<type>integer</type>)</term> <listitem> <para> @@ -603,18 +603,20 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-superuser-reserved-connections" + xreflabel="superuser_reserved_connections"> <term><varname>superuser_reserved_connections</varname> (<type>integer</type>)</term> <listitem> <para> Determines the number of <quote>connection slots</quote> that are reserved for connections by <productname>PostgreSQL</> - superusers. At most <varname>max_connections</> connections can - ever be active simultaneously. Whenever the number of active - concurrent connections is at least <varname>max_connections</> minus - <varname>superuser_reserved_connections</varname>, new connections - will be accepted only for superusers. + superusers. At most <xref linkend="guc-max-connections"> + connections can ever be active simultaneously. Whenever the + number of active concurrent connections is at least + <varname>max_connections</> minus + <varname>superuser_reserved_connections</varname>, new + connections will be accepted only for superusers. </para> <para> @@ -625,7 +627,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-port" xreflabel="port"> <term><varname>port</varname> (<type>integer</type>)</term> <indexterm><primary>port</></> <listitem> @@ -637,7 +639,7 @@ SET ENABLE_SEQSCAN TO OFF; </varlistentry> - <varlistentry> + <varlistentry id="guc-unix-socket-directory" xreflabel="unix_socket_directory"> <term><varname>unix_socket_directory</varname> (<type>string</type>)</term> <listitem> <para> @@ -649,7 +651,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-unix-socket-group" xreflabel="unix_socket_group"> <term><varname>unix_socket_group</varname> (<type>string</type>)</term> <listitem> <para> @@ -665,7 +667,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-unix-socket-permissions" xreflabel="unix_socket_permissions"> <term><varname>unix_socket_permissions</varname> (<type>integer</type>)</term> <listitem> <para> @@ -699,7 +701,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-virtual-host" xreflabel="virtual_host"> <term><varname>virtual_host</varname> (<type>string</type>)</term> <listitem> <para> @@ -713,7 +715,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-rendezvous-name" xreflabel="rendezvous_name"> <term><varname>rendezvous_name</varname> (<type>string</type>)</term> <listitem> <para> @@ -729,7 +731,7 @@ SET ENABLE_SEQSCAN TO OFF; <title>Security and Authentication</title> <variablelist> - <varlistentry> + <varlistentry id="guc-authentication-timeout" xreflabel="authentication_timeout"> <term><varname>authentication_timeout</varname> (<type>integer</type>)</term> <indexterm><primary>timeout</><secondary>client authentication</></indexterm> <indexterm><primary>client authentication</><secondary>timeout during</></indexterm> @@ -745,11 +747,10 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-ssl" xreflabel="ssl"> <indexterm> <primary>SSL</primary> </indexterm> - <term><varname>ssl</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -760,7 +761,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-password-encryption" xreflabel="password_encryption"> <term><varname>password_encryption</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -772,7 +773,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-krb-server-keyfile" xreflabel="krb_server_keyfile"> <term><varname>krb_server_keyfile</varname> (<type>string</type>)</term> <listitem> <para> @@ -782,7 +783,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-db-user-namespace" xreflabel="db_user_namespace"> <term><varname>db_user_namespace</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -827,7 +828,7 @@ SET ENABLE_SEQSCAN TO OFF; <title>Memory</title> <variablelist> - <varlistentry> + <varlistentry id="guc-shared-buffers" xreflabel="shared_buffers"> <term><varname>shared_buffers</varname> (<type>integer</type>)</term> <listitem> <para> @@ -837,7 +838,7 @@ SET ENABLE_SEQSCAN TO OFF; <application>initdb</>). Each buffer is 8192 bytes, unless a different value of <symbol>BLCKSZ</symbol> was chosen when building the server. This setting must be at least 16, as well as at - least twice the value of <varname>max_connections</varname>; + least twice the value of <xref linkend="guc-max-connections">; however, settings significantly higher than the minimum are usually needed for good performance. Values of a few thousand are recommended for production installations. This option can @@ -854,7 +855,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-work-mem" xreflabel="work_mem"> <term><varname>work_mem</varname> (<type>integer</type>)</term> <listitem> <para> @@ -876,7 +877,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-maintenance-work-mem" xreflabel="maintenance_work_mem"> <term><varname>maintenance_work_mem</varname> (<type>integer</type>)</term> <listitem> <para> @@ -900,7 +901,7 @@ SET ENABLE_SEQSCAN TO OFF; <title>Free Space Map</title> <variablelist> - <varlistentry> + <varlistentry id="guc-max-fsm-pages" xreflabel="max_fsm_pages"> <term><varname>max_fsm_pages</varname> (<type>integer</type>)</term> <listitem> <para> @@ -913,7 +914,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-max-fsm-relations" xreflabel="max_fsm_relations"> <term><varname>max_fsm_relations</varname> (<type>integer</type>)</term> <listitem> <para> @@ -932,7 +933,7 @@ SET ENABLE_SEQSCAN TO OFF; <title>Kernel Resource Usage</title> <variablelist> - <varlistentry> + <varlistentry id="guc-max-files-per-process" xreflabel="max_files_per_process"> <term><varname>max_files_per_process</varname> (<type>integer</type>)</term> <listitem> <para> @@ -949,7 +950,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-preload-libraries" xreflabel="preload_libraries"> <term><varname>preload_libraries</varname> (<type>string</type>)</term> <indexterm><primary>preload_libraries</></> <listitem> @@ -1025,7 +1026,7 @@ SET ENABLE_SEQSCAN TO OFF; </para> <variablelist> - <varlistentry> + <varlistentry id="guc-vacuum-cost-page-hit" xreflabel="vacuum_cost_page_hit"> <term><varname>vacuum_cost_page_hit</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1037,7 +1038,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-vacuum-cost-page-miss" xreflabel="vacuum_cost_page_miss"> <term><varname>vacuum_cost_page_miss</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1049,7 +1050,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-vacuum-cost-page-dirty" xreflabel="vacuum_cost_page_dirty"> <term><varname>vacuum_cost_page_dirty</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1061,7 +1062,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-vacuum-cost-limit" xreflabel="vacuum_cost_limit"> <term><varname>vacuum_cost_limit</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1071,7 +1072,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-vacuum-cost-naptime" xreflabel="vacuum_cost_naptime"> <term><varname>vacuum_cost_naptime</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1118,7 +1119,7 @@ SET ENABLE_SEQSCAN TO OFF; <title>Settings</title> <variablelist> - <varlistentry> + <varlistentry id="guc-fsync" xreflabel="fsync"> <indexterm> <primary>fsync</primary> </indexterm> @@ -1168,7 +1169,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-wal-sync-method" xreflabel="wal_sync_method"> <term><varname>wal_sync_method</varname> (<type>string</type>)</term> <listitem> <para> @@ -1185,7 +1186,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-wal-buffers" xreflabel="wal_buffers"> <term><varname>wal_buffers</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1202,7 +1203,7 @@ SET ENABLE_SEQSCAN TO OFF; <title>Checkpoints</title> <variablelist> - <varlistentry> + <varlistentry id="guc-checkpoint-segments" xreflabel="checkpoint_segments"> <term><varname>checkpoint_segments</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1214,7 +1215,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-checkpoint-timeout" xreflabel="checkpoint_timeout"> <term><varname>checkpoint_timeout</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1226,7 +1227,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-checkpoint-warning" xreflabel="checkpoint_warning"> <term><varname>checkpoint_warning</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1239,7 +1240,7 @@ SET ENABLE_SEQSCAN TO OFF; </varlistentry> - <varlistentry> + <varlistentry id="guc-commit-delay" xreflabel="commit_delay"> <term><varname>commit_delay</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1258,7 +1259,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-commit-siblings" xreflabel="commit_siblings"> <term><varname>commit_siblings</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1299,7 +1300,7 @@ SET ENABLE_SEQSCAN TO OFF; </note> <variablelist> - <varlistentry> + <varlistentry id="guc-enable-hashagg" xreflabel="enable_hashagg"> <term><varname>enable_hashagg</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -1310,7 +1311,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-enable-hashjoin" xreflabel="enable_hashjoin"> <term><varname>enable_hashjoin</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -1321,7 +1322,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-enable-indexscan" xreflabel="enable_indexscan"> <indexterm> <primary>index scan</primary> </indexterm> @@ -1336,7 +1337,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-enable-mergejoin" xreflabel="enable_mergejoin"> <term><varname>enable_mergejoin</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -1347,7 +1348,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-enable-nestloop" xreflabel="enable_nestloop"> <term><varname>enable_nestloop</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -1360,7 +1361,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-enable-seqscan" xreflabel="enable_seqscan"> <indexterm> <primary>sequential scan</primary> </indexterm> @@ -1377,7 +1378,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-enable-sort" xreflabel="enable_sort"> <term><varname>enable_sort</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -1390,7 +1391,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-enable-tidscan" xreflabel="enable_tidscan"> <term><varname>enable_tidscan</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -1419,7 +1420,7 @@ SET ENABLE_SEQSCAN TO OFF; <variablelist> - <varlistentry> + <varlistentry id="guc-effective-cache-size" xreflabel="effective_cache_size"> <term><varname>effective_cache_size</varname> (<type>floating point</type>)</term> <listitem> <para> @@ -1432,7 +1433,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-random-page-cost" xreflabel="random_page_cost"> <term><varname>random_page_cost</varname> (<type>floating point</type>)</term> <listitem> <para> @@ -1446,7 +1447,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-cpu-tuple-cost" xreflabel="cpu_tuple_cost"> <term><varname>cpu_tuple_cost</varname> (<type>floating point</type>)</term> <listitem> <para> @@ -1457,7 +1458,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-cpu-index-tuple-cost" xreflabel="cpu_index_tuple_cost"> <term><varname>cpu_index_tuple_cost</varname> (<type>floating point</type>)</term> <listitem> <para> @@ -1469,7 +1470,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-cpu-operator-cost" xreflabel="cpu_operator_cost"> <term><varname>cpu_operator_cost</varname> (<type>floating point</type>)</term> <listitem> <para> @@ -1488,7 +1489,7 @@ SET ENABLE_SEQSCAN TO OFF; <variablelist> - <varlistentry> + <varlistentry id="guc-geqo" xreflabel="geqo"> <indexterm> <primary>genetic query optimization</primary> </indexterm> @@ -1500,14 +1501,15 @@ SET ENABLE_SEQSCAN TO OFF; <listitem> <para> Enables or disables genetic query optimization, which is an - algorithm that attempts to do query planning without exhaustive - searching. This is on by default. See also the various other - <varname>geqo_</varname> settings. + algorithm that attempts to do query planning without + exhaustive searching. This is on by default. The + <varname>geqo_threshold</varname> variable provides a more + granular way to disable GEQO for certain classes of queries. </para> </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-geqo-threshold" xreflabel="geqo_threshold"> <term><varname>geqo_threshold</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1521,37 +1523,63 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> - <term><varname>geqo_effort</varname> (<type>integer</type>)</term> + <varlistentry id="guc-geqo-effort" xreflabel="geqo_effort"> + <term><varname>geqo_effort</varname> + (<type>integer</type>)</term> + <listitem> + <para> + Controls the tradeoff between planning time and query plan + efficiency in GEQO. Valid values for this variable range + from 1 to 10; the default is 5. Larger values increasee the + time spent doing query planning, but increase the likelyhood + that an efficient query plan will be chosen. + </para> + + <para> + <varname>geqo_effort</varname> doesn't actually do anything + directly; it is only used to compute the default values for + the other variables that influence GEQO behavior (described + below). If you prefer, you can set the other parameters by + hand instead. + </para> + </listitem> + </varlistentry> + + <varlistentry id="guc-geqo-pool-size" xreflabel="geqo_pool_size"> <term><varname>geqo_pool_size</varname> (<type>integer</type>)</term> + <listitem> + <para> + Controls the pool size used by GEQO. The pool size is the + number of individuals in the genetic population. It must be + at least two, and useful values are typically 100 to 1000. If + it is set to zero (the default setting) then a suitable + default is chosen based on <varname>geqo_effort</varname> and + the number of tables in the query. + </para> + </listitem> + </varlistentry> + + <varlistentry id="guc-geqo-generations" xreflabel="geqo_generations"> <term><varname>geqo_generations</varname> (<type>integer</type>)</term> + <listitem> + <para> + Controls the number of generations used by GEQO. Generations + specifies the number of iterations of the algorithm. It must + be at least one, and useful values are in the same range as + the pool size. If it is set to zero (the default setting) + then a suitable default is chosen based on + <varname>geqo_pool_size</varname>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="guc-geqo-selection-bias" xreflabel="geqo_selection_bias"> <term><varname>geqo_selection_bias</varname> (<type>floating point</type>)</term> <listitem> <para> - Various tuning parameters for the genetic query optimization - algorithm. The recommended one to modify is - <varname>geqo_effort</varname>, which can range from 1 to 10 with - a default of 5. Larger values increase the time spent in planning - but make it more likely that a good plan will be found. - <varname>geqo_effort</varname> doesn't actually do anything directly, - it is just used to compute the default values for the other - parameters. If you prefer, you can set the other parameters by hand - instead. - The pool size is the number of individuals in the genetic population. - It must be at least two, and useful values are typically 100 to 1000. - If it is set to zero (the default setting) then a suitable default - is chosen based on <varname>geqo_effort</varname> and the number of - tables in the query. - Generations specifies the number of iterations of the algorithm. - It must be at least one, and useful values are in the same range - as the pool size. - If it is set to zero (the default setting) then a suitable default - is chosen based on the pool size. - The run time of the algorithm is roughly proportional to the sum of - pool size and generations. - The selection bias is the selective pressure within the - population. Values can be from 1.50 to 2.00; the latter is the - default. + Controls the selection bias used by GEQO. The selection bias + is the selective pressure within the population. Values can be + from 1.50 to 2.00; the latter is the default. </para> </listitem> </varlistentry> @@ -1563,7 +1591,7 @@ SET ENABLE_SEQSCAN TO OFF; <variablelist> - <varlistentry> + <varlistentry id="guc-default-statistics-target" xreflabel="default_statistics_target"> <term><varname>default_statistics_target</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1578,7 +1606,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-from-collapse-limit" xreflabel="from_collapse_limit"> <term><varname>from_collapse_limit</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1586,12 +1614,12 @@ SET ENABLE_SEQSCAN TO OFF; resulting <literal>FROM</literal> list would have no more than this many items. Smaller values reduce planning time but may yield inferior query plans. The default is 8. It is usually - wise to keep this less than <varname>geqo_threshold</varname>. + wise to keep this less than <xref linkend="guc-geqo-threshold">. </para> </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-join-collapse-limit" xreflabel="join_collapse_limit"> <term><varname>join_collapse_limit</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1661,7 +1689,7 @@ SET ENABLE_SEQSCAN TO OFF; <variablelist> - <varlistentry> + <varlistentry id="guc-syslog" xreflabel="syslog"> <term><varname>syslog</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1677,7 +1705,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-syslog-facility" xreflabel="syslog_facility"> <term><varname>syslog_facility</varname> (<type>string</type>)</term> <listitem> <para> @@ -1694,7 +1722,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-syslog-ident" xreflabel="syslog_ident"> <term><varname>syslog_ident</varname> (<type>string</type>)</term> <listitem> <para> @@ -1714,7 +1742,7 @@ SET ENABLE_SEQSCAN TO OFF; <variablelist> - <varlistentry> + <varlistentry id="guc-client-min-messages" xreflabel="client_min_messages"> <term><varname>client_min_messages</varname> (<type>string</type>)</term> <listitem> <para> @@ -1731,7 +1759,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-log-min-messages" xreflabel="log_min_messages"> <term><varname>log_min_messages</varname> (<type>string</type>)</term> <listitem> <para> @@ -1750,7 +1778,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-log-error-verbosity" xreflabel="log_error_verbosity"> <term><varname>log_error_verbosity</varname> (<type>string</type>)</term> <listitem> <para> @@ -1762,7 +1790,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-log-min-error-statement" xreflabel="log_min_error_statement"> <term><varname>log_min_error_statement</varname> (<type>string</type>)</term> <listitem> <para> @@ -1786,7 +1814,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-log-min-duration-statement" xreflabel="log_min_duration_statement"> <term><varname>log_min_duration_statement</varname> (<type>integer</type>)</term> <listitem> <para> @@ -1805,17 +1833,18 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-silent-mode" xreflabel="silent_mode"> <term><varname>silent_mode</varname> (<type>boolean</type>)</term> <listitem> <para> Runs the server silently. If this option is set, the server - will automatically run in background and any controlling terminals - are disassociated. Thus, no messages are written to standard - output or standard error (same effect as <command>postmaster</>'s <option>-S</option> - option). Unless - <application>syslog</> logging is enabled, using this option is - discouraged since it makes it impossible to see error messages. + will automatically run in background and any controlling + terminals are disassociated. Thus, no messages are written to + standard output or standard error (same effect as + <command>postmaster</>'s <option>-S</option> option). Unless + <application>syslog</> logging is enabled, using this option + is discouraged because it makes it impossible to see error + messages. </para> </listitem> </varlistentry> @@ -1908,9 +1937,9 @@ SET ENABLE_SEQSCAN TO OFF; </sect3> <sect3 id="runtime-config-logging-what"> <title>What To Log</title> - + <variablelist> - + <varlistentry> <term><varname>debug_print_parse</varname> (<type>boolean</type>)</term> <term><varname>debug_print_rewritten</varname> (<type>boolean</type>)</term> @@ -1931,7 +1960,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-log-connections" xreflabel="log_connections"> <term><varname>log_connections</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -1943,8 +1972,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - - <varlistentry> + <varlistentry id="guc-log-disconnections" xreflabel="log_disconnections"> <term><varname>log_disconnections</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -1958,21 +1986,21 @@ SET ENABLE_SEQSCAN TO OFF; </varlistentry> - <varlistentry> + <varlistentry id="guc-log-duration" xreflabel="log_duration"> <term><varname>log_duration</varname> (<type>boolean</type>)</term> <listitem> <para> Causes the duration of every completed statement to be logged. - To use this option, enable <varname>log_statement</> and - <varname>log_pid</> so you can link the statement to the - duration using the process ID. The default is off. - Only superusers can turn off this option if it is enabled by - the administrator. + To use this option, it is recommended that you also enable + <varname>log_statement</> and <varname>log_pid</> so that you + can link the statement to the duration using the process + ID. The default is off. Only superusers can turn off this + option if it is enabled by the administrator. </para> </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-log-line-prefix" xreflabel="log_line_prefix"> <term><varname>log_line_prefix</varname> (<type>string</type>)</term> <listitem> <para> @@ -2077,7 +2105,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-log-statement" xreflabel="log_statement"> <term><varname>log_statement</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2091,7 +2119,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-log-timestamp" xreflabel="log_timestamp"> <term><varname>log_timestamp</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2101,7 +2129,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-log-hostname" xreflabel="log_hostname"> <term><varname>log_hostname</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2114,7 +2142,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-log-source-port" xreflabel="log_source_port"> <term><varname>log_source_port</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2161,7 +2189,7 @@ SET ENABLE_SEQSCAN TO OFF; <title>Query and Index Statistics Collector</title> <variablelist> - <varlistentry> + <varlistentry id="guc-stats-start-collector" xreflabel="stats_start_collector"> <term><varname>stats_start_collector</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2174,7 +2202,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-stats-command-string" xreflabel="stats_command_string"> <term><varname>stats_command_string</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2206,7 +2234,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-stats-reset-on-server-start" xreflabel="stats_reset_on_server_start"> <term><varname>stats_reset_on_server_start</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2229,7 +2257,7 @@ SET ENABLE_SEQSCAN TO OFF; <title>Statement Behavior</title> <variablelist> - <varlistentry> + <varlistentry id="guc-search-path" xreflabel="search_path"> <term><varname>search_path</varname> (<type>string</type>)</term> <indexterm><primary>search_path</></> <indexterm><primary>path</><secondary>for schemas</></> @@ -2296,7 +2324,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-check-function-bodies" xreflabel="check_function_bodies"> <term><varname>check_function_bodies</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2308,7 +2336,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-default-transaction-isolation" xreflabel="default_transaction_isolation"> <indexterm> <primary>transaction isolation level</primary> </indexterm> @@ -2331,7 +2359,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-default-transaction-read-only" xreflabel="default_transaction_read_only"> <indexterm> <primary>read-only transaction</primary> </indexterm> @@ -2350,7 +2378,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-statement-timeout" xreflabel="statement_timeout"> <term><varname>statement_timeout</varname> (<type>integer</type>)</term> <listitem> <para> @@ -2368,7 +2396,7 @@ SET ENABLE_SEQSCAN TO OFF; <variablelist> - <varlistentry> + <varlistentry id="guc-datestyle" xreflabel="datestyle"> <term><varname>datestyle</varname> (<type>string</type>)</term> <indexterm><primary>date style</></> <listitem> @@ -2389,7 +2417,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-timezone" xreflabel="timezone"> <term><varname>timezone</varname> (<type>string</type>)</term> <indexterm><primary>time zone</></> <listitem> @@ -2402,7 +2430,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-australian-timezones" xreflabel="australian_timezones"> <term><varname>australian_timezones</varname> (<type>boolean</type>)</term> <indexterm><primary>time zone</><secondary>Australian</></> <listitem> @@ -2416,7 +2444,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-extra-float-digits" xreflabel="extra_float_digits"> <indexterm> <primary>significant digits</primary> </indexterm> @@ -2440,7 +2468,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-client-encoding" xreflabel="client_encoding"> <term><varname>client_encoding</varname> (<type>string</type>)</term> <indexterm><primary>character set</></> <listitem> @@ -2451,7 +2479,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-lc-messages" xreflabel="lc_messages"> <term><varname>lc_messages</varname> (<type>string</type>)</term> <listitem> <para> @@ -2472,7 +2500,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-lc-monetary" xreflabel="lc_monetary"> <term><varname>lc_monetary</varname> (<type>string</type>)</term> <listitem> <para> @@ -2487,7 +2515,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-lc-numeric" xreflabel="lc_numeric"> <term><varname>lc_numeric</varname> (<type>string</type>)</term> <listitem> <para> @@ -2502,7 +2530,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-lc-time" xreflabel="lc_time"> <term><varname>lc_time</varname> (<type>string</type>)</term> <listitem> <para> @@ -2525,7 +2553,7 @@ SET ENABLE_SEQSCAN TO OFF; <variablelist> - <varlistentry> + <varlistentry id="guc-explain-pretty-print" xreflabel="explain_pretty_print"> <term><varname>explain_pretty_print</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2536,7 +2564,7 @@ SET ENABLE_SEQSCAN TO OFF; </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-dynamic-library-path" xreflabel="dynamic_library_path"> <term><varname>dynamic_library_path</varname> (<type>string</type>)</term> <indexterm><primary>dynamic_library_path</></> <indexterm><primary>dynamic loading</></> @@ -2582,7 +2610,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-max-expr-depth" xreflabel="max_expr_depth"> <term><varname>max_expr_depth</varname> (<type>integer</type>)</term> <listitem> <para> @@ -2603,7 +2631,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' <variablelist> - <varlistentry> + <varlistentry id="guc-deadlock-timeout" xreflabel="deadlock_timeout"> <indexterm> <primary>deadlock</primary> <secondary>timeout during</secondary> @@ -2634,7 +2662,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-max-locks-per-transaction" xreflabel="max_locks_per_transaction"> <term><varname>max_locks_per_transaction</varname> (<type>integer</type>)</term> <listitem> <para> @@ -2659,7 +2687,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' <title>Previous PostgreSQL Versions</title> <variablelist> - <varlistentry> + <varlistentry id="guc-add-missing-from" xreflabel="add_missing_from"> <term><varname>add_missing_from</varname> (<type>boolean</type>)</term> <indexterm><primary>FROM</><secondary>missing</></> <listitem> @@ -2676,7 +2704,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-regex-flavor" xreflabel="regex_flavor"> <term><varname>regex_flavor</varname> (<type>string</type>)</term> <indexterm><primary>regular expressions</></> <listitem> @@ -2690,7 +2718,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-sql-inheritance" xreflabel="sql_inheritance"> <term><varname>sql_inheritance</varname> (<type>boolean</type>)</term> <indexterm><primary>inheritance</></> <listitem> @@ -2706,7 +2734,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-default-with-oids" xreflabel="default_with_oids"> <term><varname>default_with_oids</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2743,7 +2771,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' <title>Platform and Client Compatibility</title> <variablelist> - <varlistentry> + <varlistentry id="guc-transform-null-equals" xreflabel="transform_null_equals"> <term><varname>transform_null_equals</varname> (<type>boolean</type>)</term> <indexterm><primary>IS NULL</></> <listitem> @@ -2795,40 +2823,44 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' <para> The following options are available read-only, and are determined - at source code compile time. As such, they have been excluded from the - sample <filename>postgresql.conf</> file. They determine various aspects - of <productname>PostgreSQL</productname> behavior that may be of interest - to certain applications, particularly administrative front-ends. + when <productname>PostgreSQL</productname> is compiled. As such, + they have been excluded from the sample + <filename>postgresql.conf</> file. These options determine + various aspects of <productname>PostgreSQL</productname> behavior + that may be of interest to certain applications, particularly + administrative front-ends. </para> <variablelist> - <varlistentry> + <varlistentry id="guc-block-size" xreflabel="block_size"> <term><varname>block_size</varname> (<type>integer</type>)</term> <listitem> <para> Shows the size of a disk block. It is determined by the value of <literal>BLCKSZ</> when building the server. The default - value is 8192 bytes. The <varname>shared_buffers</varname> setting is - influenced by <varname>block_size</varname>. See - <xref linkend="runtime-config-resource"> for information. + value is 8192 bytes. The meaning of some configuration + variables (such as <xref linkend="guc-shared-buffers">) is + influenced by <varname>block_size</varname>. See <xref + linkend="runtime-config-resource"> for information. </para> </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-integer-datetimes" xreflabel="integer_datetimes"> <term><varname>integer_datetimes</varname> (<type>boolean</type>)</term> <listitem> <para> - Shows <literal>on</literal> if <productname>PostgreSQL</productname> - was built with support for 64-bit integer dates and times. It is - set by configuring with <literal>--enable-integer-datetimes</literal>. - The default value is <literal>off</literal>. + Shows whether <productname>PostgreSQL</productname> was built + with support for 64-bit integer dates and times. It is set by + configuring with <literal>--enable-integer-datetimes</literal> + when building <productname>PostgreSQL</productname>. The + default value is <literal>off</literal>. </para> </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-max-function-args" xreflabel="max_function_args"> <term><varname>max_function_args</varname> (<type>integer</type>)</term> <listitem> <para> @@ -2839,7 +2871,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-max-identifier-length" xreflabel="max_identifier_length"> <term><varname>max_identifier_length</varname> (<type>integer</type>)</term> <listitem> <para> @@ -2852,7 +2884,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-max-index-keys" xreflabel="max_index_keys"> <term><varname>max_index_keys</varname> (<type>integer</type>)</term> <listitem> <para> @@ -2880,7 +2912,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </para> <variablelist> - <varlistentry> + <varlistentry id="guc-debug-assertions" xreflabel="debug_assertions"> <term><varname>debug_assertions</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2898,7 +2930,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-pre-auth-delay" xreflabel="pre_auth_delay"> <term><varname>pre_auth_delay</varname> (<type>integer</type>)</term> <listitem> <para> @@ -2911,14 +2943,14 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-trace-notify" xreflabel="trace_notify"> <term><varname>trace_notify</varname> (<type>boolean</type>)</term> <listitem> <para> Generates a great amount of debugging output for the <command>LISTEN</command> and <command>NOTIFY</command> - commands. <varname>client_min_messages</varname> or - <varname>log_min_messages</varname> must be + commands. <xref linkend="guc-client-min-messages"> or + <xref linkend="guc-log-min-messages"> must be <literal>DEBUG1</literal> or lower to send this output to the client or server log, respectively. </para> @@ -2940,7 +2972,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-wal-debug" xreflabel="wal_debug"> <term><varname>wal_debug</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -2952,7 +2984,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' </listitem> </varlistentry> - <varlistentry> + <varlistentry id="guc-zero-damaged-pages" xreflabel="zero-damaged-pages"> <term><varname>zero_damaged_pages</varname> (<type>boolean</type>)</term> <listitem> <para> @@ -3049,12 +3081,12 @@ $ <userinput>postmaster -o '-S 1024 -s'</userinput> </footnote> </entry> <entry> - <literal>enable_indexscan=off</>, - <literal>enable_hashjoin=off</>, - <literal>enable_mergejoin=off</>, - <literal>enable_nestloop=off</>, - <literal>enable_seqscan=off</>, - <literal>enable_tidscan=off</> + <literal>enable_indexscan = off</>, + <literal>enable_hashjoin = off</>, + <literal>enable_mergejoin = off</>, + <literal>enable_nestloop = off</>, + <literal>enable_seqscan = off</>, + <literal>enable_tidscan = off</> </entry> </row> @@ -3071,9 +3103,9 @@ $ <userinput>postmaster -o '-S 1024 -s'</userinput> <row> <entry><option>-tpa</option>, <option>-tpl</option>, <option>-te</option><footnoteref linkend="fn.runtime-config-short"></entry> - <entry><literal>log_parser_stats=on</>, - <literal>log_planner_stats=on</>, - <literal>log_executor_stats=on</></entry> + <entry><literal>log_parser_stats = on</>, + <literal>log_planner_stats = on</>, + <literal>log_executor_stats = on</></entry> </row> </tbody> </tgroup> @@ -3154,7 +3186,8 @@ $ <userinput>postmaster -o '-S 1024 -s'</userinput> <row> <entry><varname>SHMMAX</></> <entry>Maximum size of shared memory segment (bytes)</> - <entry>250 kB + 8.2 kB * <varname>shared_buffers</> + 14.2 kB * <varname>max_connections</> up to infinity</entry> + <entry>250 kB + 8.2 kB * <xref linkend="guc-shared-buffers"> + + 14.2 kB * <xref linkend="guc-max-connections"> up to infinity</entry> </row> <row> @@ -3641,9 +3674,9 @@ default:\ On the other side of the coin, some systems allow individual processes to open large numbers of files; if more than a few processes do so then the system-wide limit can easily be exceeded. - If you find this happening, and you do not want to alter the system-wide - limit, you can set <productname>PostgreSQL</productname>'s - <varname>max_files_per_process</varname> configuration parameter to + If you find this happening, and you do not want to alter the + system-wide limit, you can set <productname>PostgreSQL</>'s <xref + linkend="guc-max-files-per-process"> configuration parameter to limit the consumption of open files. </para> </sect2> @@ -3814,7 +3847,7 @@ $ <userinput>kill -INT `head -1 /usr/local/pgsql/data/postmaster.pid`</userinput With <acronym>SSL</> support compiled in, the <productname>PostgreSQL</> server can be started with <acronym>SSL</> enabled by setting the parameter - <varname>ssl</varname> to on in <filename>postgresql.conf</>. When + <xref linkend="guc-ssl"> to on in <filename>postgresql.conf</>. When starting in <acronym>SSL</> mode, the server will look for the files <filename>server.key</> and <filename>server.crt</> in the data directory, which should contain the server private key diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index 8d0127b9f94..9cbf4db6ce2 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/wal.sgml,v 1.27 2004/01/06 17:26:23 neilc Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/wal.sgml,v 1.28 2004/03/09 16:57:47 neilc Exp $ --> <chapter id="wal"> <title>Write-Ahead Logging (<acronym>WAL</acronym>)</title> @@ -162,10 +162,10 @@ </para> <para> - The server spawns a special process every so often - to create the next checkpoint. A checkpoint is created every - <varname>checkpoint_segments</varname> log segments, or every - <varname>checkpoint_timeout</varname> seconds, whichever comes first. + The server spawns a special process every so often to create the + next checkpoint. A checkpoint is created every <xref + linkend="guc-checkpoint-segments"> log segments, or every <xref + linkend="guc-checkpoint-timeout"> seconds, whichever comes first. The default settings are 3 segments and 300 seconds respectively. It is also possible to force a checkpoint by using the SQL command <command>CHECKPOINT</command>. @@ -204,11 +204,11 @@ space for the new record, <function>LogInsert</function> will have to write (move to kernel cache) a few filled <acronym>WAL</acronym> buffers. This is undesirable because <function>LogInsert</function> - is used on every database low level modification (for example, - row insertion) at a time when an exclusive lock is held on - affected data pages, so the operation needs to be as fast as - possible. What is worse, writing <acronym>WAL</acronym> buffers may - also force the creation of a new log segment, which takes even more + is used on every database low level modification (for example, row + insertion) at a time when an exclusive lock is held on affected + data pages, so the operation needs to be as fast as possible. What + is worse, writing <acronym>WAL</acronym> buffers may also force the + creation of a new log segment, which takes even more time. Normally, <acronym>WAL</acronym> buffers should be written and flushed by a <function>LogFlush</function> request, which is made, for the most part, at transaction commit time to ensure that @@ -217,9 +217,9 @@ not occur often enough to prevent <acronym>WAL</acronym> buffers being written by <function>LogInsert</function>. On such systems one should increase the number of <acronym>WAL</acronym> buffers by - modifying the configuration parameter <varname>wal_buffers</varname>. - The default number of <acronym> - WAL</acronym> buffers is 8. Increasing this value will + modifying the configuration parameter <xref + linkend="guc-wal-buffers">. The default number of <acronym> + WAL</acronym> buffers is 8. Increasing this value will correspondingly increase shared memory usage. </para> @@ -228,20 +228,20 @@ buffers to disk using the operating system <literal>sync()</> call. Busy servers may fill checkpoint segment files too quickly, causing excessive checkpointing. If such forced checkpoints happen - more frequently than <varname>checkpoint_warning</varname> seconds, + more frequently than <xref linkend="guc-checkpoint-warning"> seconds, a message, will be output to the server logs recommending increasing <varname>checkpoint_segments</varname>. </para> <para> - The <varname>commit_delay</varname> parameter defines for how many + The <xref linkend="guc-commit-delay"> parameter defines for how many microseconds the server process will sleep after writing a commit record to the log with <function>LogInsert</function> but before performing a <function>LogFlush</function>. This delay allows other server processes to add their commit records to the log so as to have all of them flushed with a single log sync. No sleep will occur if - <varname>fsync</varname> - is not enabled, nor if fewer than <varname>commit_siblings</varname> + <xref linkend="guc-fsync"> + is not enabled, nor if fewer than <xref linkend="guc-commit-siblings"> other sessions are currently in active transactions; this avoids sleeping when it's unlikely that any other session will commit soon. Note that on most platforms, the resolution of a sleep request is @@ -252,7 +252,7 @@ </para> <para> - The <varname>wal_sync_method</varname> parameter determines how + The <xref linkend="guc-wal-sync-method"> parameter determines how <productname>PostgreSQL</productname> will ask the kernel to force <acronym>WAL</acronym> updates out to disk. All the options should be the same as far as reliability goes, @@ -262,11 +262,12 @@ </para> <para> - Enabling the <varname>wal_debug</varname> configuration parameter - will result in each <function>LogInsert</function> and - <function>LogFlush</function> <acronym>WAL</acronym> call being - logged to the server log. This option may be replaced by a more - general mechanism in the future. + Enabling the <xref linkend="guc-wal-debug"> configuration parameter + (provided that <productname>PostgreSQL</productname> has been + compiled with support for it) will result in each + <function>LogInsert</function> and <function>LogFlush</function> + <acronym>WAL</acronym> call being logged to the server log. This + option may be replaced by a more general mechanism in the future. </para> </sect1> diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index fa2a814a5a7..c8f71296857 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/xfunc.sgml,v 1.79 2003/11/29 19:51:38 pgsql Exp $ +$PostgreSQL: pgsql/doc/src/sgml/xfunc.sgml,v 1.80 2004/03/09 16:57:47 neilc Exp $ --> <sect1 id="xfunc"> @@ -738,7 +738,7 @@ CREATE FUNCTION square_root(double precision) RETURNS double precision <para> If the name does not contain a directory part, the file is searched for in the path specified by the configuration variable - <varname>dynamic_library_path</varname>.<indexterm><primary>dynamic_library_path</></> + <xref linkend="guc-dynamic-library-path">.<indexterm><primary>dynamic_library_path</></> </para> </listitem> |