From: Neil Conway Date: Tue, 24 Aug 2004 00:06:51 +0000 (+0000) Subject: Various minor improvements to the SGML documentation: fix some incorrect X-Git-Tag: REL8_0_0BETA2~63 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=cda1bd6cfe8cad9943f0c1991b690313b5be9bef;p=postgresql Various minor improvements to the SGML documentation: fix some incorrect SGML markup, add a "deprecated features" section to the 8.0 release notes, untabify release.sgml and runtime.sgml, and make some other minor improvements. --- diff --git a/doc/src/sgml/errcodes.sgml b/doc/src/sgml/errcodes.sgml index ca3bc9ca4f..950f97151b 100644 --- a/doc/src/sgml/errcodes.sgml +++ b/doc/src/sgml/errcodes.sgml @@ -1,4 +1,4 @@ - + <productname>PostgreSQL</productname> Error Codes @@ -1133,7 +1133,7 @@ Class 58 -System Error (errors external to PostgreSQL itself) +System Error (errors external to PostgreSQL itself) diff --git a/doc/src/sgml/problems.sgml b/doc/src/sgml/problems.sgml index de10f7819a..f48305bc5d 100644 --- a/doc/src/sgml/problems.sgml +++ b/doc/src/sgml/problems.sgml @@ -1,5 +1,5 @@ @@ -11,8 +11,7 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.18 2004/03/09 16:57:46 neilc E PostgreSQL more reliable because even the utmost care cannot guarantee that every part of PostgreSQL - will work on every - platform under every circumstance. + will work on every platform under every circumstance. @@ -241,9 +240,9 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.18 2004/03/09 16:57:46 neilc E in each new release, so it is quite possible that a bug you have encountered in an older release of PostgreSQL has already been fixed. We can only provide limited support for - sites using older releases of PostgreSQL; if you require more - than we can provide, consider acquiring a commercial support - contract. + sites using older releases of PostgreSQL; if you + require more than we can provide, consider acquiring a + commercial support contract. diff --git a/doc/src/sgml/ref/alter_index.sgml b/doc/src/sgml/ref/alter_index.sgml index b1584918f5..4ce4a6871c 100644 --- a/doc/src/sgml/ref/alter_index.sgml +++ b/doc/src/sgml/ref/alter_index.sgml @@ -1,5 +1,5 @@ @@ -167,7 +167,8 @@ ALTER INDEX distributors SET TABLESPACE fasttablespace; Compatibility - ALTER INDEX is a PostgreSQL extension. + ALTER INDEX is a PostgreSQL + extension. diff --git a/doc/src/sgml/ref/alter_sequence.sgml b/doc/src/sgml/ref/alter_sequence.sgml index 673575b799..8337e27907 100644 --- a/doc/src/sgml/ref/alter_sequence.sgml +++ b/doc/src/sgml/ref/alter_sequence.sgml @@ -1,5 +1,5 @@ @@ -14,7 +14,7 @@ PostgreSQL documentation ALTER SEQUENCE - alter the definition of a sequence generator + change the definition of a sequence generator diff --git a/doc/src/sgml/ref/create_table_as.sgml b/doc/src/sgml/ref/create_table_as.sgml index 3cf823e78a..6c7566781b 100644 --- a/doc/src/sgml/ref/create_table_as.sgml +++ b/doc/src/sgml/ref/create_table_as.sgml @@ -1,5 +1,5 @@ @@ -11,7 +11,7 @@ PostgreSQL documentation CREATE TABLE AS - create a new table from the results of a query + define a new table from the results of a query diff --git a/doc/src/sgml/ref/create_tablespace.sgml b/doc/src/sgml/ref/create_tablespace.sgml index 04b23ca292..76161eb1ae 100644 --- a/doc/src/sgml/ref/create_tablespace.sgml +++ b/doc/src/sgml/ref/create_tablespace.sgml @@ -1,5 +1,5 @@ @@ -34,8 +34,8 @@ CREATE TABLESPACE tablespacename [ - A tablespace allows superusers to define an alternative location on the - file system where the data files representing database objects + A tablespace allows superusers to define an alternative location on + the file system where the data files containing database objects (such as tables and indexes) may reside. diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 7b8603a515..4e366944b6 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1,5 +1,5 @@ @@ -771,7 +771,7 @@ testdb=> Shows the copyright and distribution terms of - PostgreSQL. + PostgreSQL. diff --git a/doc/src/sgml/ref/release_savepoint.sgml b/doc/src/sgml/ref/release_savepoint.sgml index f75bce9f70..ca31c8dfd8 100644 --- a/doc/src/sgml/ref/release_savepoint.sgml +++ b/doc/src/sgml/ref/release_savepoint.sgml @@ -1,5 +1,5 @@ @@ -77,7 +77,7 @@ RELEASE [ SAVEPOINT ] savepoint_name It is not possible to release a savepoint when the transaction is in - aborted state. + an aborted state. @@ -108,9 +108,11 @@ COMMIT; Compatibility - The SQL2003 standard specifies that the keyword SAVEPOINT is mandatory. - PostgreSQL allows the SAVEPOINT keyword to be - omitted. Otherwise, this command is fully conforming. + The SQL2003 standard specifies that the keyword + SAVEPOINT is mandatory. + PostgreSQL allows the + SAVEPOINT keyword to be omitted. Otherwise, this + command is fully conforming. diff --git a/doc/src/sgml/ref/rollback_to.sgml b/doc/src/sgml/ref/rollback_to.sgml index 150145f383..63c295f590 100644 --- a/doc/src/sgml/ref/rollback_to.sgml +++ b/doc/src/sgml/ref/rollback_to.sgml @@ -1,5 +1,5 @@ @@ -128,13 +128,15 @@ COMMIT; Compatibility - The SQL2003 standard specifies that the keyword SAVEPOINT is mandatory. - PostgreSQL and Oracle - allow the SAVEPOINT keyword to be omitted. SQL2003 allows only - WORK, not TRANSACTION, as a noise word after ROLLBACK. Also, SQL2003 - has an optional clause AND [ NO ] CHAIN which is not currently supported - by PostgreSQL. Otherwise, this command is - fully conforming. + The SQL2003 standard specifies that the keyword + SAVEPOINT is mandatory. PostgreSQL and + Oracle allow the SAVEPOINT + keyword to be omitted. SQL2003 allows only WORK, not + TRANSACTION, as a noise word after + ROLLBACK. Also, SQL2003 has an optional clause + AND [ NO ] CHAIN which is not currently supported by + PostgreSQL. Otherwise, this command is fully + conforming. diff --git a/doc/src/sgml/ref/select_into.sgml b/doc/src/sgml/ref/select_into.sgml index edd341e6e6..5b3a98dbb6 100644 --- a/doc/src/sgml/ref/select_into.sgml +++ b/doc/src/sgml/ref/select_into.sgml @@ -1,5 +1,5 @@ @@ -11,7 +11,7 @@ PostgreSQL documentation SELECT INTO - create a new table from the results of a query + define a new table from the results of a query diff --git a/doc/src/sgml/release.sgml b/doc/src/sgml/release.sgml index c8c9e4c5fb..d72b07b79f 100644 --- a/doc/src/sgml/release.sgml +++ b/doc/src/sgml/release.sgml @@ -1,5 +1,5 @@ @@ -27,77 +27,80 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - This is the first PostgreSQL release to natively run on Microsoft - Windows as a server. It can run as a Windows service. This release - supports NT-based Windows releases like Win2000, XP, Win2003. - Older releases like Windows 95, 98, and ME are not supported because - these operating systems do not have the infrastructure to - support PostgreSQL. A separate installer project has been created - to ease installation on Windows: + This is the first PostgreSQL + release to natively run on Microsoft Windows as a server. It + can run as a Windows service. This release supports NT-based + Windows releases like Win2000, XP, Win2003. Older releases + like Windows 95, 98, and ME are not supported because these + operating systems do not have the infrastructure to support + PostgreSQL. A separate installer + project has been created to ease installation on Windows: - http://pgfoundry.org/projects/pginstaller. + http://pgfoundry.org/projects/pginstaller. Previous releases required the Unix emulation toolkit Cygwin for - Win32 server support. PostgreSQL has always supported clients on Win32. + Win32 server support. PostgreSQL + has always supported clients on Win32. - Savepoints Improve Transaction Control + Savepoints Savepoints allow specific parts of a transaction to be aborted without affecting the remainder of the transaction. Prior - releases had no such capability; there was no way to recover from - a statement failure within a transaction except by aborting the whole - transaction. This feature is valuable - for application writers who require error recovery within a - complex transaction. + releases had no such capability; there was no way to recover + from a statement failure within a transaction except by + aborting the whole transaction. This feature is valuable for + application writers who require error recovery within a + complex transaction. - Point-In-Time Recovery Increases Reliability + Point-In-Time Recovery - Though PostgreSQL is very reliable, in previous releases there - was no way to recover from disk drive failure except to restore - from a previous backup or use a standby replication server. - Point-in-time recovery allows continuous backup of the server. - You can recover either to the point of failure or to some - transaction in the past. + Though PostgreSQL is very reliable, + in previous releases there was no way to recover from disk + drive failure except to restore from a previous backup or use + a standby replication server. Point-in-time recovery allows + continuous backup of the server. You can recover either to + the point of failure or to some transaction in the past. - Tablespaces Simplify Disk Layout + Tablespaces - Tablespaces allow administrators - to select the file systems used for storage of databases, - schemas, tables, or indexes. This improves performance and - control over disk space usage. Prior releases used - initlocation and manual symlink management for such tasks. + Tablespaces allow administrators to select the file systems + used for storage of databases, schemas, tables, or + indexes. This improves performance and control over disk space + usage. Prior releases used initlocation and + manual symlink management for such tasks. - Improved Buffer Management, CHECKPOINT, VACUUM + Improved Buffer Management, CHECKPOINT, + VACUUM @@ -117,7 +120,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - A column's data type can now be changed with ALTER TABLE. + A column's data type can now be changed with ALTER + TABLE. @@ -130,22 +134,22 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian A new version of the plperl server-side language now - supports a persistent shared storage area, triggers, returning records - and arrays of records, and SPI calls to access the database. + supports a persistent shared storage area, triggers, returning records + and arrays of records, and SPI calls to access the database. - COPY Handles Comma-Separated-Value Files + CSV support in COPY - COPY can now read and write comma-separated-value (CSV) files. It - has the flexibility to interpret non-standard quoting and - separation characters too. + COPY can now read and write + comma-separated-value (CSV) files. It has the flexibility to + interpret non-standard quoting and separation characters too. @@ -181,9 +185,10 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian Server configuration parameters SortMem and - VacuumMem have been renamed to work_mem and - maintenance_work_mem to better reflect their use. The - original names are still supported in SET and SHOW. + VacuumMem have been renamed to work_mem + and maintenance_work_mem to better reflect their + use. The original names are still supported in + SET and SHOW. @@ -246,8 +251,9 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - The server now warns of empty strings passed to oid/float4/float8 - data types. In the next major release, doing this will generate an + The server now warns of empty strings passed to + oid/float4/float8 data + types. In the next major release, doing this will generate an error. @@ -292,8 +298,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - EXECUTE now returns a completion tag that matches the executed - statement. + EXECUTE now returns a completion tag that + matches the executed statement. @@ -307,8 +313,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Now that tablespaces have been implemented, initlocation has been - removed. + Now that tablespaces have been implemented, + initlocation has been removed. @@ -321,17 +327,45 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian ignored as well as leading whitespace (which has always been ignored). - - - - The 8.1 release will remove the function to_char(interval) - . - - + + Deprecated Features + + + Some aspects of PostgreSQL's behavior + have been determined to be suboptimal. For the sake of backward + compatibility these have not been removed in 8.0, but they are + considered deprecated and will be removed in the next major + release. + + + + + + The 8.1 release will remove the function + to_char(interval). + + + + + + By default, tables in PostgreSQL 8.0 + and earlier are created with OIDs. In the next release, this + will not be the case: to create a table + that contains OIDs, the WITH OIDS clause must + be specified or the default_with_oids + configuration parameter must be enabled. Users are encouraged to + explicitely specify WITH OIDS if their tables + require OIDs for compatibility with future releases of + PostgreSQL. + + + + + Changes @@ -396,10 +430,11 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian Add ability to prolong vacuum to reduce performance impact (Jan) - On busy systems, VACUUM performs many I/O requests which can hurt - performance for other users. This release allows you to slow down - VACUUM to reduce its impact on other users, though this increases the - total duration of VACUUM. + On busy systems, VACUUM performs many I/O + requests which can hurt performance for other users. This + release allows you to slow down VACUUM to + reduce its impact on other users, though this increases the + total duration of VACUUM. @@ -469,7 +504,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Add type-specific ANALYZE statistics capability (Mark Cave-Ayland) + Add type-specific ANALYZE statistics + capability (Mark Cave-Ayland) This feature allows more flexibility in generating statistics @@ -479,7 +515,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Allow collection of ANALYZE statistics for expression indexes (Tom) + Allow collection of ANALYZE statistics for + expression indexes (Tom) Expression indexes (also called functional indexes) allow users to @@ -493,7 +530,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - New two-stage sampling method for ANALYZE (Manfred Koizar) + New two-stage sampling method for ANALYZE + (Manfred Koizar) This gives better statistics for asymmetric data distributions. @@ -502,11 +540,11 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Speed up TRUNCATE (Tom) + Speed up TRUNCATE (Tom) This buys back some of the performance loss observed in 7.4, while still - keeping TRUNCATE transaction-safe. + keeping TRUNCATE transaction-safe. @@ -671,23 +709,27 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Allow DECLARE CURSOR to take parameters (Oliver Jowett) + Allow DECLARE CURSOR to take parameters + (Oliver Jowett) - It is now useful to issue DECLARE CURSOR in a Parse message with - parameters. The parameter values sent at Bind time will be substituted - into the execution of the cursor's query. + It is now useful to issue DECLARE CURSOR in a + Parse message with parameters. The parameter values sent at + Bind time will be substituted into the execution of the cursor's + query. - Fix hash joins and aggregates of INET and CIDR data types (Tom) + Fix hash joins and aggregates of inet and + cidr data types (Tom) - Release 7.4 handled hashing of mixed INET and CIDR values incorrectly. - (This bug did not exist in prior releases because they wouldn't try - to hash either datatype.) + Release 7.4 handled hashing of mixed inet and + cidr values incorrectly. (This bug did not exist + in prior releases because they wouldn't try to hash either + datatype.) @@ -719,8 +761,9 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Allow BEGIN WORK to specify transaction isolation levels like START - TRANSACTION (Bruce) + Allow BEGIN WORK to specify transaction + isolation levels like START TRANSACTION does + (Bruce) @@ -824,12 +867,13 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Change EXECUTE to return a completion tag matching the executed statement - (Kris Jurka) + Change EXECUTE to return a completion tag + matching the executed statement (Kris Jurka) - Previous releases return an EXECUTE tag for any EXECUTE call. In - this release, the tag returned will reflect the command executed. + Previous releases return an EXECUTE tag for + any EXECUTE call. In this release, the tag + returned will reflect the command executed. @@ -864,14 +908,15 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian control whether tables are created with OIDs by default (Neil) - This allows administrators to default all CREATE TABLE commands to - create tables without OID columns. + This allows administrators to default all CREATE + TABLE commands to create tables without OID columns. - Add WITH / WITHOUT OIDS clause to CREATE TABLE AS (Neil) + Add WITH / WITHOUT OIDS clause to CREATE TABLE + AS (Neil) @@ -911,7 +956,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Allow multiple ALTER actions in a single ALTER TABLE command (Rod) + Allow multiple ALTER actions in a single ALTER + TABLE command (Rod) This is particularly useful for ALTER commands that rewrite the @@ -923,7 +969,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Allow ALTER TABLE to add SERIAL columns (Tom) + Allow ALTER TABLE to add serial + columns (Tom) This is related to the new capability of adding defaults for new @@ -996,13 +1043,15 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Allow CREATE SCHEMA to create triggers, indexes, and sequences (Neil) + Allow CREATE SCHEMA to create triggers, + indexes, and sequences (Neil) - Add ALSO keyword to CREATE RULE (Fabien Coelho) + Add ALSO keyword to CREATE RULE (Fabien + Coelho) This allows ALSO to be added to rule creation to contrast it with @@ -1012,23 +1061,25 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Add NOWAIT option to LOCK command (Tatsuo) + Add NOWAIT option to LOCK (Tatsuo) - This allows the LOCK command to fail if it would have to wait for - the requested lock. + This allows the LOCK command to fail if it + would have to wait for the requested lock. - Allow COPY to read and write comma-separated-value (CSV) files (Andrew, Bruce) + Allow COPY to read and write + comma-separated-value (CSV) files (Andrew, Bruce) - Generate error if the COPY delimiter and NULL string conflict (Bruce) + Generate error if the COPY delimiter and NULL + string conflict (Bruce) @@ -1040,7 +1091,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Avoid locking conflict between CREATE INDEX and CHECKPOINT (Tom) + Avoid locking conflict between CREATE INDEX + and CHECKPOINT (Tom) In 7.3 and 7.4, a long-running btree index build could block concurrent @@ -1051,14 +1103,16 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Database-wide ANALYZE does not hold locks across tables (Tom) + Database-wide ANALYZE does not hold locks + across tables (Tom) - This reduces the potential for deadlocks against other backends that - want exclusive locks on tables. To get the benefit of this change, - do not execute database-wide ANALYZE inside a transaction block - (BEGIN block); it must be able to commit and start a new transaction - for each table. + This reduces the potential for deadlocks against other backends + that want exclusive locks on tables. To get the benefit of this + change, do not execute database-wide ANALYZE + inside a transaction block (BEGIN block); it + must be able to commit and start a new transaction for each + table. @@ -1067,11 +1121,12 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian Erase MD5 user passwords when a user is renamed (Bruce) - PostgreSQL uses the user name as salt when encrypting passwords - via MD5. When a user name is changed, their salt no longer matches - the stored MD5 password, so the stored password becomes useless. - In this release a notice is generated and the password - is cleared. A new password must then be assigned. + PostgreSQL uses the user name as salt + when encrypting passwords via MD5. When a user name is changed, + their salt no longer matches the stored MD5 password, so the + stored password becomes useless. In this release a notice is + generated and the password is cleared. A new password must then + be assigned. @@ -1127,7 +1182,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian Reject non-rectangular array literals as erroneous (Joe) - Formerly, array_in would silently build a surprising result. + Formerly, array_in would silently build a + surprising result. @@ -1174,11 +1230,11 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Change factorial function to return NUMERIC (Gavin) + Change factorial function to return numeric (Gavin) - Returning NUMERIC allows the factorial function to work for a wider - range of input values. + Returning numeric allows the factorial function to + work for a wider range of input values. @@ -1217,7 +1273,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Better support for IEEE Infinity and NaN values in float4, float8 (Neil) + Better support for IEEE Infinity and NaN values in + float4, float8 (Neil) These should now work on all platforms that support IEEE-compliant @@ -1448,7 +1505,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Make psql \copy match COPY command syntax fully (Tom) + Make psql \copy match COPY command syntax + fully (Tom) @@ -1460,7 +1518,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Add CLUSTER information to psql \d display (Bruce) + Add CLUSTER information to psql \d display + (Bruce) @@ -1478,7 +1537,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Add global psql config file, psqlrc.sample (Bruce) + Add global psql config file, psqlrc.sample + (Bruce) This allows a central file where global psql startup commands can @@ -1594,8 +1654,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - Allow PQoidValue(), PQcmdTuples(), and PQoidStatus() to work - on EXECUTE commands (Neil) + Allow PQoidValue(), PQcmdTuples(), and PQoidStatus() to work on + EXECUTE commands (Neil) @@ -1665,10 +1725,11 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian New "PostgreSQL" CVS tag (Marc) - This was done to make it easier for organizations to manage their own - copies of the PostgreSQL CVS repository. File version stamps from the - master repository will not get munged by checking into or out of - a copied repository. + This was done to make it easier for organizations to manage + their own copies of the PostgreSQL + CVS repository. File version stamps from the master repository + will not get munged by checking into or out of a copied + repository. @@ -1880,7 +1941,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.287 2004/08/21 03:25:34 momjian - New /contrib/trgm, trigram matching for PostgreSQL (Teodor) + New /contrib/trgm, trigram matching for + PostgreSQL (Teodor) @@ -2037,7 +2099,7 @@ names from outer query levels. This fixes a difficult-to-exploit security hole. -Avoid locking conflict between ANALYZE and LISTEN/NOTIFY +Avoid locking conflict between ANALYZE and LISTEN/NOTIFY Numerous translation updates (various contributors) diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml index 9cca707519..bdf029fa64 100644 --- a/doc/src/sgml/runtime.sgml +++ b/doc/src/sgml/runtime.sgml @@ -1,5 +1,5 @@ @@ -1206,17 +1206,16 @@ SET ENABLE_SEQSCAN TO OFF; Specifies the delay between activity rounds for the - background writer. In each round the writer issues writes for some - number of dirty buffers (controllable by the following parameters). - The selected buffers will always be the - least recently used ones among the currently dirty buffers. - It then sleeps for bgwriter_delay milliseconds, - and repeats. - Note that on many systems, the effective resolution - of sleep delays is 10 milliseconds; setting - bgwriter_delay to a value that is - not a multiple of 10 may have the same results as setting it - to the next higher multiple of 10. + background writer. In each round the writer issues writes + for some number of dirty buffers (controllable by the + following parameters). The selected buffers will always be + the least recently used ones among the currently dirty + buffers. It then sleeps for bgwriter_delay + milliseconds, and repeats. The default value is 200. Note + that on many systems, the effective resolution of sleep + delays is 10 milliseconds; setting bgwriter_delay + to a value that is not a multiple of 10 may have the same + results as setting it to the next higher multiple of 10. This option can only be set at server start or in the postgresql.conf file. @@ -1227,10 +1226,10 @@ SET ENABLE_SEQSCAN TO OFF; bgwriter_percent (integer) - In each round, no more than this percentage of the currently dirty - buffers will be written (rounding up any fraction to the next whole - number of buffers). - This option can only be set at server start or in the + In each round, no more than this percentage of the currently + dirty buffers will be written (rounding up any fraction to + the next whole number of buffers). The default value is + 1. This option can only be set at server start or in the postgresql.conf file. @@ -1240,8 +1239,9 @@ SET ENABLE_SEQSCAN TO OFF; bgwriter_maxpages (integer) - In each round, no more than this many dirty buffers will be written. - This option can only be set at server start or in the + In each round, no more than this many dirty buffers will be + written. The default value is 100. This option can only be + set at server start or in the postgresql.conf file. @@ -1250,9 +1250,10 @@ SET ENABLE_SEQSCAN TO OFF; Smaller values of bgwriter_percent and - bgwriter_maxpages reduce the extra I/O load caused by - the background writer, but leave more work to be done at checkpoint - time. To reduce load spikes at checkpoints, increase the values. + bgwriter_maxpages reduce the extra I/O load + caused by the background writer, but leave more work to be done + at checkpoint time. To reduce load spikes at checkpoints, + increase the values. @@ -1448,7 +1449,7 @@ SET ENABLE_SEQSCAN TO OFF; It is important for the command to return a zero exit status only if - it succeeds. Examples: + it succeeds. Examples: archive_command = 'cp "%p" /mnt/server/archivedir/"%f"' archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 @@ -1880,14 +1881,14 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 log_destination (string) - PostgreSQL supports several methods - for logging server messages, including - stderr and - syslog. On Windows, - eventlog is also supported. Set this - option to a list of desired log destinations separated by - commas. The default is to log to stderr - only. + PostgreSQL supports several methods + for logging server messages, including + stderr and + syslog. On Windows, + eventlog is also supported. Set this + option to a list of desired log destinations separated by + commas. The default is to log to stderr + only. This option can only be set at server start or in the postgresql.conf configuration file. @@ -1898,14 +1899,14 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 redirect_stderr (boolean) - This option allows messages sent to stderr to be - captured and redirected into log files. - This option, in combination with logging to stderr, - is often more useful than - logging to syslog, since some types of messages - may not appear in syslog output (a common example - is dynamic-linker failure messages). - This option can only be set at server start. + This option allows messages sent to stderr to be + captured and redirected into log files. + This option, in combination with logging to stderr, + is often more useful than + logging to syslog, since some types of messages + may not appear in syslog output (a common example + is dynamic-linker failure messages). + This option can only be set at server start. @@ -1914,10 +1915,10 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 log_directory (string) - When redirect_stderr is enabled, this option + When redirect_stderr is enabled, this option determines the directory in which log files will be created. - It may be specified as an absolute path, or relative to the - cluster data directory. + It may be specified as an absolute path, or relative to the + cluster data directory. This option can only be set at server start or in the postgresql.conf configuration file. @@ -1928,10 +1929,10 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 log_filename_prefix (string) - When redirect_stderr is enabled, this option + When redirect_stderr is enabled, this option sets the prefix of the file names of the created log files. - The postmaster PID and the current time are appended to this - prefix to form an exact log file name. + The postmaster PID and the current time are appended to this + prefix to form an exact log file name. This option can only be set at server start or in the postgresql.conf configuration file. @@ -1942,11 +1943,11 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 log_rotation_age (integer) - When redirect_stderr is enabled, this option - determines the maximum lifetime of an individual log file. - After this many minutes have elapsed, a new log file will - be created. Set to zero to disable time-based creation of - new log files. + When redirect_stderr is enabled, this option + determines the maximum lifetime of an individual log file. + After this many minutes have elapsed, a new log file will + be created. Set to zero to disable time-based creation of + new log files. This option can only be set at server start or in the postgresql.conf configuration file. @@ -1957,11 +1958,11 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 log_rotation_size (integer) - When redirect_stderr is enabled, this option - determines the maximum size of an individual log file. - After this many kilobytes have been emitted into a log file, - a new log file will be created. Set to zero to disable size-based - creation of new log files. + When redirect_stderr is enabled, this option + determines the maximum size of an individual log file. + After this many kilobytes have been emitted into a log file, + a new log file will be created. Set to zero to disable size-based + creation of new log files. This option can only be set at server start or in the postgresql.conf configuration file. @@ -1981,7 +1982,7 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 the default is LOCAL0. See also the documentation of your system's syslog daemon. - This option can only be set at server start. + This option can only be set at server start. @@ -1995,7 +1996,7 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 PostgreSQL messages in syslog logs. The default is postgres. - This option can only be set at server start. + This option can only be set at server start. @@ -2107,9 +2108,9 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 terminals are disassociated (same effect as postmaster's option). The server's standard output and standard error are redirected - to /dev/null, so any messages sent to them will be lost. - Unless syslog logging is selected or - redirect_stderr is enabled, using this option + to /dev/null, so any messages sent to them will be lost. + Unless syslog logging is selected or + redirect_stderr is enabled, using this option is discouraged because it makes it impossible to see error messages. @@ -2271,95 +2272,95 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 log_line_prefix (string) - This is a printf-style string that is output at the - beginning of each log line. The default is an empty string. - Each recognized escape is replaced as outlined - below - anything else that looks like an escape is ignored. Other - characters are copied straight to the log line. Some escapes are - only recognised by session processes, and do not apply to - background processes such as the postmaster. Syslog + This is a printf-style string that is output at the + beginning of each log line. The default is an empty string. + Each recognized escape is replaced as outlined + below - anything else that looks like an escape is ignored. Other + characters are copied straight to the log line. Some escapes are + only recognised by session processes, and do not apply to + background processes such as the postmaster. Syslog produces its own - timestamp and process ID information, so you probably do not want to - use those escapes if you are using syslog. - This option can only be set at server start or in the + timestamp and process ID information, so you probably do not want to + use those escapes if you are using syslog. + This option can only be set at server start or in the postgresql.conf configuration file. - - - - - Escape - Effect - Session only - - - - - %u - User Name - Yes - - - %d - Database Name - Yes - - - %r - Remote Hostname or IP address, and Remote Port - Yes - - - %p - Process ID - No - - - %t - Timestamp - No - - - %i - Command Tag. This is the command which generated the log - line. - Yes - - - %c - Session ID. A unique identifier for each session. - It is 2 4-byte hexadecimal numbers (without leading zeros) + + + + + Escape + Effect + Session only + + + + + %u + User Name + Yes + + + %d + Database Name + Yes + + + %r + Remote Hostname or IP address, and Remote Port + Yes + + + %p + Process ID + No + + + %t + Timestamp + No + + + %i + Command Tag. This is the command which generated the log + line. + Yes + + + %c + Session ID. A unique identifier for each session. + It is 2 4-byte hexadecimal numbers (without leading zeros) separated by a dot. The numbers - are the Session Start Time and the Process ID, so this can also - be used as a space saving way of printing these items. - Yes - - - %l - Number of the log line for each process, - starting at 1 - No - - - %s - Session Start Timestamp - Yes - - - %x - Does not produce any output, but tells non-session - processes to stop at this point in the string. Ignored by - session processes. - No - - - %% - Literal % - No - - - - + are the Session Start Time and the Process ID, so this can also + be used as a space saving way of printing these items. + Yes + + + %l + Number of the log line for each process, + starting at 1 + No + + + %s + Session Start Timestamp + Yes + + + %x + Does not produce any output, but tells non-session + processes to stop at this point in the string. Ignored by + session processes. + No + + + %% + Literal % + No + + + + @@ -2861,7 +2862,7 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Win32 The value for dynamic_library_path has to be a list of absolute directory paths separated by colons (or semi-colons - on Windows). If a list element starts + on Windows). If a list element starts with the special string $libdir, the compiled-in PostgreSQL package library directory is substituted for $libdir. This @@ -3138,8 +3139,8 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir' Shows the locale in which sorting of textual data is done. - See for more information. - The value is determined when the database cluster is initialized. + See for more information. + The value is determined when the database cluster is initialized. @@ -3149,10 +3150,10 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir' Shows the locale that determines character classifications. - See for more information. - The value is determined when the database cluster is initialized. - Ordinarily this will be the same as lc_collate, - but for special applications it might be set differently. + See for more information. + The value is determined when the database cluster is initialized. + Ordinarily this will be the same as lc_collate, + but for special applications it might be set differently. @@ -3240,7 +3241,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir' variable is a variable not normally known to PostgreSQL proper but used by some add-on module. Such variables must have names consisting of a class - name, a dot, and a variable name. custom_variable_classes + name, a dot, and a variable name. custom_variable_classes specifies all the class names in use in a particular installation. This option can only be set at server start or in the postgresql.conf configuration file. diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index 2f99f062b5..684da2a374 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -1,5 +1,5 @@ @@ -1618,17 +1618,18 @@ concat_text(PG_FUNCTION_ARGS) - If you are thinking about distributing your PostgreSQL extension - modules, setting up a portable build system for them can be fairly - difficult. Therefore the PostgreSQL installation provides a build + If you are thinking about distributing your + PostgreSQL extension modules, setting up a + portable build system for them can be fairly difficult. Therefore + the PostgreSQL installation provides a build infrastructure for extensions, called PGXS, so that simple extension modules can be built simply against an already installed server. Note that this infrastructure is not intended to be a universal build system framework that can be used - to build all software interfacing to PostgreSQL; it simply - automates common build rules for simple server extension modules. - For more complicated packages, you need to write your own build - system. + to build all software interfacing to PostgreSQL; + it simply automates common build rules for simple server extension + modules. For more complicated packages, you need to write your + own build system. @@ -1807,14 +1808,13 @@ include $(PGXS) Composite-Type Arguments in C-Language Functions - Composite types do not have a fixed layout like C - structures. Instances of a composite type may contain - null fields. In addition, composite types that are - part of an inheritance hierarchy may have different - fields than other members of the same inheritance hierarchy. - Therefore, PostgreSQL provides - a function interface for accessing fields of composite types - from C. + Composite types do not have a fixed layout like C structures. + Instances of a composite type may contain null fields. In + addition, composite types that are part of an inheritance + hierarchy may have different fields than other members of the + same inheritance hierarchy. Therefore, + PostgreSQL provides a function + interface for accessing fields of composite types from C.