diff --git a/contrib/README b/contrib/README index a1d42a11cb..b58d0a60e4 100644 --- a/contrib/README +++ b/contrib/README @@ -2,210 +2,27 @@ The PostgreSQL contrib tree --------------------------- This subtree contains porting tools, analysis utilities, and plug-in -features that are not part of the core PostgreSQL system, mainly because -they address a limited audience or are too experimental to be part of -the main source tree. This does not preclude their usefulness. +features that are not part of the core PostgreSQL system, mainly +because they address a limited audience or are too experimental to be +part of the main source tree. This does not preclude their +usefulness. -User documentation for each module appears in the main SGML documentation. +User documentation for each module appears in the main SGML +documentation. -Most items can be built with `gmake all' and installed with -`gmake install' in the usual fashion, after you have run the `configure' -script in the top-level directory. Some directories supply new -user-defined functions, operators, or types. In these cases, after you have -installed the files you need to register the new entities in the database -system by running the commands in the supplied .sql file. For example, +When building from the source distribution, these modules are not +built automatically, unless you build the "world" target. You can +also build and install them all by running "gmake all" and "gmake +install" in this directory; or to build and install just one selected +module, do the same in that module's subdirectory. - $ psql -d dbname -f module.sql +Some directories supply new user-defined functions, operators, or +types. To make use of one of these modules, after you have installed +the code you need to register the new SQL objects in the database +system by executing a CREATE EXTENSION command. In a fresh database, +you can simply do + + CREATE EXTENSION module_name; See the PostgreSQL documentation for more information about this procedure. - - -Index: ------- - -adminpack - - File and log manipulation routines, used by pgAdmin - by Dave Page - -auth_delay - Add a short delay after a failed authentication attempt, to make - brute-force attacks on database passwords a bit harder. - by KaiGai Kohei - -auto_explain - - Log EXPLAIN output for long-running queries - by Takahiro Itagaki - -btree_gin - - Support for emulating BTREE indexing in GIN - by Oleg Bartunov and Teodor Sigaev - -btree_gist - - Support for emulating BTREE indexing in GiST - by Oleg Bartunov and Teodor Sigaev - -chkpass - - An auto-encrypted password datatype - by D'Arcy J.M. Cain - -citext - - A case-insensitive character string datatype - by David E. Wheeler - -cube - - Multidimensional-cube datatype (GiST indexing example) - by Gene Selkov, Jr. - -dblink - - Allows remote query execution - by Joe Conway - -dict_int - - Text search dictionary template for integers - by Sergey Karpov - -dict_xsyn - - Text search dictionary template for extended synonym processing - by Sergey Karpov - -earthdistance - - Functions for computing distances between two points on Earth - by Bruno Wolff III and Hal Snyder - -file_fdw - Foreign-data wrapper for server-side CSV/TEXT files - by Shigeru Hanada - -fuzzystrmatch - - Levenshtein, metaphone, and soundex fuzzy string matching - by Joe Conway and Joel Burton - -hstore - - Module for storing (key, value) pairs - by Oleg Bartunov and Teodor Sigaev - -intagg - - Integer aggregator - by mlw - -intarray - - Index support for arrays of int4, using GiST - by Teodor Sigaev and Oleg Bartunov - -isn - - PostgreSQL type extensions for ISBN, ISSN, ISMN, EAN13 product numbers - by Germán Méndez Bravo (Kronuz) - -lo - - Large Object maintenance - by Peter Mount - -ltree - - Tree-like data structures - by Teodor Sigaev and Oleg Bartunov - -oid2name - - Maps numeric files to table names - by B Palmer - -pageinspect - - Allows inspection of database pages - Heikki Linnakangas - -passwordcheck - - Simple password strength checker - Laurenz Albe - -pg_buffercache - - Real time queries on the shared buffer cache - by Mark Kirkwood - -pg_freespacemap - - Displays the contents of the free space map (FSM) - by Mark Kirkwood - -pg_standby - - Sample archive_command for warm standby operation - by Simon Riggs - -pg_stat_statements - - Track statement execution times across a whole database cluster - by Takahiro Itagaki - -pg_test_fsync - - Test different wal_sync_method settings - by Bruce Momjian - -pg_trgm - - Functions for determining the similarity of text based on trigram - matching. - by Oleg Bartunov and Teodor Sigaev - -pg_upgrade - - Support for in-place upgrade between major releases of PostgreSQL - Bruce Momjian and others - -pgbench - - TPC-B like benchmarking tool - by Tatsuo Ishii - -pgcrypto - - Cryptographic functions - by Marko Kreen - -pgrowlocks - - A function to return row locking information - by Tatsuo Ishii - -pgstattuple - - Functions to return statistics about "dead" tuples and free - space within a table - by Tatsuo Ishii - -seg - - Confidence-interval datatype (GiST indexing example) - by Gene Selkov, Jr. - -sepgsql - - External security provider using SELinux - by KaiGai Kohei - -spi - - Various trigger functions, examples for using SPI. - -sslinfo - - Functions to get information about SSL certificates - by Victor Wagner - -start-scripts - - Scripts for starting the server at boot time on various platforms. - -tablefunc - - Examples of functions returning tables - by Joe Conway - -test_parser - - Sample text search parser - by Sergey Karpov - -tsearch2 - - Compatibility package for the pre-8.3 implementation of text search. - Pavel Stehule , based on code originally by - Teodor Sigaev and Oleg Bartunov . - -unaccent - - Unaccent dictionary for text search - Teodor Sigaev and Oleg Bartunov . - -uuid-ossp - - UUID generation functions - by Peter Eisentraut - -vacuumlo - - Remove orphaned large objects - by Peter T Mount - -xml2 - - Storing XML in PostgreSQL - by John Gray