diff options
| author | Bruce Momjian <bruce@momjian.us> | 2003-01-19 00:13:31 +0000 |
|---|---|---|
| committer | Bruce Momjian <bruce@momjian.us> | 2003-01-19 00:13:31 +0000 |
| commit | be2b660ecd5ca205570825633e7b8479379ddc64 (patch) | |
| tree | 8b229de93c4810a7f1cdd6b29099316abc05c2d7 /doc/src/sgml/ref | |
| parent | 2042daf5c3f54f338c8a332e7314c23bff5d0c36 (diff) | |
| download | postgresql-be2b660ecd5ca205570825633e7b8479379ddc64.tar.gz | |
This patch includes a lot of minor cleanups to the SGML documentation,
including:
- replacing all the appropriate usages of <citetitle>PostgreSQL
...</citetitle> with &cite-user;, &cite-admin;, and so on
- fix an omission in the EXECUTE documentation
- add some more text to the EXPLAIN documentation
- improve the PL/PgSQL RETURN NEXT documentation (more work to do here)
- minor markup fixes
Neil Conway
Diffstat (limited to 'doc/src/sgml/ref')
43 files changed, 294 insertions, 235 deletions
diff --git a/doc/src/sgml/ref/alter_database.sgml b/doc/src/sgml/ref/alter_database.sgml index 76a4ac014a..2282b07a74 100644 --- a/doc/src/sgml/ref/alter_database.sgml +++ b/doc/src/sgml/ref/alter_database.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.3 2002/05/17 01:19:16 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.4 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -71,8 +71,8 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET <replacea <para> See <xref linkend="sql-set" endterm="sql-set-title"> and the - <citetitle>Administrator's Guide</citetitle> for more - information about allowed variable names and values. + &cite-admin; for more information about allowed variable names + and values. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_table.sgml index a8cbfb5bc6..2287a72cb6 100644 --- a/doc/src/sgml/ref/alter_table.sgml +++ b/doc/src/sgml/ref/alter_table.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.53 2002/12/16 19:08:25 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.54 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -399,9 +399,8 @@ VACUUM FULL table; <para> Refer to <command>CREATE TABLE</command> for a further description - of valid arguments. - The <citetitle>PostgreSQL User's Guide</citetitle> has further - information on inheritance. + of valid arguments. The &cite-user; has further information on + inheritance. </para> </refsect2> </refsect1> diff --git a/doc/src/sgml/ref/alter_user.sgml b/doc/src/sgml/ref/alter_user.sgml index 345379cd3a..e6c5ac54d7 100644 --- a/doc/src/sgml/ref/alter_user.sgml +++ b/doc/src/sgml/ref/alter_user.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.23 2002/09/21 18:32:54 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.24 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -145,8 +145,8 @@ ALTER USER <replaceable class="PARAMETER">username</replaceable> RESET <replacea <para> See <xref linkend="sql-set" endterm="sql-set-title"> and the - <citetitle>Administrator's Guide</citetitle> for more - information about allowed variable names and values. + &cite-admin; for more information about allowed variable names + and values. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/analyze.sgml b/doc/src/sgml/ref/analyze.sgml index 72dc5cdcde..03b026e521 100644 --- a/doc/src/sgml/ref/analyze.sgml +++ b/doc/src/sgml/ref/analyze.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.9 2002/07/31 17:19:51 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.10 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -152,8 +152,7 @@ ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<rep <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 the <citetitle>User's - Guide</citetitle>. + information about the statistics in the &cite-user;. </para> <para> diff --git a/doc/src/sgml/ref/begin.sgml b/doc/src/sgml/ref/begin.sgml index 6a02672e7d..d8d28389e8 100644 --- a/doc/src/sgml/ref/begin.sgml +++ b/doc/src/sgml/ref/begin.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.20 2002/09/21 18:32:54 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.21 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -121,8 +121,7 @@ WARNING: BEGIN: already a transaction in progress <command>SET TRANSACTION ISOLATION LEVEL SERIALIZABLE</command> just after <command>BEGIN</command> if you need more rigorous transaction isolation. (Alternatively, you can change the default transaction - isolation level; see the <citetitle>PostgreSQL Administrator's - Guide</citetitle> for details.) + isolation level; see the &cite-admin; for details.) In SERIALIZABLE mode queries will see only changes committed before the entire transaction began (actually, before execution of the first <acronym>DML</> statement @@ -161,7 +160,7 @@ WARNING: BEGIN: already a transaction in progress </para> <para> - If you turn <literal>autocommit</> mode off, then <command>BEGIN</> + If you turn <varname>autocommit</> mode off, then <command>BEGIN</> is not required: any SQL command automatically starts a transaction. </para> </refsect2> diff --git a/doc/src/sgml/ref/checkpoint.sgml b/doc/src/sgml/ref/checkpoint.sgml index 2ac485f4c4..9023b89998 100644 --- a/doc/src/sgml/ref/checkpoint.sgml +++ b/doc/src/sgml/ref/checkpoint.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.6 2002/04/21 19:02:39 thomas Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.7 2003/01/19 00:13:29 momjian Exp $ --> <refentry id="sql-checkpoint"> <refmeta> @@ -34,8 +34,7 @@ CHECKPOINT A checkpoint is a point in the transaction log sequence at which all data files have been updated to reflect the information in the log. All data files will be flushed to disk. Refer to the - <citetitle>PostgreSQL Administrator's Guide</citetitle> for more - information about the WAL system. + &cite-admin; for more information about the WAL system. </para> <para> @@ -48,7 +47,7 @@ CHECKPOINT <title>See Also</title> <para> - <citetitle>PostgreSQL Administrator's Guide</citetitle> + &cite-admin; </para> </refsect1> @@ -61,3 +60,20 @@ CHECKPOINT </para> </refsect1> </refentry> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:nil +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../reference.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:"/usr/lib/sgml/catalog" +sgml-local-ecat-files:nil +End: +--> diff --git a/doc/src/sgml/ref/create_aggregate.sgml b/doc/src/sgml/ref/create_aggregate.sgml index 9024152fb3..c5ae96850c 100644 --- a/doc/src/sgml/ref/create_aggregate.sgml +++ b/doc/src/sgml/ref/create_aggregate.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_aggregate.sgml,v 1.22 2002/10/21 04:33:39 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_aggregate.sgml,v 1.23 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -271,9 +271,8 @@ CREATE AGGREGATE Usage </title> <para> - Refer to the chapter on aggregate functions - in the <citetitle>PostgreSQL Programmer's Guide</citetitle> for - complete examples of usage. + Refer to the chapter on aggregate functions in the + &cite-programmer; for complete examples of usage. </para> </refsect1> diff --git a/doc/src/sgml/ref/create_cast.sgml b/doc/src/sgml/ref/create_cast.sgml index 98ed9c3a88..74c4532828 100644 --- a/doc/src/sgml/ref/create_cast.sgml +++ b/doc/src/sgml/ref/create_cast.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_cast.sgml,v 1.7 2002/11/15 03:11:17 momjian Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_cast.sgml,v 1.8 2003/01/19 00:13:29 momjian Exp $ --> <refentry id="SQL-CREATECAST"> <refmeta> @@ -241,7 +241,7 @@ CREATE CAST (text AS int4) WITH FUNCTION int4(text); <xref linkend="sql-createfunction" endterm="sql-createfunction-title">, <xref linkend="sql-createtype" endterm="sql-createtype-title">, <xref linkend="sql-dropcast" endterm="sql-dropcast-title">, - <citetitle>PostgreSQL Programmer's Guide</citetitle> + &cite-programmer; </para> </refsect1> diff --git a/doc/src/sgml/ref/create_conversion.sgml b/doc/src/sgml/ref/create_conversion.sgml index bf8ec00ff7..1ced20a3d1 100644 --- a/doc/src/sgml/ref/create_conversion.sgml +++ b/doc/src/sgml/ref/create_conversion.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_conversion.sgml,v 1.5 2002/11/02 02:33:03 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_conversion.sgml,v 1.6 2003/01/19 00:13:29 momjian Exp $ --> <refentry id="SQL-CREATECONVERSION"> <refmeta> @@ -158,7 +158,7 @@ CREATE CONVERSION myconv FOR 'UNICODE' TO 'LATIN1' FROM myfunc; <para> <xref linkend="sql-createfunction" endterm="sql-createfunction-title">, <xref linkend="sql-dropconversion" endterm="sql-dropconversion-title">, - <citetitle>PostgreSQL Programmer's Guide</citetitle> + &cite-programmer; </para> </refsect1> diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml index f419a12966..c893a47e7d 100644 --- a/doc/src/sgml/ref/create_database.sgml +++ b/doc/src/sgml/ref/create_database.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.30 2002/11/15 03:11:17 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.31 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -281,7 +281,7 @@ comment from Olly; response from Thomas... by specifying its name as the template, this is not (yet) intended as a general-purpose COPY DATABASE facility. We recommend that databases used as templates be treated as read-only. - See the <citetitle>Administrator's Guide</> for more information. + See the &cite-admin; for more information. </para> </refsect2> </refsect1> diff --git a/doc/src/sgml/ref/create_domain.sgml b/doc/src/sgml/ref/create_domain.sgml index 0d44434b3e..01d5870a8b 100644 --- a/doc/src/sgml/ref/create_domain.sgml +++ b/doc/src/sgml/ref/create_domain.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_domain.sgml,v 1.9 2002/12/12 20:35:07 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_domain.sgml,v 1.10 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -58,7 +58,7 @@ where <replaceable class="PARAMETER">constraint</replaceable> is: <para> The underlying data type of the domain. This may include array specifiers. - Refer to the <citetitle>User's Guide</citetitle> for further + Refer to the &cite-user; for further information about data types and arrays. </para> </listitem> @@ -224,7 +224,7 @@ CREATE TABLE countrylist (id INT4, country country_code); <simplelist type="inline"> <member><xref linkend="sql-dropdomain" endterm="sql-dropdomain-title"></member> - <member><citetitle>PostgreSQL Programmer's Guide</citetitle></member> + <member>&cite-programmer;</member> </simplelist> </refsect1> diff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml index 6c737f2614..71c09e6ef5 100644 --- a/doc/src/sgml/ref/create_function.sgml +++ b/doc/src/sgml/ref/create_function.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.43 2002/09/21 18:32:54 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.44 2003/01/19 00:13:29 momjian Exp $ --> <refentry id="SQL-CREATEFUNCTION"> @@ -281,8 +281,7 @@ CREATE [ OR REPLACE ] FUNCTION <replaceable class="parameter">name</replaceable> <title>Notes</title> <para> - Refer to the chapter in the - <citetitle>PostgreSQL Programmer's Guide</citetitle> + Refer to the chapter in the &cite-programmer; on the topic of extending <productname>PostgreSQL</productname> via functions for further information on writing external functions. @@ -470,7 +469,7 @@ Point * complex_to_point (Complex *z) <xref linkend="sql-load" endterm="sql-load-title">, <xref linkend="sql-revoke" endterm="sql-revoke-title">, <xref linkend="app-createlang">, - <citetitle>PostgreSQL Programmer's Guide</citetitle> + &cite-programmer; </para> </refsect1> diff --git a/doc/src/sgml/ref/create_group.sgml b/doc/src/sgml/ref/create_group.sgml index 7992756cb4..539e2c6054 100644 --- a/doc/src/sgml/ref/create_group.sgml +++ b/doc/src/sgml/ref/create_group.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_group.sgml,v 1.8 2002/04/21 19:02:39 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_group.sgml,v 1.9 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -107,10 +107,10 @@ where <replaceable class="PARAMETER">option</replaceable> can be: Description </title> <para> - CREATE GROUP will create a new group in the database installation. - Refer to the <citetitle>Administrator's Guide</citetitle> for information about using groups - for authentication. - You must be a database superuser to use this command. + <command>CREATE GROUP</command> will create a new group in the + database installation. Refer to the &cite-admin; for information + about using groups for authentication. You must be a database + superuser to use this command. </para> <para> Use <xref linkend="SQL-ALTERGROUP" endterm="SQL-ALTERGROUP-title"> diff --git a/doc/src/sgml/ref/create_language.sgml b/doc/src/sgml/ref/create_language.sgml index ddf27fd4d7..ffb615ae5d 100644 --- a/doc/src/sgml/ref/create_language.sgml +++ b/doc/src/sgml/ref/create_language.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.29 2002/11/21 23:34:43 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.30 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -37,9 +37,8 @@ CREATE [ TRUSTED ] [ PROCEDURAL ] LANGUAGE <replaceable class="parameter">langna <para> <command>CREATE LANGUAGE</command> effectively associates the language name with a call handler that is responsible for executing - functions written in the language. Refer to the - <citetitle>Programmer's Guide</citetitle> for more information - about language call handlers. + functions written in the language. Refer to the &cite-programmer; + for more information about language call handlers. </para> <para> @@ -301,7 +300,7 @@ CREATE LANGUAGE plsample <member><xref linkend="sql-droplanguage" endterm="sql-droplanguage-title"></member> <member><xref linkend="sql-grant" endterm="sql-grant-title"></member> <member><xref linkend="sql-revoke" endterm="sql-revoke-title"></member> - <member><citetitle>PostgreSQL Programmer's Guide</citetitle></member> + <member>&cite-programmer;</member> </simplelist> </para> </refsect1> diff --git a/doc/src/sgml/ref/create_opclass.sgml b/doc/src/sgml/ref/create_opclass.sgml index 48f21435da..04d2c2d2f9 100644 --- a/doc/src/sgml/ref/create_opclass.sgml +++ b/doc/src/sgml/ref/create_opclass.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_opclass.sgml,v 1.4 2002/10/04 22:19:29 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_opclass.sgml,v 1.5 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -224,8 +224,7 @@ CREATE OPERATOR CLASS <para> Refer to the chapter on interfacing extensions to indexes in the - <citetitle>PostgreSQL Programmer's Guide</citetitle> - for further information. + &cite-programmer; for further information. </para> <refsect2 id="R2-SQL-CREATEOPCLASS-3"> diff --git a/doc/src/sgml/ref/create_operator.sgml b/doc/src/sgml/ref/create_operator.sgml index da54771828..69c8a42033 100644 --- a/doc/src/sgml/ref/create_operator.sgml +++ b/doc/src/sgml/ref/create_operator.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.32 2002/09/21 18:32:54 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.33 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -436,8 +436,7 @@ MYBOXES.description === box '((0,0), (1,1))' Notes </title> <para> - Refer to the chapter on operators in the - <citetitle>PostgreSQL User's Guide</citetitle> + Refer to the chapter on operators in the &cite-user; for further information. Refer to <command>DROP OPERATOR</command> to delete user-defined operators from a database. diff --git a/doc/src/sgml/ref/create_sequence.sgml b/doc/src/sgml/ref/create_sequence.sgml index 4e36dfbe77..a357e434e3 100644 --- a/doc/src/sgml/ref/create_sequence.sgml +++ b/doc/src/sgml/ref/create_sequence.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_sequence.sgml,v 1.29 2002/11/10 00:10:20 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_sequence.sgml,v 1.30 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -256,7 +256,7 @@ ERROR: DefineSequence: MINVALUE (<replaceable class="parameter">min</replaceabl <function>currval</function> and <function>setval</function> to operate on the sequence. These functions are documented in - the <citetitle>User's Guide</citetitle>. + the &cite-user;. </para> <para> diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml index db51a26469..3439c73115 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.60 2002/12/16 19:08:25 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.61 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -147,8 +147,8 @@ and <replaceable class="PARAMETER">table_constraint</replaceable> is: <listitem> <para> The data type of the column. This may include array specifiers. - Refer to the <citetitle>User's Guide</citetitle> for further - information about data types and arrays. + Refer to the &cite-user; for further information about data + types and arrays. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/create_trigger.sgml b/doc/src/sgml/ref/create_trigger.sgml index 2917050b78..0c69b90da8 100644 --- a/doc/src/sgml/ref/create_trigger.sgml +++ b/doc/src/sgml/ref/create_trigger.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_trigger.sgml,v 1.31 2002/12/17 17:41:30 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_trigger.sgml,v 1.32 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -202,9 +202,8 @@ CREATE TRIGGER </para> <para> - Refer to the chapters on SPI and Triggers in the - <citetitle>PostgreSQL Programmer's Guide</citetitle> for more - information. + Refer to the chapters on SPI and Triggers in the &cite-programmer; + for more information. </para> </refsect1> @@ -349,7 +348,7 @@ CREATE TABLE distributors ( <member><xref linkend="sql-createfunction" endterm="sql-createfunction-title"></member> <member><xref linkend="sql-altertrigger" endterm="sql-altertrigger-title"></member> <member><xref linkend="sql-droptrigger" endterm="sql-droptrigger-title"></member> - <member><citetitle>PostgreSQL Programmer's Guide</citetitle></member> + <member>&cite-programmer;</member> </simplelist> </refsect1> </refentry> diff --git a/doc/src/sgml/ref/create_type.sgml b/doc/src/sgml/ref/create_type.sgml index da22aa8696..651409b245 100644 --- a/doc/src/sgml/ref/create_type.sgml +++ b/doc/src/sgml/ref/create_type.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.37 2002/11/21 23:34:43 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.38 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -468,7 +468,7 @@ CREATE FUNCTION getfoo() RETURNS SETOF compfoo AS 'SELECT fooid, fooname FROM fo <simplelist type="inline"> <member><xref linkend="sql-createfunction" endterm="sql-createfunction-title"></member> <member><xref linkend="sql-droptype" endterm="sql-droptype-title"></member> - <member><citetitle>PostgreSQL Programmer's Guide</citetitle></member> + <member>&cite-programmer;</member> </simplelist> </refsect1> diff --git a/doc/src/sgml/ref/create_user.sgml b/doc/src/sgml/ref/create_user.sgml index 04a596ef74..856abbf830 100644 --- a/doc/src/sgml/ref/create_user.sgml +++ b/doc/src/sgml/ref/create_user.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_user.sgml,v 1.23 2002/02/27 21:14:53 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_user.sgml,v 1.24 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -34,10 +34,9 @@ where <replaceable class="PARAMETER">option</replaceable> can be: <para> <command>CREATE USER</command> will add a new user to an instance - of <productname>PostgreSQL</productname>. Refer to the - <citetitle>Administrator's Guide</citetitle> for information about - managing users and authentication. You must be a database - superuser to use this command. + of <productname>PostgreSQL</productname>. Refer to the &cite-admin; + for information about managing users and authentication. You must + be a database superuser to use this command. </para> <refsect2> @@ -102,12 +101,11 @@ where <replaceable class="PARAMETER">option</replaceable> can be: </para> <para> - See the chapter on client authentication in the - <citetitle>Administrator's Guide</citetitle> for details on - how to set up authentication mechanisms. Note that older - clients may lack support for the MD5 authentication mechanism - that is needed to work with passwords that are stored - encrypted. + See the chapter on client authentication in the &cite-admin; + for details on how to set up authentication mechanisms. Note + that older clients may lack support for the MD5 authentication + mechanism that is needed to work with passwords that are + stored encrypted. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/drop_aggregate.sgml b/doc/src/sgml/ref/drop_aggregate.sgml index 9913e5d8ed..fb95a3c605 100644 --- a/doc/src/sgml/ref/drop_aggregate.sgml +++ b/doc/src/sgml/ref/drop_aggregate.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.19 2002/07/12 18:43:12 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.20 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -47,10 +47,7 @@ DROP AGGREGATE <replaceable class="PARAMETER">name</replaceable> ( <replaceable <para> The input data type of the aggregate function, or <literal>*</literal> if the function accepts any input type. - (Refer to the <citetitle>PostgreSQL User's Guide</citetitle> for - further information about data types.) - <comment>This should become a cross-reference rather than a - hard-coded chapter number</comment> + (Refer to the &cite-user; for further information about data types.) </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/ecpg-ref.sgml b/doc/src/sgml/ref/ecpg-ref.sgml index 2a5f0f6ac6..a38d731b94 100644 --- a/doc/src/sgml/ref/ecpg-ref.sgml +++ b/doc/src/sgml/ref/ecpg-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.23 2002/11/15 03:11:18 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.24 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -49,7 +49,7 @@ PostgreSQL documentation <para> This reference page does not describe the embedded SQL language. - See the &cite-programmer; for that. + See the &cite-programmer; for more information on that topic. </para> </refsect1> @@ -196,8 +196,8 @@ cc -o prog1 prog1.o -L/usr/local/pgsql/lib -lecpg <title>See Also</title> <para> - <citetitle>PostgreSQL Programmer's Guide</citetitle> for a more - detailed description of the embedded SQL interface + &cite-programmer; for a more detailed description of the embedded + SQL interface </para> </refsect1> diff --git a/doc/src/sgml/ref/execute.sgml b/doc/src/sgml/ref/execute.sgml index 67035572e7..2302ef99a3 100644 --- a/doc/src/sgml/ref/execute.sgml +++ b/doc/src/sgml/ref/execute.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/execute.sgml,v 1.1 2002/08/27 04:55:07 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/execute.sgml,v 1.2 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -21,7 +21,7 @@ PostgreSQL documentation <date>2002-08-12</date> </refsynopsisdivinfo> <synopsis> - EXECUTE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable class="PARAMETER">parameter</replaceable> [, ...] ) ] + EXECUTE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable class="PARAMETER">parameter</replaceable> [, ...] ) ] [ INTO [ TEMPORARY | TEMP ] <replaceable class="PARAMETER">table</replaceable> ] </synopsis> <refsect2 id="R2-SQL-EXECUTE-1"> @@ -42,16 +42,28 @@ PostgreSQL documentation </para> </listitem> </varlistentry> + <varlistentry> <term><replaceable class="PARAMETER">parameter</replaceable></term> <listitem> <para> - The actual value of a parameter to the prepared query. - This must be an expression yielding a value of a type - compatible with - the data-type specified for this parameter position in the - <command>PREPARE</command> statement that created the prepared - query. + The actual value of a parameter to the prepared query. This + must be an expression yielding a value of a type compatible + with the data-type specified for this parameter position in + the <command>PREPARE</command> statement that created the + prepared query. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="PARAMETER">table</replaceable></term> + <listitem> + <para> + The name of the table in which to store the results of + executing the query (if it is a <command>SELECT</command>). If + no table is specified, the results are returned to the client + (as normal). </para> </listitem> </varlistentry> @@ -86,6 +98,13 @@ PostgreSQL documentation </para> <para> + Like <command>SELECT INTO</command>, <command>EXECUTE</command> can + be used to store the results of executing the query in a table by + specifying an INTO clause. For more information on this behabior, + consult the reference for <xref linkend="sql-selectinto">. + </para> + + <para> For more information on the creation and usage of prepared queries, see <xref linkend="sql-prepare" endterm="sql-prepare-title">. </para> diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index cd9e1fba35..7e7f43f50e 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.21 2002/11/15 03:11:18 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.22 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -87,9 +87,10 @@ EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="PARAMETER">query</replaceabl <note> <para> - Prior to <productname>PostgreSQL</productname> 7.3, the query plan - was emitted in the form of a NOTICE message. Now it appears as a - query result (formatted like a table with a single text column). + Prior to <productname>PostgreSQL</productname> 7.3, the query + plan was emitted in the form of a <literal>NOTICE</literal> + message. Now it appears as a query result (formatted like a + table with a single text column). </para> </note> </refsect2> @@ -127,12 +128,26 @@ EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="PARAMETER">query</replaceabl costs to estimate which plan is really the cheapest. </para> + <note> + <para> + In order to allow the <productname>PostgreSQL</productname> query + planner to make reasonably informed decisions when optimizing + queries, the <command>ANALYZE</command> statement should be used + to record statistics about the distribution of data within the + table. If you have not done this (or the statistical distribution + of the data in the table has changed significantly since the last + time <command>ANALYZE</command> was run), the estimated costs and + the resulting query plan displayed by <command>EXPLAIN</command> + are unlikely to conform to the real properties of the query. + </para> + </note> + <para> The ANALYZE option causes the query to be actually executed, not only planned. The total elapsed time expended within each plan node (in milliseconds) and total number of rows it actually returned are added to the display. This is useful for seeing whether the planner's estimates - are close to reality. + are close to the actual performance of the query. </para> <caution> @@ -171,8 +186,7 @@ ROLLBACK; <para> There is only sparse documentation on the optimizer's use of cost information in <productname>PostgreSQL</productname>. - Refer to the <citetitle>User's Guide</citetitle> and - <citetitle>Programmer's Guide</citetitle> for more information. + Refer to the &cite-user; and &cite-programmer; for more information. </para> </refsect2> </refsect1> @@ -233,7 +247,12 @@ EXPLAIN SELECT sum(i) FROM foo WHERE i < 10; <para> Note that the specific numbers shown, and even the selected query strategy, may vary between <productname>PostgreSQL</productname> - releases due to planner improvements. + releases due to planner improvements. In addition, the algorithm + used by <command>ANALYZE</command> to generate statistics is not + completely deterministic; therefore, it is possible (although not + likely) for cost estimations to change between runs of + <command>ANALYZE</command>, even if the actual distribution of data + in the table has not changed. </para> </refsect1> diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index b6565d0f2f..7d63df874d 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.23 2002/10/11 23:03:48 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.24 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -253,7 +253,7 @@ PostgreSQL documentation <simplelist type="inline"> <member><xref linkend="app-postgres"></member> <member><xref linkend="app-postmaster"></member> - <member><citetitle>PostgreSQL Administrator's Guide</citetitle></member> + <member>&cite-admin;</member> </simplelist> </refsect1> diff --git a/doc/src/sgml/ref/initlocation.sgml b/doc/src/sgml/ref/initlocation.sgml index b89acd8838..01c018a3b4 100644 --- a/doc/src/sgml/ref/initlocation.sgml +++ b/doc/src/sgml/ref/initlocation.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.17 2002/10/11 23:03:48 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.18 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -69,7 +69,7 @@ PostgreSQL documentation <title>See Also</title> <simplelist type="inline"> - <member><citetitle>PostgreSQL Administrator's Guide</citetitle></member> + <member>&cite-admin;</member> </simplelist> </refsect1> diff --git a/doc/src/sgml/ref/insert.sgml b/doc/src/sgml/ref/insert.sgml index 054570c9ce..eeac298fb6 100644 --- a/doc/src/sgml/ref/insert.sgml +++ b/doc/src/sgml/ref/insert.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/insert.sgml,v 1.19 2002/09/21 18:32:54 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/insert.sgml,v 1.20 2003/01/19 00:13:29 momjian Exp $ PostgreSQL documentation --> @@ -216,8 +216,7 @@ INSERT INTO films SELECT * FROM tmp; </para> <para> - Insert into arrays (refer to the - <citetitle>PostgreSQL User's Guide</citetitle> for further + Insert into arrays (refer to the &cite-user; for further information about arrays): <programlisting> diff --git a/doc/src/sgml/ref/load.sgml b/doc/src/sgml/ref/load.sgml index 1c5d871d89..895f071e16 100644 --- a/doc/src/sgml/ref/load.sgml +++ b/doc/src/sgml/ref/load.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.14 2002/11/21 23:34:43 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.15 2003/01/19 00:13:29 momjian Exp $ --> <refentry id="SQL-LOAD"> @@ -37,8 +37,8 @@ LOAD '<replaceable class="PARAMETER">filename</replaceable>' The file name is specified in the same way as for shared library names in <xref linkend="sql-createfunction" endterm="sql-createfunction-title">; in particular, one may rely on a search path and automatic addition of the system's standard - shared library file name extension. See the - <citetitle>Programmer's Guide</citetitle> for more detail. + shared library file name extension. See the &cite-programmer; for + more information on this topic. </para> </refsect1> @@ -57,7 +57,7 @@ LOAD '<replaceable class="PARAMETER">filename</replaceable>' <para> <xref linkend="sql-createfunction" endterm="sql-createfunction-title">, - <citetitle>PostgreSQL Programmer's Guide</citetitle> + &cite-programmer; </para> </refsect1> </refentry> diff --git a/doc/src/sgml/ref/pg_config-ref.sgml b/doc/src/sgml/ref/pg_config-ref.sgml index e9adeb2c5e..9b26e2f527 100644 --- a/doc/src/sgml/ref/pg_config-ref.sgml +++ b/doc/src/sgml/ref/pg_config-ref.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.12 2002/11/15 03:11:18 momjian Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.13 2003/01/19 00:13:29 momjian Exp $ --> <refentry id="app-pgconfig"> <refmeta> @@ -160,7 +160,24 @@ <title>See Also</title> <para> - <citetitle>PostgreSQL Programmer's Guide</citetitle> + &cite-programmer; </para> </refsect1> </refentry> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:nil +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../reference.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:"/usr/lib/sgml/catalog" +sgml-local-ecat-files:nil +End: +--> diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml index 1c5c842513..1ce8cfc9f2 100644 --- a/doc/src/sgml/ref/pg_ctl-ref.sgml +++ b/doc/src/sgml/ref/pg_ctl-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.17 2002/10/11 23:03:48 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.18 2003/01/19 00:13:30 momjian Exp $ PostgreSQL documentation --> @@ -368,7 +368,7 @@ Command line was: <title>See Also</title> <para> - <xref linkend="app-postmaster">, <citetitle>PostgreSQL Administrator's Guide</citetitle> + <xref linkend="app-postmaster">, &cite-admin; </para> </refsect1> diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 66a2e00073..072237589d 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.54 2003/01/06 18:53:24 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.55 2003/01/19 00:13:30 momjian Exp $ PostgreSQL documentation --> @@ -705,7 +705,7 @@ CREATE DATABASE foo WITH TEMPLATE template0; <member><xref linkend="app-pg-dumpall"></member> <member><xref linkend="app-pgrestore"></member> <member><xref linkend="app-psql"></member> - <member><citetitle>PostgreSQL Administrator's Guide</citetitle></member> + <member>&cite-admin;</member> </simplelist> </refsect1> diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index 9430ec580a..be76f55a36 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.34 2003/01/06 18:53:24 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.35 2003/01/19 00:13:31 momjian Exp $ --> <refentry id="APP-PGRESTORE"> <docinfo> @@ -697,7 +697,7 @@ CREATE DATABASE foo WITH TEMPLATE = template0; <member><xref linkend="app-pgdump"></member> <member><xref linkend="app-pg-dumpall"></member> <member><xref linkend="app-psql"></member> - <member><citetitle>PostgreSQL Administrator's Guide</citetitle></member> + <member>&cite-admin;</member> </simplelist> </refsect1> </refentry> diff --git a/doc/src/sgml/ref/pgtclsh.sgml b/doc/src/sgml/ref/pgtclsh.sgml index 4b8546fbc1..21ac402ff3 100644 --- a/doc/src/sgml/ref/pgtclsh.sgml +++ b/doc/src/sgml/ref/pgtclsh.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtclsh.sgml,v 1.5 2002/04/21 19:02:39 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtclsh.sgml,v 1.6 2003/01/19 00:13:31 momjian Exp $ PostgreSQL documentation --> @@ -55,7 +55,7 @@ PostgreSQL documentation <simplelist type="inline"> <member><xref linkend="app-pgtksh"></member> <member> - <citetitle>PostgreSQL Programmer's Guide</citetitle> (description of <filename>libpgtcl</filename>) + &cite-programmer; (description of <filename>libpgtcl</filename>) </member> <member> <citerefentry><refentrytitle>tclsh</refentrytitle> <manvolnum>1</manvolnum></citerefentry> diff --git a/doc/src/sgml/ref/pgtksh.sgml b/doc/src/sgml/ref/pgtksh.sgml index af8f483cb4..b068925978 100644 --- a/doc/src/sgml/ref/pgtksh.sgml +++ b/doc/src/sgml/ref/pgtksh.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.5 2002/04/21 19:02:39 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.6 2003/01/19 00:13:31 momjian Exp $ PostgreSQL documentation --> @@ -55,7 +55,7 @@ PostgreSQL documentation <simplelist type="inline"> <member><xref linkend="app-pgtclsh"></member> <member> - <citetitle>PostgreSQL Programmer's Guide</citetitle> (description of <filename>libpgtcl</filename>) + &cite-programmer; (description of <filename>libpgtcl</filename>) </member> <member> <citerefentry><refentrytitle>tclsh</refentrytitle> <manvolnum>1</manvolnum></citerefentry> diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index fa9f29462c..7b282eb295 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.29 2002/10/23 23:33:08 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.30 2003/01/19 00:13:31 momjian Exp $ PostgreSQL documentation --> @@ -123,11 +123,11 @@ PostgreSQL documentation <para> You can avoid having to type these options by setting up a - configuration file. See the <citetitle>Administrator's - Guide</citetitle> for details. Some (safe) options can also be - set from the connecting client in an application-dependent way. - For example, if the environment variable <envar>PGOPTIONS</envar> - is set, then <application>libpq</>-based clients will pass that string to the + configuration file. See the &cite-admin; for details. Some + (safe) options can also be set from the connecting client in an + application-dependent way. For example, if the environment + variable <envar>PGOPTIONS</envar> is set, then + <application>libpq</>-based clients will pass that string to the server, which will interpret it as <application>postgres</application> command-line options. </para> @@ -153,8 +153,7 @@ PostgreSQL documentation means that the <quote>day before month</quote> (rather than month before day) rule is used to interpret ambiguous date input, and that the day is printed before the month in certain - date output formats. See the <citetitle>PostgreSQL User's - Guide</citetitle> for more information. + date output formats. See the &cite-user; for more information. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index fa2eec8312..e22c5b9d16 100644 --- a/doc/src/sgml/ref/postmaster.sgml +++ b/doc/src/sgml/ref/postmaster.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.33 2002/10/11 23:03:48 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.34 2003/01/19 00:13:31 momjian Exp $ PostgreSQL documentation --> @@ -80,9 +80,8 @@ PostgreSQL documentation <para> <application>postmaster</application> accepts the following command line arguments. For a detailed discussion of the options - consult the <citetitle>Administrator's Guide</citetitle>. You can - also save typing most of these options by setting up a - configuration file. + consult the &cite-admin;. You can also save typing most of these + options by setting up a configuration file. <variablelist> <varlistentry> @@ -111,11 +110,11 @@ PostgreSQL documentation <term>-c <replaceable>name</replaceable>=<replaceable>value</replaceable></term> <listitem> <para> - Sets a named run-time parameter. Consult the - <citetitle>Administrator's Guide</citetitle> for a list and - descriptions. Most of the other command line options are in - fact short forms of such a parameter assignment. <option>-c</> - can appear multiple times to set multiple parameters. + Sets a named run-time parameter. Consult the &cite-admin; for + a list and descriptions. Most of the other command line + options are in fact short forms of such a parameter + assignment. <option>-c</> can appear multiple times to set + multiple parameters. </para> </listitem> </varlistentry> @@ -219,9 +218,9 @@ PostgreSQL documentation default, this value is 32, but it can be set as high as your system will support. (Note that <option>-B</option> is required to be at least twice - <option>-N</option>. See the <citetitle>Administrator's - Guide</citetitle> for a discussion of system resource requirements - for large numbers of client connections.) + <option>-N</option>. See the &cite-admin; for a discussion of + system resource requirements for large numbers of client + connections.) </para> </listitem> </varlistentry> @@ -404,8 +403,8 @@ PostgreSQL documentation <listitem> <para> Other environment variables may be used to designate alternative - data storage locations. See the <citetitle>Administrator's - Guide</citetitle> for more information. + data storage locations. See the &cite-admin; for more + information. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/reset.sgml b/doc/src/sgml/ref/reset.sgml index ed36d549c5..9723413423 100644 --- a/doc/src/sgml/ref/reset.sgml +++ b/doc/src/sgml/ref/reset.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.17 2002/10/13 16:55:05 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.18 2003/01/19 00:13:31 momjian Exp $ PostgreSQL documentation --> @@ -64,7 +64,7 @@ SET <replaceable class="parameter">variable</replaceable> TO DEFAULT current session. The actual source of this value might be a compiled-in default, the postmaster's configuration file or command-line switches, or per-database or per-user default settings. See the - <citetitle>Administrator's Guide</citetitle> for details. + &cite-admin; for details. </para> <para> diff --git a/doc/src/sgml/ref/select.sgml b/doc/src/sgml/ref/select.sgml index 9ace534bc3..0f8a3dbcc9 100644 --- a/doc/src/sgml/ref/select.sgml +++ b/doc/src/sgml/ref/select.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/select.sgml,v 1.63 2002/10/24 21:19:15 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/select.sgml,v 1.64 2003/01/19 00:13:31 momjian Exp $ PostgreSQL documentation --> @@ -291,19 +291,17 @@ where <replaceable class="PARAMETER">from_item</replaceable> can be: </para> <para> - <command>DISTINCT</command> will eliminate duplicate rows from the - result. - <command>ALL</command> (the default) will return all candidate rows, - including duplicates. + DISTINCT will eliminate duplicate rows from the result. ALL (the + default) will return all candidate rows, including duplicates. </para> <para> - <command>DISTINCT ON</command> eliminates rows that match on all the + DISTINCT ON eliminates rows that match on all the specified expressions, keeping only the first row of each set of duplicates. The DISTINCT ON expressions are interpreted using the same rules as for ORDER BY items; see below. Note that the <quote>first row</quote> of each set is unpredictable - unless <command>ORDER BY</command> is used to ensure that the desired + unless ORDER BY is used to ensure that the desired row appears first. For example, <programlisting> SELECT DISTINCT ON (location) location, time, report @@ -336,9 +334,9 @@ where <replaceable class="PARAMETER">from_item</replaceable> can be: </para> <para> - SELECT queries can be combined using UNION, INTERSECT, and EXCEPT - operators. Use parentheses if necessary to determine the ordering - of these operators. + <command>SELECT</command> queries can be combined using UNION, + INTERSECT, and EXCEPT operators. Use parentheses if necessary to + determine the ordering of these operators. </para> <para> @@ -368,8 +366,8 @@ where <replaceable class="PARAMETER">from_item</replaceable> can be: </para> <para> - The FOR UPDATE clause causes the SELECT statement to lock the selected - rows against concurrent updates. + The FOR UPDATE clause causes the <command>SELECT</command> + statement to lock the selected rows against concurrent updates. </para> <para> @@ -387,11 +385,12 @@ where <replaceable class="PARAMETER">from_item</replaceable> can be: </title> <para> - The FROM clause specifies one or more source tables for the SELECT. - If multiple sources are specified, the result is conceptually the - Cartesian product of all the rows in all the sources --- but usually - qualification conditions are added to restrict the returned rows to - a small subset of the Cartesian product. + The FROM clause specifies one or more source tables for the + <command>SELECT</command>. If multiple sources are specified, the + result is conceptually the Cartesian product of all the rows in + all the sources --- but usually qualification conditions are added + to restrict the returned rows to a small subset of the Cartesian + product. </para> <para> @@ -407,10 +406,11 @@ where <replaceable class="PARAMETER">from_item</replaceable> can be: </para> <para> - A FROM item can also be a parenthesized sub-SELECT (note that an - alias clause is required for a sub-SELECT!). This is an extremely - handy feature since it's the only way to get multiple levels of - grouping, aggregation, or sorting in a single query. + A FROM item can also be a parenthesized + sub-<command>SELECT</command> (note that an alias clause is + required for a sub-<command>SELECT</command>!). This is an + extremely useful feature since it's the only way to get multiple + levels of grouping, aggregation, or sorting in a single query. </para> <para> @@ -542,23 +542,25 @@ GROUP BY <replaceable class="PARAMETER">expression</replaceable> [, ...] </para> <para> - GROUP BY will condense into a single row all selected rows that share the - same values for the grouped columns. Aggregate functions, if any, - are computed across all rows making up each group, producing a - separate value for each group (whereas without GROUP BY, an - aggregate produces a single value computed across all the selected - rows). When GROUP BY is present, it is not valid for the SELECT - output expression(s) to refer to + GROUP BY will condense into a single row all selected rows that + share the same values for the grouped columns. Aggregate + functions, if any, are computed across all rows making up each + group, producing a separate value for each group (whereas without + GROUP BY, an aggregate produces a single value computed across all + the selected rows). When GROUP BY is present, it is not valid for + the <command>SELECT</command> output expression(s) to refer to ungrouped columns except within aggregate functions, since there - would be more than one possible value to return for an ungrouped column. + would be more than one possible value to return for an ungrouped + column. </para> <para> - A GROUP BY item can be an input column name, or the name or ordinal - number of an output column (SELECT expression), or it can be an arbitrary - expression formed from input-column values. In case of ambiguity, a GROUP - BY name will - be interpreted as an input-column name rather than an output column name. + A GROUP BY item can be an input column name, or the name or + ordinal number of an output column (<command>SELECT</command> + expression), or it can be an arbitrary expression formed from + input-column values. In case of ambiguity, a GROUP BY name will + be interpreted as an input-column name rather than an output + column name. </para> </refsect2> @@ -610,10 +612,11 @@ ORDER BY <replaceable class="PARAMETER">expression</replaceable> [ ASC | DESC | </synopsis></para> <para> - An ORDER BY item can be the name or ordinal - number of an output column (SELECT expression), or it can be an arbitrary - expression formed from input-column values. In case of ambiguity, an - ORDER BY name will be interpreted as an output-column name. + An ORDER BY item can be the name or ordinal number of an output + column (<command>SELECT</command> expression), or it can be an + arbitrary expression formed from input-column values. In case of + ambiguity, an ORDER BY name will be interpreted as an + output-column name. </para> <para> The ordinal number refers to the ordinal (left-to-right) position @@ -697,10 +700,10 @@ SELECT name FROM distributors ORDER BY code; <para> The UNION operator computes the collection (set union) of the rows - returned by the queries involved. - The two SELECT statements that represent the direct operands of the UNION must - produce the same number of columns, and corresponding columns must be - of compatible data types. + returned by the queries involved. The two + <command>SELECT</command> statements that represent the direct + operands of the UNION must produce the same number of columns, and + corresponding columns must be of compatible data types. </para> <para> @@ -710,8 +713,9 @@ SELECT name FROM distributors ORDER BY code; </para> <para> - Multiple UNION operators in the same SELECT statement are - evaluated left to right, unless otherwise indicated by parentheses. + Multiple UNION operators in the same <command>SELECT</command> + statement are evaluated left to right, unless otherwise indicated + by parentheses. </para> <para> @@ -864,22 +868,26 @@ SELECT name FROM distributors ORDER BY code; </para> <para> - FOR UPDATE causes the rows retrieved by the query to be locked as though - for update. This prevents them from being modified or deleted by other - transactions until the current transaction ends; that is, other - transactions that attempt UPDATE, DELETE, or SELECT FOR UPDATE of these - rows will be blocked until the current transaction ends. Also, if an - UPDATE, DELETE, or SELECT FOR UPDATE from another transaction has already - locked a selected row or rows, SELECT FOR UPDATE will wait for the other - transaction to complete, and will then lock and return the updated row - (or no row, if the row was deleted). For further discussion see the - concurrency chapter of the <citetitle>User's Guide</citetitle>. + FOR UPDATE causes the rows retrieved by the query to be locked as + though for update. This prevents them from being modified or + deleted by other transactions until the current transaction ends; + that is, other transactions that attempt + <command>UPDATE</command>, <command>DELETE</command>, or + <command>SELECT FOR UPDATE</command> of these rows will be blocked + until the current transaction ends. Also, if an + <command>UPDATE</command>, <command>DELETE</command>, or + <command>SELECT FOR UPDATE</command> from another transaction has + already locked a selected row or rows, <command>SELECT FOR + UPDATE</command> will wait for the other transaction to complete, + and will then lock and return the updated row (or no row, if the + row was deleted). For further discussion see the concurrency + chapter of the &cite-user;. </para> <para> - If specific tables are named in FOR UPDATE, then only rows coming from - those tables are locked; any other tables used in the SELECT are simply - read as usual. + If specific tables are named in FOR UPDATE, then only rows coming + from those tables are locked; any other tables used in the + <command>SELECT</command> are simply read as usual. </para> <para> @@ -1097,9 +1105,9 @@ SELECT 2+2; 4 </programlisting> -Some other SQL databases cannot do this except by introducing a dummy one-row -table to do the select from. A less obvious use is to abbreviate a -normal select from one or more tables: +Some other <acronym>SQL</acronym> databases cannot do this except by +introducing a dummy one-row table to do the select from. A less +obvious use is to abbreviate a normal select from one or more tables: <programlisting> SELECT distributors.* WHERE distributors.name = 'Westward'; diff --git a/doc/src/sgml/ref/set.sgml b/doc/src/sgml/ref/set.sgml index f8f08f761a..abf913614d 100644 --- a/doc/src/sgml/ref/set.sgml +++ b/doc/src/sgml/ref/set.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/set.sgml,v 1.71 2003/01/12 01:33:00 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/set.sgml,v 1.72 2003/01/19 00:13:31 momjian Exp $ PostgreSQL documentation --> @@ -80,11 +80,11 @@ SET [ SESSION | LOCAL ] TIME ZONE { <replaceable class="PARAMETER">timezone</rep <para> The <command>SET</command> command changes run-time configuration parameters. Many of the run-time parameters listed in the - <citetitle>Administrator's Guide</citetitle> can be changed on-the-fly - with <command>SET</command>. (But some require superuser privileges - to change, and others cannot be changed after server or session start.) - Note that <command>SET</command> only affects the value used by the - current session. + &cite-admin; can be changed on-the-fly with <command>SET</command>. + (But some require superuser privileges to change, and others cannot + be changed after server or session start.) Note that + <command>SET</command> only affects the value used by the current + session. </para> <para> @@ -109,10 +109,9 @@ SET [ SESSION | LOCAL ] TIME ZONE { <replaceable class="PARAMETER">timezone</rep </para> <para> - Even with <literal>autocommit</> set to <literal>off</>, <command>SET</> + Even with <varname>autocommit</> set to <literal>off</>, <command>SET</> does not start a new transaction block. See the - <literal>autocommit</> section of the <citetitle>Administrator's - Guide</citetitle> for details. + <varname>autocommit</> section of the &cite-admin; for details. </para> <para> @@ -517,8 +516,8 @@ SELECT CURRENT_TIMESTAMP AS today; <para> The function <function>set_config</function> provides the equivalent - capability. See <citetitle>Miscellaneous Functions</citetitle> in the - <citetitle>PostgreSQL User's Guide</citetitle>. + capability. See <citetitle>Miscellaneous Functions</citetitle> in + the &cite-user;. </para> </refsect1> </refentry> diff --git a/doc/src/sgml/ref/set_transaction.sgml b/doc/src/sgml/ref/set_transaction.sgml index 72e62ad3cb..d88274d3ad 100644 --- a/doc/src/sgml/ref/set_transaction.sgml +++ b/doc/src/sgml/ref/set_transaction.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_transaction.sgml,v 1.11 2003/01/11 00:00:03 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_transaction.sgml,v 1.12 2003/01/19 00:13:31 momjian Exp $ --> <refentry id="SQL-SET-TRANSACTION"> <docinfo> <date>2000-11-24</date> @@ -109,9 +109,8 @@ SET SESSION CHARACTERISTICS AS TRANSACTION <programlisting> SET default_transaction_isolation = '<replaceable>value</replaceable>' </programlisting> - and in the - configuration file. Consult the <citetitle>Administrator's - Guide</citetitle> for more information. + and in the configuration file. Consult the &cite-admin; for more + information. </para> </refsect1> @@ -127,8 +126,7 @@ SET default_transaction_isolation = '<replaceable>value</replaceable>' not provide the isolation levels <option>READ UNCOMMITTED</option> and <option>REPEATABLE READ</option>. Because of multiversion concurrency control, the <option>SERIALIZABLE</option> level is not - truly serializable. See the <citetitle>User's Guide</citetitle> for - details. + truly serializable. See the &cite-user; for details. </para> <para> diff --git a/doc/src/sgml/ref/show.sgml b/doc/src/sgml/ref/show.sgml index 2f086ee8a2..c97c2a04c5 100644 --- a/doc/src/sgml/ref/show.sgml +++ b/doc/src/sgml/ref/show.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.22 2002/10/13 16:55:05 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.23 2003/01/19 00:13:31 momjian Exp $ PostgreSQL documentation --> @@ -62,10 +62,9 @@ SHOW ALL </para> <para> - Even with <literal>autocommit</> set to <literal>off</>, <command>SHOW</> + Even with <varname>autocommit</> set to <literal>off</>, <command>SHOW</> does not start a new transaction block. See the - <literal>autocommit</> section of the <citetitle>Administrator's - Guide</citetitle> for details. + <varname>autocommit</> section of the &cite-admin; for details. </para> </refsect1> @@ -91,7 +90,7 @@ SHOW ALL <refsect1 id="R1-SQL-SHOW-2"> <title>Examples</title> <para> - Show the current <literal>DateStyle</literal> setting: + Show the current <varname>DateStyle</varname> setting: <programlisting> SHOW DateStyle; @@ -103,7 +102,8 @@ SHOW DateStyle; </para> <para> - Show the current genetic optimizer (<literal>geqo</literal>) setting: + Show whether the genetic query optimizer is enabled by displaying + the <varname>geqo</varname> setting: <programlisting> SHOW GEQO; geqo @@ -148,7 +148,7 @@ SHOW ALL; <para> The function <function>current_setting</function> produces equivalent output. See <citetitle>Miscellaneous Functions</citetitle> in the - <citetitle>PostgreSQL User's Guide</citetitle>. + &cite-user;. </para> </refsect1> </refentry> diff --git a/doc/src/sgml/ref/vacuum.sgml b/doc/src/sgml/ref/vacuum.sgml index 5f7b76285f..07dbbaed2a 100644 --- a/doc/src/sgml/ref/vacuum.sgml +++ b/doc/src/sgml/ref/vacuum.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuum.sgml,v 1.27 2002/10/09 16:27:48 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuum.sgml,v 1.28 2003/01/19 00:13:31 momjian Exp $ PostgreSQL documentation --> @@ -206,7 +206,7 @@ INFO: Index <replaceable class="PARAMETER">index</replaceable>: Pages 28; intended usage is in connection with preparation of user-defined template databases, or other databases that are completely read-only and will not receive routine maintenance <command>VACUUM</> operations. - See the <citetitle>Administrator's Guide</> for details. + See the &cite-admin; for details. </para> <refsect2 id="R2-SQL-VACUUM-3"> |
