contrib/README

   1 The PostgreSQL contrib tree
   2 ---------------------------
   3
   4 This subtree contains porting tools, analysis utilities, and plug-in
   5 features that are not part of the core PostgreSQL system, mainly because
   6 they address a limited audience or are too experimental to be part of
   7 the main source tree.  This does not preclude their usefulness.
   8
   9 User documentation for each module appears in the main SGML documentation.
  10
  11 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.  In these cases, after you have
  15 installed the files you need to register the new entities in the database
  16 system 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 adminpack -
  28         File and log manipulation routines, used by pgAdmin
  29         by Dave Page <dpage@vale-housing.co.uk>
  30
  31 btree_gist -
  32         Support for emulating BTREE indexing in GiST
  33         by Oleg Bartunov <oleg@sai.msu.su> and Teodor Sigaev <teodor@sigaev.ru>
  34
  35 chkpass -
  36         An auto-encrypted password datatype
  37         by D'Arcy J.M. Cain <darcy@druid.net>
  38
  39 citext -
  40         A case-insensitive character string datatype
  41         by David E. Wheeler <david@kineticode.com>
  42
  43 cube -
  44         Multidimensional-cube datatype (GiST indexing example)
  45         by Gene Selkov, Jr. <selkovjr@mcs.anl.gov>
  46
  47 dblink -
  48         Allows remote query execution
  49         by Joe Conway <mail@joeconway.com>
  50
  51 dict_int -
  52         Text search dictionary template for integers
  53         by Sergey Karpov <karpov@sao.ru>
  54
  55 dict_xsyn -
  56         Text search dictionary template for extended synonym processing
  57         by Sergey Karpov <karpov@sao.ru>
  58
  59 earthdistance -
  60         Functions for computing distances between two points on Earth
  61         by Bruno Wolff III <bruno@wolff.to> and Hal Snyder <hal@vailsys.com>
  62
  63 fuzzystrmatch -
  64         Levenshtein, metaphone, and soundex fuzzy string matching
  65         by Joe Conway <mail@joeconway.com> and Joel Burton <jburton@scw.org>
  66
  67 hstore -
  68         Module for storing (key, value) pairs
  69         by Oleg Bartunov <oleg@sai.msu.su> and Teodor Sigaev <teodor@sigaev.ru>
  70
  71 intagg -
  72         Integer aggregator
  73         by mlw <markw@mohawksoft.com>
  74
  75 intarray -
  76         Index support for arrays of int4, using GiST
  77         by Teodor Sigaev <teodor@sigaev.ru> and Oleg Bartunov <oleg@sai.msu.su>
  78
  79 isn -
  80         PostgreSQL type extensions for ISBN, ISSN, ISMN, EAN13 product numbers
  81         by Germán Méndez Bravo (Kronuz) <kronuz@hotmail.com>
  82
  83 lo -
  84         Large Object maintenance
  85         by Peter Mount <peter@retep.org.uk>
  86
  87 ltree -
  88         Tree-like data structures
  89         by Teodor Sigaev <teodor@sigaev.ru> and Oleg Bartunov <oleg@sai.msu.su>
  90
  91 oid2name -
  92         Maps numeric files to table names
  93         by B Palmer <bpalmer@crimelabs.net>
  94
  95 pageinspect -
  96         Allows inspection of database pages
  97         Heikki Linnakangas <heikki@enterprisedb.com>
  98
  99 pg_buffercache -
 100         Real time queries on the shared buffer cache
 101         by Mark Kirkwood <markir@paradise.net.nz>
 102
 103 pg_freespacemap -
 104         Displays the contents of the free space map (FSM)
 105         by Mark Kirkwood <markir@paradise.net.nz>
 106
 107 pg_standby -
 108         Sample archive_command for warm standby operation
 109         by Simon Riggs <simon@2ndquadrant.com>
 110
 111 pg_trgm -
 112         Functions for determining the similarity of text based on trigram
 113         matching.
 114         by Oleg Bartunov <oleg@sai.msu.su> and Teodor Sigaev <teodor@sigaev.ru>
 115
 116 pgbench -
 117         TPC-B like benchmarking tool
 118         by Tatsuo Ishii <ishii@sraoss.co.jp>
 119
 120 pgcrypto -
 121         Cryptographic functions
 122         by Marko Kreen <marko@l-t.ee>
 123
 124 pgrowlocks -
 125         A function to return row locking information
 126         by Tatsuo Ishii <ishii@sraoss.co.jp>
 127
 128 pgstattuple -
 129         Functions to return statistics about "dead" tuples and free
 130         space within a table
 131         by Tatsuo Ishii <ishii@sraoss.co.jp>
 132
 133 seg -
 134         Confidence-interval datatype (GiST indexing example)
 135         by Gene Selkov, Jr. <selkovjr@mcs.anl.gov>
 136
 137 spi -
 138         Various trigger functions, examples for using SPI.
 139
 140 sslinfo -
 141         Functions to get information about SSL certificates
 142         by Victor Wagner <vitus@cryptocom.ru>
 143
 144 start-scripts -
 145         Scripts for starting the server at boot time on various platforms.
 146
 147 tablefunc -
 148         Examples of functions returning tables
 149         by Joe Conway <mail@joeconway.com>
 150
 151 test_parser -
 152         Sample text search parser
 153         by Sergey Karpov <karpov@sao.ru>
 154
 155 tsearch2 -
 156         Compatibility package for the pre-8.3 implementation of text search.
 157         Pavel Stehule <pavel.stehule@gmail.com>, based on code originally by
 158         Teodor Sigaev <teodor@sigaev.ru> and Oleg Bartunov <oleg@sai.msu.su>.
 159
 160 uuid-ossp -
 161         UUID generation functions
 162         by Peter Eisentraut <peter_e@gmx.net>
 163
 164 vacuumlo -
 165         Remove orphaned large objects
 166         by Peter T Mount <peter@retep.org.uk>
 167
 168 xml2 -
 169         Storing XML in PostgreSQL
 170         by John Gray <jgray@azuli.co.uk>