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