diff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgml
index 07190c5eff2..6b13a0abefb 100644
--- a/doc/src/sgml/contrib.sgml
+++ b/doc/src/sgml/contrib.sgml
@@ -4,7 +4,7 @@
Additional Supplied Modules
- This appendix contains information regarding the modules that
+ This appendix and the next one contain information regarding the modules that
can be found in the contrib directory of the
PostgreSQL distribution.
These include porting tools, analysis utilities,
@@ -15,7 +15,13 @@
- When building from the source distribution, these modules are not built
+ This appendix covers extensions and other server plug-in modules found in
+ contrib. covers utility
+ programs.
+
+
+
+ When building from the source distribution, these components are not built
automatically, unless you build the "world" target
(see ).
You can build and install all of them by running:
@@ -88,6 +94,14 @@ CREATE EXTENSION module_name FROM unpackaged;
.
+
+ Note, however, that some of these modules are not extensions
+ in this sense, but are loaded into the server in some other way, for instance
+ by way of
+ . See the documentation of each
+ module for details.
+
+
&adminpack;
&auth-delay;
&auto-explain;
@@ -109,22 +123,15 @@ CREATE EXTENSION module_name FROM unpackaged;
&isn;
&lo;
<ree;
- &oid2name;
&pageinspect;
&passwordcheck;
- &pgarchivecleanup;
- &pgbench;
&pgbuffercache;
&pgcrypto;
&pgfreespacemap;
&pgrowlocks;
- &pgstandby;
&pgstatstatements;
&pgstattuple;
- &pgtestfsync;
- &pgtesttiming;
&pgtrgm;
- &pgupgrade;
&seg;
&sepgsql;
&contrib-spi;
@@ -135,7 +142,69 @@ CREATE EXTENSION module_name FROM unpackaged;
&tsearch2;
&unaccent;
&uuid-ossp;
- &vacuumlo;
&xml2;
+
+
+
+
+ Additional Supplied Programs
+
+
+ This appendix and the previous one contain information regarding the modules that
+ can be found in the contrib directory of the
+ PostgreSQL distribution. See for
+ more information about the contrib section in general and
+ server extensions and plug-ins found in contrib
+ specifically.
+
+
+
+ This appendix covers utility programs found in contrib.
+ Once installed, either from source or a packaging system, they are found in
+ the bin directory of the
+ PostgreSQL installation and can be used like any
+ other program.
+
+
+
+ Client Applications
+
+
+ This section covers PostgreSQL client
+ applications in contrib. They can be run from anywhere,
+ independent of where the database server resides. See
+ also for information about client
+ applications that part of the core PostgreSQL
+ distribution.
+
+
+ &oid2name;
+ &pgbench;
+ &vacuumlo;
+
+
+
+ Server Applications
+
+
+ This section covers PostgreSQL server-related
+ applications in contrib. They are typically run on the
+ host where the database server resides. See also for information about server applications that
+ part of the core PostgreSQL distribution.
+
+
+ &pgarchivecleanup;
+ &pgstandby;
+ &pgtestfsync;
+ &pgtesttiming;
+ &pgupgrade;
+
+
diff --git a/doc/src/sgml/docguide.sgml b/doc/src/sgml/docguide.sgml
index 0b40a57fd99..8aaafb0a340 100644
--- a/doc/src/sgml/docguide.sgml
+++ b/doc/src/sgml/docguide.sgml
@@ -1240,6 +1240,15 @@ save_size.pdfjadetex = 15000
+
+ Author
+
+
+ Author (only used in the contrib section)
+
+
+
+
See Also
diff --git a/doc/src/sgml/oid2name.sgml b/doc/src/sgml/oid2name.sgml
index 3e4fe24a49f..a4c83925aba 100644
--- a/doc/src/sgml/oid2name.sgml
+++ b/doc/src/sgml/oid2name.sgml
@@ -1,12 +1,31 @@
-
- oid2name
+
+
+ oid2name
+ 1
+ Application
+
+
+
+ oid2name
+ resolve OIDs and file nodes in a PostgreSQL data directory
+ oid2name
+
+
+ oid2name
+ option
+
+
+
+
+ Description
+
oid2name is a utility program that helps administrators to
examine the file structure used by PostgreSQL. To make use of it, you need
@@ -24,19 +43,16 @@
-
- Overview
-
oid2name connects to a target database and
extracts OID, filenode, and/or table name information. You can also have
it show database OIDs or tablespace OIDs.
-
+
-
- <application>oid2name</> Options
+
+ Optionsoid2name accepts the following command-line arguments:
@@ -142,9 +158,19 @@
OIDs. Alternatively you can give
-
+
-
+
+ Notes
+
+
+ oid2name requires a running database server with
+ non-corrupt system catalogs. It is therefore of only limited use
+ for recovering from catastrophic database corruption situations.
+
+
+
+ Examples
@@ -265,24 +291,14 @@ From database "alvherre":
----------------------
155156 foo
-
+
-
- Limitations
-
-
- oid2name requires a running database server with
- non-corrupt system catalogs. It is therefore of only limited use
- for recovering from catastrophic database corruption situations.
-
-
-
-
+ Author
B. Palmer bpalmer@crimelabs.net
-
+
-
+
diff --git a/doc/src/sgml/pgarchivecleanup.sgml b/doc/src/sgml/pgarchivecleanup.sgml
index 40bac854700..4ae9c45f87f 100644
--- a/doc/src/sgml/pgarchivecleanup.sgml
+++ b/doc/src/sgml/pgarchivecleanup.sgml
@@ -1,12 +1,33 @@
-
- pg_archivecleanup
+
+
+ pg_archivecleanup
+ 1
+ Application
+
+
+
+ pg_archivecleanup
+ clean up PostgreSQL WAL archive files
+ pg_archivecleanup
+
+
+ pg_archivecleanup
+ option
+ archivelocation
+ oldestkeptwalfile
+
+
+
+
+ Description
+
pg_archivecleanup is designed to be used as an
archive_cleanup_command to clean up WAL file archives when
@@ -15,26 +36,6 @@
clean WAL file archives.
-
- pg_archivecleanup features include:
-
-
-
-
- Written in C, so very portable and easy to install
-
-
-
-
- Easy-to-modify source code, with specifically designated
- sections to modify for your own needs
-
-
-
-
-
- Usage
-
To configure a standby
server to use pg_archivecleanup, put this into its
@@ -57,14 +58,10 @@ archive_cleanup_command = 'pg_archivecleanup archivelocation %r'
from the same archive location.
- The full syntax of pg_archivecleanup's command line is
-
-pg_archivecleanup option ... archivelocation restartwalfile
-
When used as a standalone program all WAL files logically preceding the
- restartwalfile will be removed archivelocation.
+ oldestkeptwalfile will be removed from archivelocation.
In this mode, if you specify a .backup file name, then only the file prefix
- will be used as the restartwalfile. This allows you to remove
+ will be used as the oldestkeptwalfile. This allows you to remove
all WAL files archived prior to a specific base backup without error.
For example, the following example will remove all files older than
WAL file name 000000010000003700000010:
@@ -79,10 +76,10 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E"
archivelocation is a directory readable and writable by the
server-owning user.
-
+
-
- <application>pg_archivecleanup</> Options
+
+ Optionspg_archivecleanup accepts the following command-line arguments:
@@ -124,10 +121,26 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E"
+
-
+
+ Notes
-
+
+ pg_archivecleanup is designed to work with
+ PostgreSQL 8.0 and later when used as a standalone utility,
+ or with PostgreSQL 9.0 and later when used as an
+ archive cleanup command.
+
+
+
+ pg_archivecleanup is written in C and has an
+ easy-to-modify source code, with specifically designated sections to modify
+ for your own needs
+
+
+
+ ExamplesOn Linux or Unix systems, you might use:
@@ -151,26 +164,21 @@ archive_cleanup_command = 'pg_archivecleanup -d /mnt/standby/archive %r 2>>clean
+
-
-
-
- Supported Server Versions
-
-
- pg_archivecleanup is designed to work with
- PostgreSQL 8.0 and later when used as a standalone utility,
- or with PostgreSQL 9.0 and later when used as an
- archive cleanup command.
-
-
-
-
+ Author
Simon Riggs simon@2ndquadrant.com
-
+
-
+
+ See Also
+
+
+
+
+
+
diff --git a/doc/src/sgml/pgbench.sgml b/doc/src/sgml/pgbench.sgml
index 2ae3b9e317f..16ac69f9ee0 100644
--- a/doc/src/sgml/pgbench.sgml
+++ b/doc/src/sgml/pgbench.sgml
@@ -1,12 +1,37 @@
-
- pgbench
+
+
+ pgbench
+ 1
+ Application
+
+
+
+ pgbench
+ run a benchmark test on PostgreSQL
+ pgbench
+
+
+ pgbench
+
+ option
+ dbname
+
+
+ pgbench
+ option
+ dbname
+
+
+
+
+ Descriptionpgbench is a simple program for running benchmark
tests on PostgreSQL. It runs the same sequence of SQL
@@ -38,19 +63,16 @@ tps = 85.296346 (excluding connections establishing)
settings. The next line reports the number of transactions completed
and intended (the latter being just the product of number of clients
and number of transactions per client); these will be equal unless the run
- failed before completion. (In -T mode, only the actual
+ failed before completion. (In
-
- Overview
-
The default TPC-B-like transaction test requires specific tables to be
set up beforehand. pgbench should be invoked with
- the -i (initialize) option to create and populate these
+ the
@@ -88,38 +110,37 @@ pgbench_accounts 100000
pgbench_history 0
You can (and, for most purposes, probably should) increase the number
- of rows by using the -s (scale factor) option. The
- -F (fillfactor) option might also be used at this point.
+ of rows by using the
+
+
+ Options
- shows options that are used
- during database initialization, while
- shows options that are used
- while running benchmarks, and
- shows options that are useful
- in both cases.
+ The following is divided into three subsections: Different options are used
+ during database initialization and while running benchmarks, some options
+ are useful in both cases.
-
-
-
- <application>pgbench</> Initialization Options
+
+ Initialization Optionspgbench accepts the following command-line
@@ -191,10 +212,10 @@ pgbench options dbname
-
+
-
- <application>pgbench</> Benchmarking Options
+
+ Benchmarking Optionspgbench accepts the following command-line
@@ -237,7 +258,7 @@ pgbench options dbname
Define a variable for use by a custom script (see below).
- Multiple -D options are allowed.
+ Multiple
@@ -248,7 +269,7 @@ pgbench options dbname
Read transaction script from filename.
See below for details.
- -N, -S, and -f
+ , , and
are mutually exclusive.
@@ -344,7 +365,7 @@ pgbench options dbname
output. With the built-in tests, this is not necessary; the
correct scale factor will be detected by counting the number of
rows in the pgbench_branches table. However, when testing
- custom benchmarks (-f option), the scale factor
+ custom benchmarks (