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 cube -
  34         Multidimensional-cube datatype (GiST indexing example)
  35         by Gene Selkov, Jr. <selkovjr@mcs.anl.gov>
  36
  37 dbase -
  38         Converts from dbase/xbase to PostgreSQL
  39         by Ivan Baldo, lubaldo@adinet.com.uy
  40
  41 dblink -
  42         Allows remote query execution
  43         by  Joe Conway, joe.conway@mail.com
  44
  45 earthdistance -
  46         Operator for computing earth distance for two points
  47         by Hal Snyder <hal@vailsys.com>
  48
  49 findoidjoins -
  50         Finds the joins used by oid columns by examining the actual
  51         values in the oid columns and row oids.
  52         by Bruce Momjian <pgman@candle.pha.pa.us>
  53
  54 fulltextindex -
  55         Full text indexing using triggers
  56         by Maarten Boekhold <maartenb@dutepp0.et.tudelft.nl>
  57
  58 intarray -
  59         Index support for arrays of int4, using GiST
  60         by Teodor Sigaev <teodor@stack.net> and Oleg Bartunov
  61         <oleg@sai.msu.su>.
  62
  63 ipc_check -
  64         Simple test script to help in configuring IPC.
  65         FreeBSD only, for now.
  66
  67 isbn_issn -
  68         PostgreSQL type extensions for ISBN (books) and ISSN (serials)
  69         by Garrett A. Wollman <wollman@khavrinen.lcs.mit.edu>
  70
  71 lo -
  72         Large Object maintenance
  73         by Peter Mount <peter@retep.org.uk>
  74
  75 mSQL-interface -
  76         mSQL API translation library
  77         by Aldrin Leal <aldrin@americasnet.com>
  78
  79 mac -
  80         Support functions for MAC address types
  81         by Lawrence E. Rosenman <ler@lerctr.org>
  82
  83 metaphone -
  84         Improved Soundex function
  85         by Joel Burton <jburton@scw.org>
  86
  87 miscutil -
  88         PostgreSQL assert checking and various utility functions
  89         by Massimo Dal Zotto <dz@cs.unitn.it>
  90
  91 mysql -
  92         utility to convert MySQL schema dumps to SQL92 and PostgreSQL
  93         by Thomas Lockhart <lockhart@alumni.caltech.edu>
  94            Max Rudensky <fonin@ziet.zhitomir.ua>
  95            Valentine Danilchuk <valdan@ziet.zhitomir.ua>
  96
  97 noupdate -
  98         trigger to prevent updates on single columns
  99
 100 oid2name -
 101         maps numeric files to table names
 102         by B Palmer <bpalmer@crimelabs.net>
 103
 104 oracle -
 105         converts Oracle database schema to PostgreSQL
 106         by Gilles Darold <gilles@darold.net>
 107
 108 pg_controldata -
 109         Dump contents of pg_control (database master file)
 110         by Oliver Elphick <olly@lfix.co.uk>
 111
 112 pg_dumplo -
 113         Dump large objects
 114         by Karel Zak <zakkr@zf.jcu.cz>
 115
 116 pg_logger -
 117         Stdin-to-syslog gateway for PostgreSQL
 118         by Nathan Myers <ncm@nospam.cantrip.org>
 119
 120 pg_resetxlog -
 121         Reset the WAL log (pg_xlog) to recover from crash or format change
 122         by Tom Lane <tgl@sss.pgh.pa.us>
 123
 124 pgbench -
 125         TPC-B like benchmarking tool
 126         by Tatsuo Ishii <t-ishii@sra.co.jp>
 127
 128 pgcrypto -
 129         Cryptographic hash functions
 130         by Marko Kreen <marko@l-t.ee>
 131
 132 retep -
 133         tools to build retep tools packages
 134         by Peter T Mount <peter@retep.org.uk>
 135
 136 rserv -
 137         replication server
 138         by Vadim B. Mikheev <vadim4o@email.com>
 139
 140 rtree_gist -
 141         Support for emulating RTREE indexing in GiST
 142         by Oleg Bartunov <oleg@sai.msu.su> and Teodor Sigaev <teodor@stack.net>
 143
 144 seg -
 145         Confidence-interval datatype (GiST indexing example)
 146         by Gene Selkov, Jr. <selkovjr@mcs.anl.gov>
 147
 148 soundex -
 149         Soundex function
 150
 151 spi -
 152         Various trigger functions, examples for using SPI.
 153
 154 start-scripts -
 155         Scripts for starting the server at boot time.
 156
 157 string -
 158         C-like input/output conversion routines for strings
 159         by Massimo Dal Zotto <dz@cs.unitn.it>
 160
 161 tips/apache_logging -
 162         Getting Apache to log to PostgreSQL
 163         by Terry Mackintosh <terry@terrym.com>
 164
 165 tools -
 166         Assorted developer tools
 167         by Massimo Dal Zotto <dz@cs.unitn.it>
 168
 169 unixdate -
 170         Conversions from integer to datetime
 171         by Thomas Lockhart <lockhart@alumni.caltech.edu>
 172
 173 userlock -
 174         User locks
 175         by Massimo Dal Zotto <dz@cs.unitn.it>
 176
 177 vacuumlo -
 178         Remove orphaned large objects
 179         by Peter T Mount <peter@retep.org.uk>
 180
 181 xml -
 182         Storing XML in PostgreSQL
 183         by John Gray <jgray@beansindustry.co.uk>