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