diff options
author | Bruce Momjian <bruce@momjian.us> | 2001-03-05 18:42:57 +0000 |
---|---|---|
committer | Bruce Momjian <bruce@momjian.us> | 2001-03-05 18:42:57 +0000 |
commit | 47065aec112d34cf8b3895f073cf1dc7e1093939 (patch) | |
tree | 75256e24f8a65f4e621cad07b89fd1a391e3830b | |
parent | 83d0e37947d87443ff69328beaa9053247177fb2 (diff) | |
download | postgresql-47065aec112d34cf8b3895f073cf1dc7e1093939.tar.gz postgresql-47065aec112d34cf8b3895f073cf1dc7e1093939.zip |
I'm attaching those diffs for the Reference Guide in a tar file, as
not all of them attached properly in the post I made a few minutes
ago. Please disregard those earlier files. The diffs in the tar file
replace them.
Pierce Tyler
-rw-r--r-- | doc/src/sgml/ref/alter_table.sgml | 4 | ||||
-rw-r--r-- | doc/src/sgml/ref/comment.sgml | 4 | ||||
-rw-r--r-- | doc/src/sgml/ref/create_type.sgml | 4 | ||||
-rw-r--r-- | doc/src/sgml/ref/pg_config-ref.sgml | 4 | ||||
-rw-r--r-- | doc/src/sgml/ref/pg_dump.sgml | 400 | ||||
-rw-r--r-- | doc/src/sgml/ref/pg_dumpall.sgml | 6 | ||||
-rw-r--r-- | doc/src/sgml/ref/pg_restore.sgml | 4 | ||||
-rw-r--r-- | doc/src/sgml/ref/set.sgml | 4 |
8 files changed, 215 insertions, 215 deletions
diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_table.sgml index 90404ffd14f..4c258c81650 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.21 2001/02/10 16:41:30 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.22 2001/03/05 18:42:55 momjian Exp $ Postgres documentation --> @@ -107,7 +107,7 @@ ALTER TABLE <replaceable class="PARAMETER">table</replaceable> <term><replaceable class="PARAMETER">New user </replaceable></term> <listitem> <para> - The userid of the new owner of the table. + The user name of the new owner of the table. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/comment.sgml b/doc/src/sgml/ref/comment.sgml index 9597a88975f..f5cf0ae67d5 100644 --- a/doc/src/sgml/ref/comment.sgml +++ b/doc/src/sgml/ref/comment.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/comment.sgml,v 1.6 2001/01/20 20:59:29 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/comment.sgml,v 1.7 2001/03/05 18:42:56 momjian Exp $ Postgres documentation --> @@ -101,7 +101,7 @@ COMMENT <para> <command>COMMENT</command> adds a comment to an object that can be easily retrieved with <application>psql's</application> - <emphasis>\dd</emphasis> or <emphasis>\d+</emphasis> commands. + <emphasis>\dd</emphasis>, <emphasis>\d+</emphasis>, or <emphasis>\l+</emphasis>commands. To remove a comment, use <literal>NULL</literal>. Comments are automatically dropped when the object is dropped. </para> diff --git a/doc/src/sgml/ref/create_type.sgml b/doc/src/sgml/ref/create_type.sgml index cb6b67e7ca3..4ac044dda63 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.16 2001/01/13 23:58:55 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.17 2001/03/05 18:42:56 momjian Exp $ Postgres documentation --> @@ -298,7 +298,7 @@ CREATE <para> The <replaceable class="parameter">storage</replaceable> keyword - allows selection of TOAST storage method for variable-length data types + allows selection of The Oversized-Attribute Storage Technique (TOAST) for variable-length data types (only <literal>plain</literal> is allowed for fixed-length types). <literal>plain</literal> disables TOAST for the data type: it will always be stored in-line and not compressed. diff --git a/doc/src/sgml/ref/pg_config-ref.sgml b/doc/src/sgml/ref/pg_config-ref.sgml index defe2e1c024..680418771c8 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.4 2000/11/11 23:01:45 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.5 2001/03/05 18:42:56 momjian Exp $ --> <refentry id="app-pgconfig"> <docinfo> @@ -32,7 +32,7 @@ <refsect1> <title>Description</> <para> - The <application>pg_config</> stores and provides configuration parameters + The <application>pg_config</> utility provides configuration parameters of the currently installed version of <productname>PostgreSQL</>. It is intended, for example, to be used by software packages that want to interface to <productname>PostgreSQL</> in order to find the respective header files diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index c084188a17c..858692b7833 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.27 2000/12/25 23:15:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.28 2001/03/05 18:42:56 momjian Exp $ Postgres documentation --> @@ -31,12 +31,12 @@ Postgres documentation pg_dump [ <replaceable class="parameter">dbname</replaceable> ] pg_dump [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ] - [ -t <replaceable class="parameter">table</replaceable> ]
- [ -a ] [ -b ] [ -c ] [-C] [ -d ] [ -D ]
- [-f <REPLACEABLE CLASS="PARAMETER">file</REPLACEABLE>]
- [-F <REPLACEABLE CLASS="PARAMETER">format</REPLACEABLE>]
- [ -i ] [ -n ] [ -N ] [ -o ] [ -O ] [-R]
- [ -s ] [ -S ] [ -u ] [ -v ] [ -x ] [ -Z 0..9 ]
+ [ -t <replaceable class="parameter">table</replaceable> ] + [ -a ] [ -b ] [ -c ] [-C] [ -d ] [ -D ] + [-f <REPLACEABLE CLASS="PARAMETER">file</REPLACEABLE>] + [-F <REPLACEABLE CLASS="PARAMETER">format</REPLACEABLE>] + [ -i ] [ -n ] [ -N ] [ -o ] [ -O ] [-R] + [ -s ] [ -S ] [ -u ] [ -v ] [ -x ] [ -Z 0..9 ] [ <replaceable class="parameter">dbname</replaceable> ] </synopsis> @@ -74,38 +74,38 @@ pg_dump [ -h <replaceable class="parameter">host</replaceable> ] </listitem> </varlistentry> - <varlistentry>
- <term>-b</term>
- <listitem>
- <para>
- Dump BLOB data.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-c</term>
- <listitem>
- <para>
- Clean (drop) schema prior to create.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-C</term>
- <listitem>
- <para>
- For plain text (script) output, include SQL to create the database itself.
- </para>
- </listitem>
- </varlistentry>
-
+ <varlistentry> + <term>-b</term> + <listitem> + <para> + Dump data and BLOB data. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-c</term> + <listitem> + <para> + Clean (drop) schema prior to create. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-C</term> + <listitem> + <para> + For plain text (script) output, include SQL to create the database itself. + </para> + </listitem> + </varlistentry> + <varlistentry> <term>-d</term> <listitem> <para> - Dump data as proper insert strings. This is not recommended for large databases
+ Dump data as proper insert strings. This is not recommended for large databases for performance reasons. </para> </listitem> @@ -115,68 +115,68 @@ pg_dump [ -h <replaceable class="parameter">host</replaceable> ] <term>-D</term> <listitem> <para> - Dump data as inserts with attribute names. This is not recommended for large databases
+ Dump data as inserts with attribute names. This is not recommended for large databases for performance reasons. </para> </listitem> </varlistentry> -
- <varlistentry>
- <term>-f <replaceable class="parameter">file</replaceable></term>
- <listitem>
- <para>
- Send output to the specified file.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-F <replaceable class="parameter">format</replaceable></term>
- <listitem>
- <para>
- Format can be one of the following:
- </para>
-
-
- <variablelist>
- <varlistentry>
- <term>p</term>
- <listitem>
- <para>
- output a plain text SQL script file (default)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>t</term>
- <listitem>
- <para>
- output a TAR archive suitable for input into
- <APPLICATION>pg_restore</APPLICATION>. Using this archive format
- allows reordering and/or exclusion of schema elements
- at the time the database is restored. It is also possible to limit
- which data is reloaded at restore time.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>c</term>
- <listitem>
- <para>
- output a custom archive suitable for input into
- <APPLICATION>pg_restore</APPLICATION>. This is the most flexible
- format in that it allows reordering of data load as well
- as schema elements. This format is also compressed by default.
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
-
- </listitem>
- </varlistentry>
+ + <varlistentry> + <term>-f <replaceable class="parameter">file</replaceable></term> + <listitem> + <para> + Send output to the specified file. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-F <replaceable class="parameter">format</replaceable></term> + <listitem> + <para> + Format can be one of the following: + </para> + + + <variablelist> + <varlistentry> + <term>p</term> + <listitem> + <para> + output a plain text SQL script file (default) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>t</term> + <listitem> + <para> + output a TAR archive suitable for input into + <APPLICATION>pg_restore</APPLICATION>. Using this archive format + allows reordering and/or exclusion of schema elements + at the time the database is restored. It is also possible to limit + which data is reloaded at restore time. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>c</term> + <listitem> + <para> + output a custom archive suitable for input into + <APPLICATION>pg_restore</APPLICATION>. This is the most flexible + format in that it allows reordering of data load as well + as schema elements. This format is also compressed by default. + </para> + </listitem> + </varlistentry> + + </variablelist> + + </listitem> + </varlistentry> <varlistentry> <term>-i</term> @@ -217,37 +217,37 @@ pg_dump [ -h <replaceable class="parameter">host</replaceable> ] </listitem> </varlistentry> - <varlistentry>
- <term>-o</term>
- <listitem>
- <para>
- Dump object identifiers (<acronym>OID</acronym>s) for every table.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-O</term>
- <listitem>
- <para>
- In plain text output mode, don't set object ownership to match the
- original database. Typically, <APPLICATION>pg_dump</APPLICATION>
- issues <PROGRAMLISTING>\connect</PROGRAMLISTING> statments to set
- ownership of schema elements.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-R</term>
- <listitem>
- <para>
- In plain text output mode, prohibit <APPLICATION>pg_dump</APPLICATION>
- from issuing any <PROGRAMLISTING>\connect</PROGRAMLISTING> statements.
- </para>
- </listitem>
- </varlistentry>
-
+ <varlistentry> + <term>-o</term> + <listitem> + <para> + Dump object identifiers (<acronym>OID</acronym>s) for every table. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-O</term> + <listitem> + <para> + In plain text output mode, don't set object ownership to match the + original database. Typically, <APPLICATION>pg_dump</APPLICATION> + issues <PROGRAMLISTING>\connect</PROGRAMLISTING> statments to set + ownership of schema elements. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-R</term> + <listitem> + <para> + In plain text output mode, prohibit <APPLICATION>pg_dump</APPLICATION> + from issuing any <PROGRAMLISTING>\connect</PROGRAMLISTING> statements. + </para> + </listitem> + </varlistentry> + <varlistentry> <term>-s</term> <listitem> @@ -257,25 +257,25 @@ pg_dump [ -h <replaceable class="parameter">host</replaceable> ] </listitem> </varlistentry> - <varlistentry>
- <term>-S <replaceable class="parameter">username</replaceable></term>
- <listitem>
- <para>
- Specify the superuser username to use when disabling triggers and/or
- setting ownership of schema elements.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-t <replaceable class="parameter">table</replaceable></term>
- <listitem>
- <para>
- Dump data for <replaceable class="parameter">table</replaceable> only.
- </para>
- </listitem>
- </varlistentry>
-
+ <varlistentry> + <term>-S <replaceable class="parameter">username</replaceable></term> + <listitem> + <para> + Specify the superuser username to use when disabling triggers and/or + setting ownership of schema elements. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-t <replaceable class="parameter">table</replaceable></term> + <listitem> + <para> + Dump data for <replaceable class="parameter">table</replaceable> only. + </para> + </listitem> + </varlistentry> + <varlistentry> <term>-u</term> <listitem> @@ -302,17 +302,17 @@ pg_dump [ -h <replaceable class="parameter">host</replaceable> ] </para> </listitem> </varlistentry> -
- <varlistentry>
- <term>-Z <replaceable class="parameter">0..9</replaceable></term>
- <listitem>
- <para>
- Specify the compression level to use in archive formats that support
- compression (currently only the custom archive format supports compression).
- </para>
- </listitem>
- </varlistentry>
-
+ + <varlistentry> + <term>-Z <replaceable class="parameter">0..9</replaceable></term> + <listitem> + <para> + Specify the compression level to use in archive formats that support + compression (currently only the custom archive format supports compression). + </para> + </listitem> + </varlistentry> + </variablelist> </para> @@ -442,19 +442,19 @@ dumpSequence(<replaceable class="parameter">table</replaceable>): SELECT failed </title> <para> <application>pg_dump</application> is a utility for dumping out a - <productname>Postgres</productname> database into a script or archive
- file containing query commands. The script files are in text format
- and can be used to reconstruct the database, even on other machines
- and other architectures.
- </para>
+ <productname>Postgres</productname> database into a script or archive + file containing query commands. The script files are in text format + and can be used to reconstruct the database, even on other machines + and other architectures. + </para> <para> - The archive files, new with version 7.1, contain enough information for
- <APPLICATION>pg_restore</APPLICATION> to rebuild the database, but also
- allow pg_restore to be selective about what is restored, or even to
- reorder the items prior to being restored. The archive files should
- also be portable across architectures.
- </para>
- <para>
+ The archive files, new with version 7.1, contain enough information for + <APPLICATION>pg_restore</APPLICATION> to rebuild the database, but also + allow pg_restore to be selective about what is restored, or even to + reorder the items prior to being restored. The archive files should + also be portable across architectures. + </para> + <para> <application>pg_dump</application> will produce the queries necessary to re-generate all user-defined types, functions, tables, indices, aggregates, and @@ -471,20 +471,20 @@ dumpSequence(<replaceable class="parameter">table</replaceable>): SELECT failed one should examine the output for any warnings, especially in light of the limitations listed below. </para> -
- <para>
- When used with one of the alternate file formats and combined with
- <APPLICATION>pg_restore</APPLICATION>, it provides a flexible archival
- and trasfer mechanism. <APPLICATION>pg_dump</APPLICATION> can be used
- to backup an entire database, then <APPLICATION>pg_restore</APPLICATION>
- can be used to examine the archive and/or select which parts of the
- database are to be restored.
- </para>
-
- <para>
- See the <APPLICATION>pg_restore</APPLICATION> documentation for details.
- </para>
-
+ + <para> + When used with one of the alternate file formats and combined with + <APPLICATION>pg_restore</APPLICATION>, it provides a flexible archival + and trasfer mechanism. <APPLICATION>pg_dump</APPLICATION> can be used + to backup an entire database, then <APPLICATION>pg_restore</APPLICATION> + can be used to examine the archive and/or select which parts of the + database are to be restored. + </para> + + <para> + See the <APPLICATION>pg_restore</APPLICATION> documentation for details. + </para> + </refsect1> <refsect1 id="R1-APP-PG-DUMP-2"> @@ -511,9 +511,9 @@ dumpSequence(<replaceable class="parameter">table</replaceable>): SELECT failed <listitem> <para> - When dumping a single table or as plain text, <application>pg_dump</application>
- does not handle large objects. Large objects must be dumped in their
- entirity using one of the binary archive formats.
+ When dumping a single table or as plain text, <application>pg_dump</application> + does not handle large objects. Large objects must be dumped in their + entirity using one of the binary archive formats. </para> </listitem> @@ -552,23 +552,23 @@ $ pg_dump > db.out $ psql -e database < db.out </programlisting> </para> -
- <para>
- To dump a database called mydb that contains BLOBs to a TAR file:
-
- <programlisting>
-$ pg_dump -Ft --blobs mydb > db.tar
- </programlisting>
- </para>
-
- <para>
- To reload this database (with BLOBs) to an existing db called newdb:
-
- <programlisting>
-$ pg_restore db.tar --db=newdb
- </programlisting>
- </para>
-
+ + <para> + To dump a database called mydb that contains BLOBs to a TAR file: + + <programlisting> +$ pg_dump -Ft --blobs mydb > db.tar + </programlisting> + </para> + + <para> + To reload this database (with BLOBs) to an existing db called newdb: + + <programlisting> +$ pg_restore db.tar --db=newdb + </programlisting> + </para> + </refsect1> </refentry> diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index fc00ab1aac4..aa2c2a88276 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.20 2001/02/11 01:41:00 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.21 2001/03/05 18:42:57 momjian Exp $ Postgres documentation --> @@ -55,7 +55,7 @@ Postgres documentation Since <application>pg_dumpall</application> reads tables from all databases you will most likely have to connect as a database superuser in order to produce a complete dump. Also you will need - superuser priviledges to execute the saves script in order to be + superuser privileges to execute the saved script in order to be allowed to add users and groups, and to create databases. </para> @@ -146,7 +146,7 @@ Postgres documentation (It is not important to which database you connect here since the script file created by <application>pg_dumpall</application> will contain the appropriate commands to create and connect to the saved - databases. + databases.) </para> </refsect1> diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index 5481ff87385..191406fe78f 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -428,13 +428,13 @@ FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable> The most flexible output file format is the new 'custom' format (-Fc). It allows for selection and reordering of all archived items, and is compressed by default. The TAR format (-Ft) is not compressed and it is not possible to reorder - data load, but it is otherwise quite flexible. + data when loading, but it is otherwise quite flexible. </para> <para> To reorder the items, it is first necessary to dump the contents of the archive: <programlisting> - $ pg_restore acrhive.file --list > archive.lis + $ pg_restore archive.file --list > archive.lis </programlisting> This file consists of a header and one line for each item, eg. <programlisting> diff --git a/doc/src/sgml/ref/set.sgml b/doc/src/sgml/ref/set.sgml index a614143a42c..e4b05854b00 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.50 2000/10/05 19:48:19 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/set.sgml,v 1.51 2001/03/05 18:42:57 momjian Exp $ Postgres documentation --> @@ -196,7 +196,7 @@ SET TIME ZONE { '<replaceable class="PARAMETER">timezone</replaceable>' | LOCAL The value for the seed to be used by the <function>random</function> function. Allowed values are floating point numbers between 0 and 1, which - are then multiplied by 2^31-1. This product will + are then multiplied by RAND_MAX. This product will silently overflow if a number outside the range is used. </para> |