contrib/README

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