From da8149032a799cd6cca1adc2ccc4c7140281308b Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Fri, 15 Nov 2002 03:11:18 +0000 Subject: [PATCH] SGML improvements. Neil Conway --- doc/src/sgml/admin.sgml | 22 ++-- doc/src/sgml/charset.sgml | 7 +- doc/src/sgml/client-auth.sgml | 8 +- doc/src/sgml/datatype.sgml | 213 ++++++++++++++++++---------------- doc/src/sgml/ddl.sgml | 12 +- doc/src/sgml/diskusage.sgml | 13 ++- doc/src/sgml/ecpg.sgml | 38 +++--- doc/src/sgml/features.sgml | 11 +- doc/src/sgml/info.sgml | 22 ++-- doc/src/sgml/installation.sgml | 50 ++++---- doc/src/sgml/jdbc.sgml | 17 +-- doc/src/sgml/libpgtcl.sgml | 3 +- doc/src/sgml/libpq.sgml | 16 +-- doc/src/sgml/manage-ag.sgml | 62 +++++----- doc/src/sgml/mvcc.sgml | 44 +++---- doc/src/sgml/programmer.sgml | 22 ++-- doc/src/sgml/ref/create_cast.sgml | 18 +-- doc/src/sgml/ref/create_database.sgml | 4 +- doc/src/sgml/ref/ecpg-ref.sgml | 8 +- doc/src/sgml/ref/explain.sgml | 20 ++-- doc/src/sgml/ref/load.sgml | 17 +-- doc/src/sgml/ref/pg_config-ref.sgml | 9 +- doc/src/sgml/ref/pg_dump.sgml | 14 +-- doc/src/sgml/ref/pg_dumpall.sgml | 26 ++--- doc/src/sgml/ref/pg_restore.sgml | 27 ++--- doc/src/sgml/syntax.sgml | 24 ++-- doc/src/sgml/tutorial.sgml | 8 +- doc/src/sgml/user.sgml | 26 +++-- doc/src/sgml/xfunc.sgml | 8 +- 29 files changed, 405 insertions(+), 364 deletions(-) diff --git a/doc/src/sgml/admin.sgml b/doc/src/sgml/admin.sgml index f1cb16d9e1..fccd8c2b21 100644 --- a/doc/src/sgml/admin.sgml +++ b/doc/src/sgml/admin.sgml @@ -1,5 +1,5 @@ @@ -25,13 +25,13 @@ $Header: /cvsroot/pgsql/doc/src/sgml/Attic/admin.sgml,v 1.40 2002/10/24 17:48:54 What's In This Book - This book covers topics that are of interest to a PostgreSQL - database administrator. This includes installation of the - software, set up and configuration of the server, management of - users and databases, and maintenance tasks. Anyone who runs a - PostgreSQL server, either for personal use, but especially in - production, should be familiar with the topics covered in this - book. + This book covers topics that are of interest to a + PostgreSQL database administrator. This includes + installation of the software, set up and configuration of the + server, management of users and databases, and maintenance tasks. + Anyone who runs a PostgreSQL server, either for + personal use, but especially in production, should be familiar + with the topics covered in this book. @@ -49,9 +49,9 @@ $Header: /cvsroot/pgsql/doc/src/sgml/Attic/admin.sgml,v 1.40 2002/10/24 17:48:54 up their own server can begin their exploration with this book. The rest of this book which is about tuning and management presupposes that the reader is familiar with the general use of - the PostgreSQL database system. Readers are encouraged to look at - the &cite-tutorial; and the &cite-user; for additional - information. + the PostgreSQL database system. Readers are + encouraged to look at the &cite-tutorial; and the &cite-user; for + additional information. diff --git a/doc/src/sgml/charset.sgml b/doc/src/sgml/charset.sgml index a3d8a52aef..9aa9c61446 100644 --- a/doc/src/sgml/charset.sgml +++ b/doc/src/sgml/charset.sgml @@ -1,4 +1,4 @@ - + Localization</> @@ -351,7 +351,8 @@ perl: warning: Falling back to the standard locale ("C"). </para> <para> - Multibyte support is enabled by default since PostgreSQL version 7.3. + Multibyte support is enabled by default since + <productname>PostgreSQL</> version 7.3. </para> <sect2> @@ -574,7 +575,7 @@ $ <userinput>psql -l</userinput> encoding conversion between server and client for some encodings. The conversion info is stored in <literal>pg_conversion</> system catalog. You can create a new conversion by using <command>CREATE - CONVERSION</command>. PostgreSQL comes with some predefined + CONVERSION</command>. <productname>PostgreSQL</> comes with some predefined conversions. They are listed in <xref linkend="multibyte-translation-table">. </para> diff --git a/doc/src/sgml/client-auth.sgml b/doc/src/sgml/client-auth.sgml index 450ee3eba3..4eeb5f5dff 100644 --- a/doc/src/sgml/client-auth.sgml +++ b/doc/src/sgml/client-auth.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/client-auth.sgml,v 1.40 2002/11/11 20:14:02 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/client-auth.sgml,v 1.41 2002/11/15 03:11:15 momjian Exp $ --> <chapter id="client-authentication"> @@ -160,9 +160,9 @@ hostssl <replaceable>database</replaceable> <replaceable>user</replaceable> < <term><replaceable>user</replaceable></term> <listitem> <para> - Specifies which PostgreSQL users this record matches. The value - <literal>all</literal> specifies that it matches all users. - Otherwise, this is the name of a specific + Specifies which <productname>PostgreSQL</> users this record + matches. The value <literal>all</literal> specifies that it + matches all users. Otherwise, this is the name of a specific <productname>PostgreSQL</productname> user. Multiple user names can be supplied by separating them with commas. Group names can be specified by preceding the group name with <literal>+</>. A diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml index a07a261eb3..1c07a9c5f1 100644 --- a/doc/src/sgml/datatype.sgml +++ b/doc/src/sgml/datatype.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.107 2002/11/11 20:14:02 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.108 2002/11/15 03:11:15 momjian Exp $ --> <chapter id="datatype"> @@ -245,14 +245,15 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.107 2002/11/11 20:14:02 p <note> <title>Compatibility - The following types (or spellings thereof) are specified by SQL: - bit, bit varying, boolean, - char, character, character - varying, varchar, date, - double precision, integer, - interval, numeric, decimal, - real, smallint, time, - timestamp (both with or without time zone). + The following types (or spellings thereof) are specified by + SQL: bit, bit + varying, boolean, char, + character, character varying, + varchar, date, double + precision, integer, interval, + numeric, decimal, real, + smallint, time, timestamp + (both with or without time zone). @@ -464,11 +465,12 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.107 2002/11/11 20:14:02 p - SQL only specifies the integer types integer (or - int) and smallint. The type - bigint, and the type names int2, - int4, and int8 are extensions, which - are shared with various other SQL database systems. + SQL only specifies the integer types + integer (or int) and + smallint. The type bigint, and the + type names int2, int4, and + int8 are extensions, which are shared with various + other SQL database systems. @@ -536,13 +538,15 @@ NUMERIC(precision) NUMERIC without any precision or scale creates a column in which numeric - values of any precision and scale can be stored, up to the implementation - limit on precision. A column of this kind will not coerce input - values to any particular scale, whereas numeric columns - with a declared scale will coerce input values to that scale. - (The SQL standard requires a default scale of 0, i.e., coercion to - integer precision. We find this a bit useless. If you're concerned about - portability, always specify the precision and scale explicitly.) + values of any precision and scale can be stored, up to the + implementation limit on precision. A column of this kind will + not coerce input values to any particular scale, whereas + numeric columns with a declared scale will coerce + input values to that scale. (The SQL standard + requires a default scale of 0, i.e., coercion to integer + precision. We find this a bit useless. If you're concerned + about portability, always specify the precision and scale + explicitly.) @@ -554,7 +558,8 @@ NUMERIC The types decimal and numeric are - equivalent. Both types are part of the SQL standard. + equivalent. Both types are part of the SQL + standard. @@ -806,7 +811,8 @@ CREATE TABLE tablename ( shows the - general-purpose character types available in PostgreSQL. + general-purpose character types available in + PostgreSQL. @@ -818,11 +824,12 @@ CREATE TABLE tablename ( longer string into a column of these types will result in an error, unless the excess characters are all spaces, in which case the string will be truncated to the maximum length. (This - somewhat bizarre exception is required by the SQL standard.) If - the string to be stored is shorter than the declared length, - values of type character will be space-padded; values - of type character varying will simply store the - shorter string. + somewhat bizarre exception is required by the + SQL standard.) If the string to be stored is + shorter than the declared length, values of type + character will be space-padded; values of type + character varying will simply store the shorter + string. @@ -831,7 +838,8 @@ CREATE TABLE tablename ( character(n) or character varying(n), then an overlength value will be truncated to n characters without raising an - error. (This too is required by the SQL standard.) + error. (This too is required by the SQL + standard.) @@ -859,8 +867,9 @@ CREATE TABLE tablename ( more general text type, which stores strings of any length. Unlike character varying, text does not require an explicit declared upper limit on the size of - the string. Although the type text is not in the SQL - standard, many other RDBMS packages have it as well. + the string. Although the type text is not in the + SQL standard, many other RDBMS packages have it + as well. @@ -1125,12 +1134,12 @@ SELECT b, char_length(b) FROM test2; To use the bytea escaped octet notation, string - literals (input strings) must contain two backslashes due because - they must pass through two parsers in the PostgreSQL server. The - first backslash is interpreted as an escape character by the - string-literal parser, and therefore is consumed, leaving the - characters that follow. The remaining backslash is recognized by - the bytea input function as the prefix of a three + literals (input strings) must contain two backslashes because they + must pass through two parsers in the PostgreSQL + server. The first backslash is interpreted as an escape character + by the string-literal parser, and therefore is consumed, leaving + the characters that follow. The remaining backslash is recognized + by the bytea input function as the prefix of a three digit octal value. For example, a string literal passed to the backend as '\\001' becomes '\001' after passing through the string-literal @@ -1170,21 +1179,22 @@ SELECT b, char_length(b) FROM test2; - Depending on the front end to PostgreSQL you use, you may have - additional work to do in terms of escaping and unescaping - bytea strings. For example, you may also have to escape - line feeds and carriage returns if your interface automatically - translates these. Or you may have to double up on backslashes if - the parser for your language or choice also treats them as an - escape character. + Depending on the front end to PostgreSQL you use, + you may have additional work to do in terms of escaping and + unescaping bytea strings. For example, you may also + have to escape line feeds and carriage returns if your interface + automatically translates these. Or you may have to double up on + backslashes if the parser for your language or choice also treats + them as an escape character. - - The SQL standard defines a different binary string type, called - BLOB or BINARY LARGE OBJECT. The input - format is different compared to bytea, but the - provided functions and operators are mostly the same. - + + The SQL standard defines a different binary + string type, called BLOB or BINARY LARGE + OBJECT. The input format is different compared to + bytea, but the provided functions and operators are + mostly the same. + @@ -1781,11 +1791,12 @@ January 8 04:05:06 1999 PST Output formats can be set to one of the four styles ISO 8601, SQL (Ingres), traditional PostgreSQL, and German, using the SET DateStyle. The default - is the ISO format. (The SQL standard requires - the use of the ISO 8601 format. The name of the - SQL output format is a historical accident.) - shows examples of - each output style. The output of the date and + is the ISO format. (The + SQL standard requires the use of the ISO 8601 + format. The name of the SQL output format is a + historical accident.) shows examples of each + output style. The output of the date and time types is of course only the date or time part in accordance with the given examples. @@ -1920,34 +1931,34 @@ January 8 04:05:06 1999 PST - To address these difficulties, we recommend using date/time - types that contain both date and time when using time zones. We - recommend not using the type time - with time zone (though it is supported by + To address these difficulties, we recommend using date/time types + that contain both date and time when using time zones. We + recommend not using the type time with + time zone (though it is supported by PostgreSQL for legacy applications and - for compatibility with other SQL implementations). - PostgreSQL - assumes your local time zone for any type containing only - date or time. Further, time zone support is derived from - the underlying operating system - time-zone capabilities, and hence can handle daylight-saving time - and other expected behavior. + for compatibility with other SQL + implementations). PostgreSQL assumes + your local time zone for any type containing only date or + time. Further, time zone support is derived from the underlying + operating system time-zone capabilities, and hence can handle + daylight-saving time and other expected behavior. - PostgreSQL obtains time-zone support + PostgreSQL obtains time-zone support from the underlying operating system for dates between 1902 and 2038 (near the typical date limits for Unix-style systems). Outside of this range, all dates are assumed to be - specified and used in Universal Coordinated Time (UTC). + specified and used in Universal Coordinated Time + (UTC). - All dates and times are stored internally in UTC, - traditionally known as Greenwich Mean Time (GMT). - Times are converted to local time on the database server before being - sent to the client frontend, hence by default are in the server - time zone. + All dates and times are stored internally in + UTC, traditionally known as Greenwich Mean + Time (GMT). Times are converted to local time + on the database server before being sent to the client frontend, + hence by default are in the server time zone. @@ -1993,8 +2004,8 @@ January 8 04:05:06 1999 PST - If an invalid time zone is specified, - the time zone becomes GMT (on most systems anyway). + If an invalid time zone is specified, the time zone becomes + UTC (on most systems anyway). @@ -2124,8 +2135,9 @@ SELECT * FROM test1 WHERE a; Geometric data types represent two-dimensional spatial objects. shows the geometric - types available in PostgreSQL. The most fundamental type, the - point, forms the basis for all of the other types. + types available in PostgreSQL. The + most fundamental type, the point, forms the basis for all of the + other types. @@ -2746,9 +2758,10 @@ SELECT * FROM test1 WHERE a; - Prior to PostgreSQL 7.2, BIT data was - always silently truncated or zero-padded on the right, with or without an - explicit cast. This was changed to comply with the SQL standard. + Prior to PostgreSQL 7.2, BIT data + was always silently truncated or zero-padded on the right, with + or without an explicit cast. This was changed to comply with the + SQL standard. @@ -2978,14 +2991,14 @@ SELECT * FROM test; - A third identifier type used by the system is cid, or command - identifier. This is the data type of the system columns - cmin and cmax. - Command identifiers are also 32-bit quantities. This creates a hard - limit of 232 (4 billion) SQL commands within a single - transaction. - In practice this limit is not a problem --- note that the limit is on - number of SQL commands, not number of tuples processed. + A third identifier type used by the system is cid, or + command identifier. This is the data type of the system columns + cmin and cmax. Command + identifiers are also 32-bit quantities. This creates a hard limit + of 232 (4 billion) SQL commands + within a single transaction. In practice this limit is not a + problem --- note that the limit is on number of + SQL commands, not number of tuples processed. @@ -3044,9 +3057,10 @@ SELECT * FROM test; column data type, but it can be used to declare a function's argument or result type. Each of the available pseudo-types is useful in situations where a function's behavior does not - correspond to simply taking or returning a value of a specific SQL - data type. lists the - existing pseudo-types. + correspond to simply taking or returning a value of a specific + SQL data type. lists the existing + pseudo-types.
@@ -3126,14 +3140,15 @@ SELECT * FROM test; - The internal pseudo-type is used to declare functions that are - meant only to be called internally by the database system, and not by - direct invocation in a SQL query. If a function has at least one - internal-type argument then it cannot be called from SQL. - To preserve the type safety of this restriction it is important to - follow this coding rule: do not create any function that is declared - to return internal unless it has at least one internal - argument. + The internal pseudo-type is used to declare functions + that are meant only to be called internally by the database + system, and not by direct invocation in a SQL + query. If a function has at least one internal-type + argument then it cannot be called from SQL. To + preserve the type safety of this restriction it is important to + follow this coding rule: do not create any function that is + declared to return internal unless it has at least one + internal argument. diff --git a/doc/src/sgml/ddl.sgml b/doc/src/sgml/ddl.sgml index e6f13ae056..6c58bfeb81 100644 --- a/doc/src/sgml/ddl.sgml +++ b/doc/src/sgml/ddl.sgml @@ -1,4 +1,4 @@ - + Data Definition @@ -1103,9 +1103,9 @@ ALTER TABLE products ALTER COLUMN price SET DEFAULT 7.77; ALTER TABLE products ALTER COLUMN price DROP DEFAULT; This is equivalent to setting the default to null, at least in - PostgreSQL. As a consequence, it is not an error to drop a - default where one hadn't been defined, because the default is - implicitly the null value. + PostgreSQL. As a consequence, it is not an error + to drop a default where one hadn't been defined, because the + default is implicitly the null value. @@ -1609,8 +1609,8 @@ REVOKE CREATE ON public FROM PUBLIC; standard. Therefore, many users consider qualified names to really consist of username.tablename. - This is how PostgreSQL will effectively behave if you create a per-user - schema for every user. + This is how PostgreSQL will effectively + behave if you create a per-user schema for every user. diff --git a/doc/src/sgml/diskusage.sgml b/doc/src/sgml/diskusage.sgml index 5a5cc930f8..0af7b4b392 100644 --- a/doc/src/sgml/diskusage.sgml +++ b/doc/src/sgml/diskusage.sgml @@ -1,16 +1,17 @@ Monitoring Disk Usage - This chapter discusses how to monitor the disk usage of a PostgreSQL - database system. In the current release, the database administrator - does not have much control over the on-disk storage layout, so this - chapter is mostly informative and can give you some ideas how to - manage the disk usage with operating system tools. + This chapter discusses how to monitor the disk usage of a + PostgreSQL database system. In the current + release, the database administrator does not have much control over + the on-disk storage layout, so this chapter is mostly informative + and can give you some ideas how to manage the disk usage with + operating system tools. diff --git a/doc/src/sgml/ecpg.sgml b/doc/src/sgml/ecpg.sgml index d53c9e54ae..719004a2c8 100644 --- a/doc/src/sgml/ecpg.sgml +++ b/doc/src/sgml/ecpg.sgml @@ -1,5 +1,5 @@ @@ -38,26 +38,29 @@ $Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.39 2002/10/24 17:48:54 petere for handling SQL commands from C code. First, it takes care of the tedious passing of information to and from variables in your C program. Secondly, embedded - SQL in C is defined in the SQL standard and supported by many other - SQL databases. The PostgreSQL implementation is designed to match - this standard as much as possible, and it is usually possible to - port embedded SQL programs written for other + SQL in C is defined in the + SQL standard and supported by many other + SQL databases. The PostgreSQL + implementation is designed to match this standard as much as + possible, and it is usually possible to port embedded + SQL programs written for other RDBMS to PostgreSQL with relative ease. - As indicated, programs written for the embedded SQL interface are - normal C programs with special code inserted to perform - database-related actions. This special code always has the form + As indicated, programs written for the embedded + SQL interface are normal C programs with special + code inserted to perform database-related actions. This special + code always has the form EXEC SQL ...; These statements syntactically take the place of a C statement. Depending on the particular statement, they may appear in the - global context or within a function. Embedded SQL statements - follow the case-sensitivity rules of normal SQL code, and not those - of C. + global context or within a function. Embedded + SQL statements follow the case-sensitivity rules + of normal SQL code, and not those of C. @@ -748,8 +751,8 @@ EXEC SQL INCLUDE filename; The preprocessor program is called ecpg and is - included in a normal PostgreSQL installation. Embedded SQL - programs are typically named with an extension + included in a normal PostgreSQL installation. + Embedded SQL programs are typically named with an extension .pgc. If you have a program file called prog1.pgc, you can preprocess it by simply calling @@ -768,10 +771,11 @@ ecpg prog1.pgc cc -c prog1.c The generated C source files include headers files from the - PostgreSQL installation, so if you installed PostgreSQL in a - location that is not searched by default, you have to add an option - such as -I/usr/local/pgsql/include to the - compilation command line. + PostgreSQL installation, so if you installed + PostgreSQL in a location that is not searched by + default, you have to add an option such as + -I/usr/local/pgsql/include to the compilation + command line. diff --git a/doc/src/sgml/features.sgml b/doc/src/sgml/features.sgml index c125c50aad..fa8641d012 100644 --- a/doc/src/sgml/features.sgml +++ b/doc/src/sgml/features.sgml @@ -1,5 +1,5 @@ @@ -15,11 +15,12 @@ $Header: /cvsroot/pgsql/doc/src/sgml/features.sgml,v 2.7 2002/09/21 18:32:53 pet - SQL99 defines a large set of individual - features rather than the ineffectively broad three levels found in + SQL99 defines a large set of individual features + rather than the ineffectively broad three levels found in SQL92. We provide a list of supported features, - followed by a list of the features defined in SQL99 which are not - yet supported in PostgreSQL. + followed by a list of the features defined in + SQL99 which are not yet supported in + PostgreSQL. diff --git a/doc/src/sgml/info.sgml b/doc/src/sgml/info.sgml index 892292e553..a7022e8877 100644 --- a/doc/src/sgml/info.sgml +++ b/doc/src/sgml/info.sgml @@ -1,12 +1,13 @@ Overview of Documentation Resources - The PostgreSQL documentation is organized into several books: + The PostgreSQL documentation is organized into + several books: @@ -22,9 +23,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.16 2002/10/24 17:48:54 petere &cite-user; - Documents the SQL query language environment, including data - types and functions, as well as user-level performance tuning. - Every PostgreSQL user should read this. + Documents the SQL query language environment, + including data types and functions, as well as user-level + performance tuning. Every PostgreSQL user + should read this. @@ -34,8 +36,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.16 2002/10/24 17:48:54 petere Installation and server management information. Everyone who - runs a PostgreSQL server, either for personal use or for other - users, needs to read this. + runs a PostgreSQL server, either for personal + use or for other users, needs to read this. @@ -55,9 +57,9 @@ $Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.16 2002/10/24 17:48:54 petere &cite-reference; - Reference pages for SQL command syntax, and client and server - programs. This book is auxiliary to the User's, - Administrator's, and Programmer's Guides. + Reference pages for SQL command syntax, and + client and server programs. This book is auxiliary to the + User's, Administrator's, and Programmer's Guides. diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index e0a342b955..544b917077 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -1,4 +1,4 @@ - + <![%standalone-include[<productname>PostgreSQL</>]]> @@ -68,9 +68,10 @@ su - postgres <application>make</> programs will <emphasis>not</> work. <acronym>GNU</> <application>make</> is often installed under the name <filename>gmake</filename>; this document will always - refer to it by that name. (On some systems GNU make is the - default tool with the name <filename>make</>.) To test for - <acronym>GNU</acronym> <application>make</application> enter + refer to it by that name. (On some systems + <acronym>GNU</acronym> make is the default tool with the name + <filename>make</>.) To test for <acronym>GNU</acronym> + <application>make</application> enter <screen> <userinput>gmake --version</userinput> </screen> @@ -137,9 +138,10 @@ su - postgres <listitem> <para> To build the server programming language PL/Perl you need a full - Perl installation, including the <filename>libperl</filename> - library and the header files. Since PL/Perl will be a shared - library, the <indexterm><primary>libperl</primary></indexterm> + <productname>Perl</productname> installation, including the + <filename>libperl</filename> library and the header files. + Since PL/Perl will be a shared library, the + <indexterm><primary>libperl</primary></indexterm> <filename>libperl</filename> library must be a shared library also on most platforms. This appears to be the default in recent Perl versions, but it was not in earlier versions, and in @@ -198,8 +200,8 @@ su - postgres url="http://www.python.org/doc/FAQ.html#3.30">Python FAQ 3.30</ulink>. On some operating systems you don't really have to build a shared library, but then you will have to convince - the PostgreSQL build system of this. Consult the - <filename>Makefile</filename> in the + the <productname>PostgreSQL</> build system of this. Consult + the <filename>Makefile</filename> in the <filename>src/pl/plpython</filename> directory for details. </para> </listitem> @@ -250,18 +252,18 @@ JAVACMD=$JAVA_HOME/bin/java <para> To enable Native Language Support (<acronym>NLS</acronym>), that is, the ability to display a program's messages in a language - other than English, you need an implementation of the <application>Gettext</> - <acronym>API</acronym>. Some operating systems have this - built-in (e.g., <systemitem class="osname">Linux</>, <systemitem - class="osname">NetBSD</>, <systemitem - class="osname">Solaris</>), for other systems you can download - an add-on package from here: <ulink + other than English, you need an implementation of the + <application>Gettext</> <acronym>API</acronym>. Some operating + systems have this built-in (e.g., <systemitem + class="osname">Linux</>, <systemitem class="osname">NetBSD</>, + <systemitem class="osname">Solaris</>), for other systems you + can download an add-on package from here: <ulink url="http://www.postgresql.org/~petere/gettext.html" ></ulink>. If you are using the <application>gettext</> implementation in - the GNU C library then you will additionally need the - <productname>GNU Gettext</productname> package for some utility - programs. For any of the other implementations you will not - need it. + the <acronym>GNU</acronym> C library then you will additionally + need the <productname>GNU Gettext</productname> package for some + utility programs. For any of the other implementations you will + not need it. </para> </listitem> @@ -276,9 +278,9 @@ JAVACMD=$JAVA_HOME/bin/java </para> <para> - If you are build from a CVS tree instead of using a released source - package, or if you want to do development, you also need the - following packages: + If you are build from a <acronym>CVS</acronym> tree instead of + using a released source package, or if you want to do development, + you also need the following packages: <itemizedlist> <listitem> @@ -1257,8 +1259,8 @@ libpq.so.2.1: cannot open shared object file: No such file or directory add <filename>/usr/local/pgsql/bin</> (or whatever you set <option><literal>--bindir</></> to in <xref linkend="configure">) into your <envar>PATH</>. Strictly speaking, this is not - necessary, but it will make the use of PostgreSQL much more - convenient. + necessary, but it will make the use of <productname>PostgreSQL</> + much more convenient. </para> <para> diff --git a/doc/src/sgml/jdbc.sgml b/doc/src/sgml/jdbc.sgml index 26a7468e0f..cb7a94c30e 100644 --- a/doc/src/sgml/jdbc.sgml +++ b/doc/src/sgml/jdbc.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.40 2002/11/11 07:31:28 barry Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.41 2002/11/15 03:11:16 momjian Exp $ --> <chapter id="jdbc"> @@ -51,16 +51,17 @@ $Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.40 2002/11/11 07:31:28 </para> <para> - Alternatively you can build the driver from source, but you - should only need to do this if you are making changes to the - source code. For details, refer to the PostgreSQL installation + Alternatively you can build the driver from source, but you should + only need to do this if you are making changes to the source code. + For details, refer to the <productname>PostgreSQL</> installation instructions. After installation, the driver should be found in <filename><replaceable>PREFIX</>/share/java/postgresql.jar</filename>. The resulting driver will be built for the version of Java you are - running. If you build with a 1.1 <acronym>JDK</> you will build a version - that supports the JDBC 1 specification, if you build with a Java 2 - <acronym>JDK</> (e.g., <acronym>JDK</> 1.2 or <acronym>JDK</> 1.3) you will build a version that - supports the JDBC 2 specification. + running. If you build with a 1.1 <acronym>JDK</> you will build a + version that supports the JDBC 1 specification, if you build with + a Java 2 <acronym>JDK</> (e.g., <acronym>JDK</> 1.2 or + <acronym>JDK</> 1.3) you will build a version that supports the + JDBC 2 specification. </para> </sect2> diff --git a/doc/src/sgml/libpgtcl.sgml b/doc/src/sgml/libpgtcl.sgml index df0c8b641a..e5af787d9a 100644 --- a/doc/src/sgml/libpgtcl.sgml +++ b/doc/src/sgml/libpgtcl.sgml @@ -1112,7 +1112,8 @@ The number of tuples affected or returned by the query. <TITLE>Description -pg_execute submits a query to the PostgreSQL backend. +pg_execute submits a query to the +PostgreSQL backend. If the query is not a SELECT statement, the query is executed and the diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 1e82dc1c93..e46693a2f6 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -1,5 +1,5 @@ @@ -957,12 +957,14 @@ strings overlap. PQescapeBytea returns an escaped version of the - from parameter binary string, to a caller-provided - buffer. The return string has all special characters replaced - so that they can be properly processed by the PostgreSQL string literal - parser, and the bytea input function. A terminating zero - byte is also added. The single quotes that must surround - PostgreSQL string literals are not part of the result string. + from parameter binary string, to a + caller-provided buffer. The return string has all special + characters replaced so that they can be properly processed by the + PostgreSQL string literal parser, and the + bytea input function. A terminating zero byte is also + added. The single quotes that must surround + PostgreSQL string literals are not part of the + result string. diff --git a/doc/src/sgml/manage-ag.sgml b/doc/src/sgml/manage-ag.sgml index 40b1a227d3..d23cab4f14 100644 --- a/doc/src/sgml/manage-ag.sgml +++ b/doc/src/sgml/manage-ag.sgml @@ -1,5 +1,5 @@ @@ -8,25 +8,26 @@ $Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.23 2002/11/11 20:14:03 p database - Every instance of a running PostgreSQL server manages one or more - databases. Databases are therefore the topmost hierarchical level - for organizing SQL objects (database objects). This - chapter describes the properties of databases, and how to create, - manage, and destroy them. + Every instance of a running PostgreSQL + server manages one or more databases. Databases are therefore the + topmost hierarchical level for organizing SQL + objects (database objects). This chapter describes + the properties of databases, and how to create, manage, and destroy + them. Overview - A database is a named collection of SQL objects (database - objects). Generally, every database object (tables, - functions, etc.) belongs to one and only one database. (But there - are a few system catalogs, for example pg_database, - that belong to a whole installation and are accessible from each - database within the installation.) More accurately, a database is - a collection of schemas and the schemas contain the tables, - functions, etc. So the full hierarchy is: + A database is a named collection of SQL objects + (database objects). Generally, every database + object (tables, functions, etc.) belongs to one and only one + database. (But there are a few system catalogs, for example + pg_database, that belong to a whole installation and + are accessible from each database within the installation.) More + accurately, a database is a collection of schemas and the schemas + contain the tables, functions, etc. So the full hierarchy is: server, database, schema, table (or something else instead of a table). @@ -41,13 +42,14 @@ $Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.23 2002/11/11 20:14:03 p connection. Schemas are a purely logical structure and who can access what is managed by the privilege system. Databases are physically separated and access control is managed at the - connection level. If one PostgreSQL server instance is to house - projects or users that should be separate and for the most part - unaware of each other, it is therefore recommendable to put them - into separate databases. If the projects or users are interrelated - and should be able to use each other's resources they should be put - in the same databases but possibly into separate schemas. More - information about managing schemas is in the &cite-user;. + connection level. If one PostgreSQL server + instance is to house projects or users that should be separate and + for the most part unaware of each other, it is therefore + recommendable to put them into separate databases. If the projects + or users are interrelated and should be able to use each other's + resources they should be put in the same databases but possibly + into separate schemas. More information about managing schemas is + in the &cite-user;. @@ -73,11 +75,11 @@ $Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.23 2002/11/11 20:14:03 p CREATE DATABASE name - where name follows the usual rules for SQL identifiers. - The current user automatically becomes - the owner of the new database. It is the privilege of the owner of - a database to remove it later on (which also removes all the - objects in it, even if they have a different owner). + where name follows the usual rules for + SQL identifiers. The current user automatically + becomes the owner of the new database. It is the privilege of the + owner of a database to remove it later on (which also removes all + the objects in it, even if they have a different owner). @@ -262,10 +264,10 @@ createdb -T template0 dbname Database Configuration - Recall from that the PostgreSQL - server provides a large number of run-time configuration variables. - You can set database-specific default values for many of these - settings. + Recall from that the + PostgreSQL server provides a large number of + run-time configuration variables. You can set database-specific + default values for many of these settings. diff --git a/doc/src/sgml/mvcc.sgml b/doc/src/sgml/mvcc.sgml index 81dbcc5d12..fbf6e68432 100644 --- a/doc/src/sgml/mvcc.sgml +++ b/doc/src/sgml/mvcc.sgml @@ -1,5 +1,5 @@ @@ -10,12 +10,13 @@ $Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.29 2002/11/11 20:14:03 petere - This chapter describes the behavior of the PostgreSQL database - system when two or more sessions try to access the same data at the - same time. The goals in that situation are to allow efficient - access for all sessions while maintaining strict data integrity. - Every developer of database applications should be familiar with - the topics covered in this chapter. + This chapter describes the behavior of the + PostgreSQL database system when two or + more sessions try to access the same data at the same time. The + goals in that situation are to allow efficient access for all + sessions while maintaining strict data integrity. Every developer + of database applications should be familiar with the topics covered + in this chapter. @@ -38,16 +39,17 @@ $Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.29 2002/11/11 20:14:03 petere The main difference between multiversion and lock models is that - in MVCC locks acquired for querying (reading) data don't conflict - with locks acquired for writing data, and so reading never blocks - writing and writing never blocks reading. + in MVCC locks acquired for querying (reading) + data don't conflict with locks acquired for writing data, and so + reading never blocks writing and writing never blocks reading. Table- and row-level locking facilities are also available in PostgreSQL for applications that cannot - adapt easily to MVCC behavior. However, proper use of MVCC will - generally provide better performance than locks. + adapt easily to MVCC behavior. However, proper + use of MVCC will generally provide better + performance than locks. @@ -380,14 +382,14 @@ ERROR: Can't serialize access due to concurrent update PostgreSQL provides various lock modes - to control concurrent access to data in tables. These modes can be - used for application-controlled locking in situations where MVCC - does not give the desired behavior. Also, most - PostgreSQL commands automatically - acquire locks of appropriate modes to ensure that referenced tables - are not dropped or modified in incompatible ways while the command - executes. (For example, ALTER TABLE cannot be executed - concurrently with other operations on the same table.) + to control concurrent access to data in tables. These modes can + be used for application-controlled locking in situations where + MVCC does not give the desired behavior. Also, + most PostgreSQL commands automatically + acquire locks of appropriate modes to ensure that referenced + tables are not dropped or modified in incompatible ways while the + command executes. (For example, ALTER TABLE cannot be + executed concurrently with other operations on the same table.) @@ -725,7 +727,7 @@ ERROR: Can't serialize access due to concurrent update - Global validity checks require extra thought under MVCC. For + Global validity checks require extra thought under MVCC. For example, a banking application might wish to check that the sum of all credits in one table equals the sum of debits in another table, when both tables are being actively updated. Comparing the results of two diff --git a/doc/src/sgml/programmer.sgml b/doc/src/sgml/programmer.sgml index 10eebfaeba..b872bc371a 100644 --- a/doc/src/sgml/programmer.sgml +++ b/doc/src/sgml/programmer.sgml @@ -1,5 +1,5 @@ @@ -24,18 +24,20 @@ PostgreSQL Programmer's Guide. What's In This Book - This book is for PostgreSQL application programmers. It is divided into three parts. + This book is for PostgreSQL application + programmers. It is divided into three parts. The first part of this book describes the client programming - interfaces distributed with PostgreSQL. Each of these chapters - can be read independently. Note that there are many other - programming interfaces for client programs that are distributed - separately and contain their own documentation. Readers of the - first part should be familiar with using SQL commands to - manipulate and query the database (see the &cite-user;) and of - course with the programming language that the interface uses. + interfaces distributed with PostgreSQL. Each of + these chapters can be read independently. Note that there are + many other programming interfaces for client programs that are + distributed separately and contain their own documentation. + Readers of the first part should be familiar with using + SQL commands to manipulate and query the + database (see the &cite-user;) and of course with the programming + language that the interface uses. @@ -43,7 +45,7 @@ PostgreSQL Programmer's Guide. functionality with user-defined functions, data types, triggers, etc. These are advanced topics which should probably be approached only after all the other user documentation about - PostgreSQL has been understood. + PostgreSQL has been understood. diff --git a/doc/src/sgml/ref/create_cast.sgml b/doc/src/sgml/ref/create_cast.sgml index 172b988a6a..98ed9c3a88 100644 --- a/doc/src/sgml/ref/create_cast.sgml +++ b/doc/src/sgml/ref/create_cast.sgml @@ -1,4 +1,4 @@ - + @@ -196,14 +196,14 @@ SELECT 'The time is ' || CAST(now() AS text); - Prior to PostgreSQL 7.3, every function that had the same name as a - data type, returned that data type, and took one argument of a - different type was automatically a cast function. This convention has - been abandoned in face of the introduction of schemas and to be - able to represent binary compatible casts in the catalogs. (The built-in - cast functions - still follow this naming scheme, but they have to be shown as - casts in pg_cast now.) + Prior to PostgreSQL 7.3, every function that had + the same name as a data type, returned that data type, and took one + argument of a different type was automatically a cast function. + This convention has been abandoned in face of the introduction of + schemas and to be able to represent binary compatible casts in the + catalogs. (The built-in cast functions still follow this naming + scheme, but they have to be shown as casts in pg_cast + now.) diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml index 990207b3fc..f419a12966 100644 --- a/doc/src/sgml/ref/create_database.sgml +++ b/doc/src/sgml/ref/create_database.sgml @@ -1,5 +1,5 @@ @@ -217,7 +217,7 @@ CREATE DATABASE name name. In particular, by writing TEMPLATE = template0, you can create a virgin database containing only the standard objects predefined by your - version of PostgreSQL. This is useful + version of PostgreSQL. This is useful if you wish to avoid copying any installation-local objects that may have been added to template1. diff --git a/doc/src/sgml/ref/ecpg-ref.sgml b/doc/src/sgml/ref/ecpg-ref.sgml index c2c8ec6eed..2a5f0f6ac6 100644 --- a/doc/src/sgml/ref/ecpg-ref.sgml +++ b/doc/src/sgml/ref/ecpg-ref.sgml @@ -1,5 +1,5 @@ @@ -157,9 +157,9 @@ PostgreSQL documentation When compiling the preprocessed C code files, the compiler needs to be able to find the ECPG header files in the - PostgreSQL include directory. Therefore, one might have to use the - diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index 6a5d1c037c..cd9e1fba35 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -1,5 +1,5 @@ @@ -87,7 +87,7 @@ EXPLAIN [ ANALYZE ] [ VERBOSE ] query - Prior to PostgreSQL 7.3, the query plan + Prior to PostgreSQL 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). @@ -105,12 +105,12 @@ EXPLAIN [ ANALYZE ] [ VERBOSE ] query This command displays the execution plan that the - PostgreSQL planner - generates for the supplied query. The execution plan shows how - the table(s) referenced by the query will be scanned---by plain - sequential scan, index scan, etc.---and if multiple tables are - referenced, what join algorithms will be used to bring together - the required tuples from each input table. + PostgreSQL planner generates for the + supplied query. The execution plan shows how the table(s) + referenced by the query will be scanned---by plain sequential scan, + index scan, etc.---and if multiple tables are referenced, what join + algorithms will be used to bring together the required tuples from + each input table. @@ -156,7 +156,7 @@ ROLLBACK; The VERBOSE option emits the full internal representation of the plan tree, rather than just a summary. Usually this option is only useful for debugging - PostgreSQL. The VERBOSE dump is either + PostgreSQL. The VERBOSE dump is either pretty-printed or not, depending on the setting of the configuration parameter. @@ -232,7 +232,7 @@ EXPLAIN SELECT sum(i) FROM foo WHERE i < 10; Note that the specific numbers shown, and even the selected query - strategy, may vary between PostgreSQL + strategy, may vary between PostgreSQL releases due to planner improvements. diff --git a/doc/src/sgml/ref/load.sgml b/doc/src/sgml/ref/load.sgml index 38fad94aaa..166f7aefa0 100644 --- a/doc/src/sgml/ref/load.sgml +++ b/doc/src/sgml/ref/load.sgml @@ -1,5 +1,5 @@ @@ -23,13 +23,14 @@ LOAD 'filename' Description - Loads a shared library file into the PostgreSQL backend's address - space. If the file had been loaded previously, it is first - unloaded. This command is primarily useful to unload and reload a - shared library file that has been changed since the backend first - loaded it. To make use of the - shared library, function(s) in it need to be declared using the command. + Loads a shared library file into the PostgreSQL + backend's address space. If the file had been loaded previously, + it is first unloaded. This command is primarily useful to unload + and reload a shared library file that has been changed since the + backend first loaded it. To make use of the shared library, + function(s) in it need to be declared using the + command. diff --git a/doc/src/sgml/ref/pg_config-ref.sgml b/doc/src/sgml/ref/pg_config-ref.sgml index 222058b7fc..e9adeb2c5e 100644 --- a/doc/src/sgml/ref/pg_config-ref.sgml +++ b/doc/src/sgml/ref/pg_config-ref.sgml @@ -1,4 +1,4 @@ - + @@ -131,7 +131,7 @@ The option is new in - PostgreSQL 7.2. In prior releases, the server include files were + PostgreSQL 7.2. In prior releases, the server include files were installed in the same location as the client headers, which could be queried with the . To make your package handle both cases, try the newer option first and test the @@ -139,7 +139,7 @@ - In releases prior to PostgreSQL 7.1, before the + In releases prior to PostgreSQL 7.1, before the pg_config came to be, a method for finding the equivalent configuration information did not exist. @@ -150,7 +150,8 @@ History - The pg_config utility first appeared in PostgreSQL 7.1. + The pg_config utility first appeared in + PostgreSQL 7.1. diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index ea4d0d6ea8..64b2e00b8b 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -1,5 +1,5 @@ @@ -274,11 +274,11 @@ PostgreSQL documentation pg_dump can handle databases from - previous releases of PostgreSQL, but very old versions are not - supported anymore (currently prior to 7.0). Use this option - if you need to override the version check (and if - pg_dump then fails, don't say you - weren't warned). + previous releases of PostgreSQL, but very old + versions are not supported anymore (currently prior to 7.0). + Use this option if you need to override the version check (and + if pg_dump then fails, don't say + you weren't warned). @@ -289,7 +289,7 @@ PostgreSQL documentation Dump object identifiers (OIDs) for every - table. Use this option if your application references the OID + table. Use this option if your application references the OID columns in some way (e.g., in a foreign key constraint). Otherwise, this option should not be used. diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index 2439d04086..2556f6f6bf 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -1,5 +1,5 @@ @@ -27,13 +27,13 @@ PostgreSQL documentation pg_dumpall is a utility for writing out - (dumping) all PostgreSQL databases of a cluster into - one script file. The script file contains SQL commands that can be - used as input to - to restore the databases. It does this by calling for each database - in a cluster. pg_dumpall also dumps - global objects that are common to all databases. + (dumping) all PostgreSQL databases + of a cluster into one script file. The script file contains + SQL commands that can be used as input to to restore the databases. It does this by + calling for each database in a cluster. + pg_dumpall also dumps global objects + that are common to all databases. (pg_dump does not save these objects.) This currently includes the information about database users and groups. @@ -139,11 +139,11 @@ PostgreSQL documentation pg_dumpall can handle databases - from previous releases of PostgreSQL, but very old versions - are not supported anymore (currently prior to 7.0). Use this - option if you need to override the version check (and if - pg_dumpall then fails, don't say - you weren't warned). + from previous releases of PostgreSQL, but very + old versions are not supported anymore (currently prior to + 7.0). Use this option if you need to override the version + check (and if pg_dumpall then + fails, don't say you weren't warned). diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index c380bb499e..72543dc7eb 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -1,4 +1,4 @@ - + @@ -417,11 +417,12 @@ - Presently, the commands emitted for @@ -522,12 +523,12 @@ connectDBStart() -- connect() failed: No such file or directory pg_restore could not attach to the - PostgreSQL server - process on the specified host and port. If you see this message, - ensure that the server - is running on the proper host and that you have specified the proper - port. If your site uses an authentication system, ensure that you - have obtained the required authentication credentials. + PostgreSQL server process on the specified + host and port. If you see this message, ensure that the + server is running on the proper host and that you have + specified the proper port. If your site uses an + authentication system, ensure that you have obtained the + required authentication credentials. @@ -537,7 +538,7 @@ connectDBStart() -- connect() failed: No such file or directory When a direct database connection is specified using the -d option, pg_restore internally executes - SQL statements. If you have problems running + SQL statements. If you have problems running pg_restore, make sure you are able to select information from the database using, for example, psql. diff --git a/doc/src/sgml/syntax.sgml b/doc/src/sgml/syntax.sgml index 55e9c7b641..6a54e12118 100644 --- a/doc/src/sgml/syntax.sgml +++ b/doc/src/sgml/syntax.sgml @@ -1,5 +1,5 @@ @@ -120,8 +120,8 @@ INSERT INTO MY_TABLE VALUES (3, 'hi there'); The system uses no more than NAMEDATALEN-1 characters of an identifier; longer names can be written in commands, but they will be truncated. By default, - NAMEDATALEN is 64 so the maximum identifier length - is 63 (but at the time PostgreSQL is built, + NAMEDATALEN is 64 so the maximum identifier + length is 63 (but at the time PostgreSQL is built, NAMEDATALEN can be changed in src/include/postgres_ext.h). @@ -652,15 +652,15 @@ CAST ( 'string' AS type ) shows the precedence and - associativity of the operators in PostgreSQL. Most operators have - the same precedence and are left-associative. The precedence and - associativity of the operators is hard-wired into the parser. - This may lead to non-intuitive behavior; for example the Boolean - operators < and > have a different - precedence than the Boolean operators <= and - >=. Also, you will sometimes need to add - parentheses when using combinations of binary and unary operators. - For instance + associativity of the operators in PostgreSQL. + Most operators have the same precedence and are left-associative. + The precedence and associativity of the operators is hard-wired + into the parser. This may lead to non-intuitive behavior; for + example the Boolean operators < and + > have a different precedence than the Boolean + operators <= and >=. Also, you will + sometimes need to add parentheses when using combinations of + binary and unary operators. For instance SELECT 5 ! - 6; diff --git a/doc/src/sgml/tutorial.sgml b/doc/src/sgml/tutorial.sgml index 55d340362e..7e2b87c28c 100644 --- a/doc/src/sgml/tutorial.sgml +++ b/doc/src/sgml/tutorial.sgml @@ -1,5 +1,5 @@ @@ -30,9 +30,9 @@ $Header: /cvsroot/pgsql/doc/src/sgml/Attic/tutorial.sgml,v 1.17 2002/10/24 17:48 these aspects. We only assume some general knowledge about how to use computers. No particular Unix or programming experience is required. This book is mainly intended to give you a hands-on - experience with important aspects of the PostgreSQL system. It - makes no attempt to be a complete or thorough treatment of the - topics it covers. + experience with important aspects of the + PostgreSQL system. It makes no attempt + to be a complete or thorough treatment of the topics it covers. diff --git a/doc/src/sgml/user.sgml b/doc/src/sgml/user.sgml index 86e64c8f37..14fb80aa2e 100644 --- a/doc/src/sgml/user.sgml +++ b/doc/src/sgml/user.sgml @@ -1,5 +1,5 @@ @@ -23,13 +23,15 @@ $Header: /cvsroot/pgsql/doc/src/sgml/Attic/user.sgml,v 1.34 2002/11/11 20:14:04 What's In This Book - This book describes the use of the SQL language in PostgreSQL. We - start with describing the general syntax of SQL, then explain how - to create the structures to hold data, how to populate the - database, and how to query it. The middle part lists the - available data types and functions for use in SQL data commands. - The rest of the book treats several aspects that are important for - tuning a database for optimal performance. + This book describes the use of the SQL language + in PostgreSQL. We start with + describing the general syntax of SQL, then + explain how to create the structures to hold data, how to populate + the database, and how to query it. The middle part lists the + available data types and functions for use in + SQL data commands. The rest of the book treats + several aspects that are important for tuning a database for + optimal performance. @@ -44,10 +46,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/Attic/user.sgml,v 1.34 2002/11/11 20:14:04 - Readers of this book should know how to connect to a PostgreSQL - database and issue SQL commands. Readers that are unfamiliar with - these issues are encouraged to read the &cite-tutorial; first. SQL - commands are typically entered using the PostgreSQL interactive + Readers of this book should know how to connect to a PostgreSQL + database and issue SQL commands. Readers that are unfamiliar with + these issues are encouraged to read the &cite-tutorial; first. SQL + commands are typically entered using the PostgreSQL interactive terminal psql, but other programs that have similar functionality can be used as well. diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index fba17d13bc..97e050f039 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -1,5 +1,5 @@ @@ -674,7 +674,7 @@ CREATE FUNCTION square_root(double precision) RETURNS double precision - The user ID the PostgreSQL server runs + The user ID the PostgreSQL server runs as must be able to traverse the path to the file you intend to load. Making the file or a higher-level directory not readable and/or not executable by the postgres user is a @@ -691,7 +691,7 @@ CREATE FUNCTION square_root(double precision) RETURNS double precision - PostgreSQL will not compile a C function + PostgreSQL will not compile a C function automatically. The object file must be compiled before it is referenced in a CREATE FUNCTION command. See for additional @@ -721,7 +721,7 @@ CREATE FUNCTION square_root(double precision) RETURNS double precision - Before PostgreSQL release 7.2, only exact + Before PostgreSQL release 7.2, only exact absolute paths to object files could be specified in CREATE FUNCTION. This approach is now deprecated since it makes the function definition unnecessarily unportable. It's best to specify -- 2.11.0