diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_table.sgml index 90404ffd14..4c258c8165 100644 --- a/doc/src/sgml/ref/alter_table.sgml +++ b/doc/src/sgml/ref/alter_table.sgml @@ -1,5 +1,5 @@ @@ -107,7 +107,7 @@ ALTER TABLE table New user - The userid of the new owner of the table. + The user name of the new owner of the table. diff --git a/doc/src/sgml/ref/comment.sgml b/doc/src/sgml/ref/comment.sgml index 9597a88975..f5cf0ae67d 100644 --- a/doc/src/sgml/ref/comment.sgml +++ b/doc/src/sgml/ref/comment.sgml @@ -1,5 +1,5 @@ @@ -101,7 +101,7 @@ COMMENT COMMENT adds a comment to an object that can be easily retrieved with psql's - \dd or \d+ commands. + \dd, \d+, or \l+commands. To remove a comment, use NULL. Comments are automatically dropped when the object is dropped. diff --git a/doc/src/sgml/ref/create_type.sgml b/doc/src/sgml/ref/create_type.sgml index cb6b67e7ca..4ac044dda6 100644 --- a/doc/src/sgml/ref/create_type.sgml +++ b/doc/src/sgml/ref/create_type.sgml @@ -1,5 +1,5 @@ @@ -298,7 +298,7 @@ CREATE The storage 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 plain is allowed for fixed-length types). plain 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 defe2e1c02..680418771c 100644 --- a/doc/src/sgml/ref/pg_config-ref.sgml +++ b/doc/src/sgml/ref/pg_config-ref.sgml @@ -1,4 +1,4 @@ - + @@ -32,7 +32,7 @@ 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 c084188a17..858692b783 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 pg_dump is a utility for dumping out a - Postgres 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. - + Postgres 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. + - The archive files, new with version 7.1, contain enough information for - pg_restore 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. - - + The archive files, new with version 7.1, contain enough information for + pg_restore 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. + + pg_dump will produce the queries necessary to re-generate all user-defined types, functions, tables, indices, aggregates, and @@ -471,20 +471,20 @@ dumpSequence(table): SELECT failed one should examine the output for any warnings, especially in light of the limitations listed below. - - - When used with one of the alternate file formats and combined with - pg_restore, it provides a flexible archival - and trasfer mechanism. pg_dump can be used - to backup an entire database, then pg_restore - can be used to examine the archive and/or select which parts of the - database are to be restored. - - - - See the pg_restore documentation for details. - - + + + When used with one of the alternate file formats and combined with + pg_restore, it provides a flexible archival + and trasfer mechanism. pg_dump can be used + to backup an entire database, then pg_restore + can be used to examine the archive and/or select which parts of the + database are to be restored. + + + + See the pg_restore documentation for details. + + @@ -511,9 +511,9 @@ dumpSequence(table): SELECT failed - When dumping a single table or as plain text, pg_dump - 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, pg_dump + does not handle large objects. Large objects must be dumped in their + entirity using one of the binary archive formats. @@ -552,23 +552,23 @@ $ pg_dump > db.out $ psql -e database < db.out - - - To dump a database called mydb that contains BLOBs to a TAR file: - - -$ pg_dump -Ft --blobs mydb > db.tar - - - - - To reload this database (with BLOBs) to an existing db called newdb: - - -$ pg_restore db.tar --db=newdb - - - + + + To dump a database called mydb that contains BLOBs to a TAR file: + + +$ pg_dump -Ft --blobs mydb > db.tar + + + + + To reload this database (with BLOBs) to an existing db called newdb: + + +$ pg_restore db.tar --db=newdb + + + diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index fc00ab1aac..aa2c2a8827 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -1,5 +1,5 @@ @@ -55,7 +55,7 @@ Postgres documentation Since pg_dumpall 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. @@ -146,7 +146,7 @@ Postgres documentation (It is not important to which database you connect here since the script file created by pg_dumpall will contain the appropriate commands to create and connect to the saved - databases. + databases.) diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index 5481ff8738..191406fe78 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 'username 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. To reorder the items, it is first necessary to dump the contents of the archive: - $ pg_restore acrhive.file --list > archive.lis + $ pg_restore archive.file --list > archive.lis This file consists of a header and one line for each item, eg. diff --git a/doc/src/sgml/ref/set.sgml b/doc/src/sgml/ref/set.sgml index a614143a42..e4b05854b0 100644 --- a/doc/src/sgml/ref/set.sgml +++ b/doc/src/sgml/ref/set.sgml @@ -1,5 +1,5 @@ @@ -196,7 +196,7 @@ SET TIME ZONE { 'timezone' | LOCAL The value for the seed to be used by the random 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.