contrib/README

   1
   2 The PostgreSQL contrib tree
   3 ---------------------------
   4
   5 This subtree contains porting tools, analysis utilities, and plug-in
   6 features that are not part of the core PostgreSQL system, mainly because
   7 they address a limited audience or are too experimental to be part of
   8 the main source tree.  This does not preclude their usefulness.
   9
  10 Each subdirectory contains a README file with information about the
  11 module.  Most items can be built with `gmake all' and installed with
  12 `gmake install' in the usual fashion, after you have run the `configure'
  13 script in the top-level directory.  Some directories supply new
  14 user-defined functions, operators, or types.  After you have installed
  15 the files you need to register the new entities in the database system
  16 by running the commands in the supplied .sql file.  For example,
  17
  18         $ psql -d dbname -f module.sql
  19
  20 See the PostgreSQL documentation for more information about this
  21 procedure.
  22
  23
  24 Index:
  25 ------
  26
  27 array -
  28         Array iterator functions
  29         by Massimo Dal Zotto <dz@cs.unitn.it>
  30
  31 btree_gist -
  32         Support for emulating BTREE indexing in GiST
  33         by Oleg Bartunov <oleg@sai.msu.su> and Teodor Sigaev <teodor@stack.net>
  34
  35 chkpass -
  36         An auto-encrypted password datatype
  37         by D'Arcy J.M. Cain <darcy@druid.net>
  38
  39 cube -
  40         Multidimensional-cube datatype (GiST indexing example)
  41         by Gene Selkov, Jr. <selkovjr@mcs.anl.gov>
  42
  43 dbase -
  44         Converts from dbase/xbase to PostgreSQL
  45         by Maarten.Boekhold <Maarten.Boekhold@reuters.com>,
  46            Frank Koormann <fkoorman@usf.uni-osnabrueck.de>,
  47            Ivan Baldo <lubaldo@adinet.com.uy>
  48
  49 dblink -
  50         Allows remote query execution
  51         by  Joe Conway <joe.conway@mail.com>
  52
  53 dbsize -
  54         Reports database and table disk space
  55         by Peter Eisentraut <peter_e@gmx.net>
  56
  57 earthdistance -
  58         Operator for computing earth distance for two points
  59         by Hal Snyder <hal@vailsys.com>
  60
  61 findoidjoins -
  62         Finds the joins used by oid columns by examining the actual
  63         values in the oid columns and row oids.
  64         by Bruce Momjian <pgman@candle.pha.pa.us>
  65
  66 fulltextindex -
  67         Full text indexing using triggers
  68         by Maarten Boekhold <maartenb@dutepp0.et.tudelft.nl>
  69
  70 fuzzystrmatch -
  71         Levenshtein, metaphone, and soundex fuzzy string matching
  72         by Joe Conway <joseph.conway@home.com>, Joel Burton <jburton@scw.org>
  73
  74 intagg -
  75         Integer aggregator
  76         by  mlw <markw@mohawksoft.com>
  77
  78
  79 intarray -
  80         Index support for arrays of int4, using GiST
  81         by Teodor Sigaev <teodor@stack.net> and Oleg Bartunov <oleg@sai.msu.su>
  82
  83 ipc_check -
  84         Simple test script to help in configuring IPC.
  85         FreeBSD only, for now.
  86
  87 isbn_issn -
  88         PostgreSQL type extensions for ISBN (books) and ISSN (serials)
  89         by Garrett A. Wollman <wollman@khavrinen.lcs.mit.edu>
  90
  91 lo -
  92         Large Object maintenance
  93         by Peter Mount <peter@retep.org.uk>
  94
  95 mSQL-interface -
  96         mSQL API translation library
  97         by Aldrin Leal <aldrin@americasnet.com>
  98
  99 mac -
 100         Support functions for MAC address types
 101         by Lawrence E. Rosenman <ler@lerctr.org>
 102
 103 miscutil -
 104         PostgreSQL assert checking and various utility functions
 105         by Massimo Dal Zotto <dz@cs.unitn.it>
 106
 107 mysql -
 108         utility to convert MySQL schema dumps to SQL92 and PostgreSQL
 109         by Thomas Lockhart <lockhart@alumni.caltech.edu>
 110            Max Rudensky <fonin@ziet.zhitomir.ua>
 111            Valentine Danilchuk <valdan@ziet.zhitomir.ua>
 112
 113 noupdate -
 114         trigger to prevent updates on single columns
 115
 116 oid2name -
 117         maps numeric files to table names
 118         by B Palmer <bpalmer@crimelabs.net>
 119
 120 oracle -
 121         converts Oracle database schema to PostgreSQL
 122         by Gilles Darold <gilles@darold.net>
 123
 124 pg_controldata -
 125         Dump contents of pg_control (database master file)
 126         by Oliver Elphick <olly@lfix.co.uk>
 127
 128 pg_dumplo -
 129         Dump large objects
 130         by Karel Zak <zakkr@zf.jcu.cz>
 131
 132 pg_logger -
 133         Stdin-to-syslog gateway for PostgreSQL
 134         by Nathan Myers <ncm@nospam.cantrip.org>
 135
 136 pg_resetxlog -
 137         Reset the WAL log (pg_xlog) to recover from crash or format change
 138         by Tom Lane <tgl@sss.pgh.pa.us>
 139
 140 pg_upgrade -
 141         Upgrade from previous PostgreSQL version without pg_dump/reload
 142         by Bruce Momjian <pgman@candle.pha.pa.us>
 143
 144 pgbench -
 145         TPC-B like benchmarking tool
 146         by Tatsuo Ishii <t-ishii@sra.co.jp>
 147
 148 pgcrypto -
 149         Cryptographic functions
 150         by Marko Kreen <marko@l-t.ee>
 151
 152 reindex -
 153         Reindexes a database
 154         by Shaun Thomas <sthomas@townnews.com>
 155
 156 pgstattuple -
 157         A function returns the percentage of "dead" tuples in a table
 158         by Tatsuo Ishii <t-ishii@sra.co.jp>
 159
 160 retep -
 161         tools to build retep tools packages
 162         by Peter T Mount <peter@retep.org.uk>
 163
 164 rserv -
 165         replication server
 166         by Vadim B. Mikheev <vadim4o@email.com>
 167
 168 rtree_gist -
 169         Support for emulating RTREE indexing in GiST
 170         by Oleg Bartunov <oleg@sai.msu.su> and Teodor Sigaev <teodor@stack.net>
 171
 172 seg -
 173         Confidence-interval datatype (GiST indexing example)
 174         by Gene Selkov, Jr. <selkovjr@mcs.anl.gov>
 175
 176 spi -
 177         Various trigger functions, examples for using SPI.
 178
 179 start-scripts -
 180         Scripts for starting the server at boot time.
 181
 182 string -
 183         C-like input/output conversion routines for strings
 184         by Massimo Dal Zotto <dz@cs.unitn.it>
 185
 186 tips/apache_logging -
 187         Getting Apache to log to PostgreSQL
 188         by Terry Mackintosh <terry@terrym.com>
 189
 190 tools -
 191         Assorted developer tools
 192         by Massimo Dal Zotto <dz@cs.unitn.it>
 193
 194 tsearch -
 195         Full-text-index support using GiST
 196         by Teodor Sigaev <teodor@stack.net> and Oleg Bartunov
 197         <oleg@sai.msu.su>.
 198
 199 userlock -
 200         User locks
 201         by Massimo Dal Zotto <dz@cs.unitn.it>
 202
 203 vacuumlo -
 204         Remove orphaned large objects
 205         by Peter T Mount <peter@retep.org.uk>
 206
 207 xml -
 208         Storing XML in PostgreSQL
 209         by John Gray <jgray@azuli.co.uk>