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