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 earthdistance -
  38         Operator for computing earth distance for two points
  39         by Hal Snyder <hal@vailsys.com>
  40
  41 findoidjoins -
  42         Finds the joins used by oid columns by examining the actual
  43         values in the oid columns and row oids.
  44         by Bruce Momjian <pgman@candle.pha.pa.us>
  45
  46 fulltextindex -
  47         Full text indexing using triggers
  48         by Maarten Boekhold <maartenb@dutepp0.et.tudelft.nl>
  49
  50 intarray -
  51         Index support for arrays of int4, using GiST
  52         by Teodor Sigaev <teodor@stack.net> and Oleg Bartunov
  53         <oleg@sai.msu.su>.
  54
  55 isbn_issn -
  56         PostgreSQL type extensions for ISBN (books) and ISSN (serials)
  57         by Garrett A. Wollman <wollman@khavrinen.lcs.mit.edu>
  58
  59 lo -
  60         Large Object maintenance
  61         by Peter Mount <peter@retep.org.uk>
  62
  63 mSQL-interface -
  64         mSQL API translation library
  65         by Aldrin Leal <aldrin@americasnet.com>
  66
  67 mac -
  68         Support functions for MAC address types
  69         by Lawrence E. Rosenman <ler@lerctr.org>
  70
  71 miscutil -
  72         PostgreSQL assert checking and various utility functions
  73         by Massimo Dal Zotto <dz@cs.unitn.it>
  74
  75 mysql -
  76         utility to convert MySQL schema dumps to SQL92 and PostgreSQL
  77         by Thomas Lockhart <lockhart@alumni.caltech.edu>
  78            Max Rudensky <fonin@ziet.zhitomir.ua>
  79            Valentine Danilchuk <valdan@ziet.zhitomir.ua>
  80
  81 noupdate -
  82         trigger to prevent updates on single columns
  83
  84 oid2name -
  85         maps numeric files to table names
  86         by B Palmer <bpalmer@crimelabs.net>
  87
  88 pg_dumplo -
  89         Dump large objects
  90         by Karel Zak <zakkr@zf.jcu.cz>
  91
  92 pg_logger -
  93         Stdin-to-syslog gateway for PostgreSQL
  94         by Nathan Myers <ncm@nospam.cantrip.org>
  95
  96 pgbench -
  97         TPC-B like benchmarking tool
  98         by Tatsuo Ishii <t-ishii@sra.co.jp>
  99
 100 pgcrypto -
 101         Cryptographic hash functions
 102         by Marko Kreen <marko@l-t.ee>
 103
 104 retep -
 105         tools to build retep tools packages
 106         by Peter T Mount <peter@retep.org.uk>
 107
 108 rserv -
 109         replication server
 110         by Vadim B. Mikheev <vadim4o@email.com>
 111
 112 seg -
 113         Confidence-interval datatype (GiST indexing example)
 114         by Gene Selkov, Jr. <selkovjr@mcs.anl.gov>
 115
 116 soundex -
 117         Soundex function
 118
 119 spi -
 120         Various trigger functions, examples for using SPI.
 121
 122 start-scripts -
 123         Scripts for starting the server at boot time.
 124
 125 string -
 126         C-like input/output conversion routines for strings
 127         by Massimo Dal Zotto <dz@cs.unitn.it>
 128
 129 tips/apache_logging -
 130         Getting Apache to log to PostgreSQL
 131         by Terry Mackintosh <terry@terrym.com>
 132
 133 tools -
 134         Assorted developer tools
 135         by Massimo Dal Zotto <dz@cs.unitn.it>
 136
 137 unixdate -
 138         Conversions from integer to datetime
 139         by Thomas Lockhart <lockhart@alumni.caltech.edu>
 140
 141 userlock -
 142         User locks
 143         by Massimo Dal Zotto <dz@cs.unitn.it>
 144
 145 vacuumlo -
 146         Remove orphaned large objects
 147         by Peter T Mount <peter@retep.org.uk>