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