]> granicus.if.org Git - postgresql/blobdiff - contrib/README
Avoid scan-build warning about uninitialized htonl() arguments.
[postgresql] / contrib / README
index 8ecdb602ab024653360ec9765301cb6852dba059..5eaeb2451f29877e986f4683c57dd70edde942d5 100644 (file)
 The PostgreSQL contrib tree
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------
 
-This subtree contains tools, modules, and examples that are not
-maintained as part of the core PostgreSQL system, mainly because
-they only address a limited audience or are too inelegant to be
-sold as an official feature.  That, however, does not preclude
-their usefulness.
+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.
 
-Each subdirectory contains a README file with information about the
-module.  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.  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,
+User documentation for each module appears in the main SGML
+documentation.
 
-       $ psql -d dbname -f module.sql
+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 "make all" and "make
+install" in this directory; or to build and install just one selected
+module, do the same in that module's subdirectory.
 
-See the PostgreSQL documentation for more information about this
-procedure.
-
-
-Index:
-------
-
-array -
-       Array iterator functions
-       by Massimo Dal Zotto <dz@cs.unitn.it>
-
-cube -
-       Multidimensional-cube datatype (GiST indexing example)
-       by Gene Selkov, Jr. <selkovjr@mcs.anl.gov>
-
-earthdistance -
-       Operator for computing earth distance for two points
-       by Hal Snyder <hal@vailsys.com>
-
-findoidjoins -
-       Finds the joins used by oid columns by examining the actual
-       values in the oid columns and row oids.
-       by Bruce Momjian <pgman@candle.pha.pa.us>
-
-fulltextindex -
-       Full text indexing using triggers
-       by Maarten Boekhold <maartenb@dutepp0.et.tudelft.nl>
-
-isbn_issn -
-       PostgreSQL type extensions for ISBN (books) and ISSN (serials)
-       by Garrett A. Wollman <wollman@khavrinen.lcs.mit.edu>
-
-linux -
-       Scripts for starting and stopping the PostgreSQL server on
-       a Linux system
-       by Thomas Lockhart <lockhart@alumni.caltech.edu>
-
-lo -
-       Large Object maintenance
-       by Peter Mount <peter@retep.org.uk> 
-
-mSQL-interface -
-       mSQL API translation library
-       by Aldrin Leal <aldrin@americasnet.com>
-
-mac -
-       Support functions for MAC address types
-       by Lawrence E. Rosenman <ler@lerctr.org>
+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
 
-miscutil -
-       PostgreSQL assert checking and various utility functions
-       by Massimo Dal Zotto <dz@cs.unitn.it>
+    CREATE EXTENSION module_name;
 
-noupdate -
-       trigger to prevent updates on single columns
-
-pg_dumplo -
-       Dump large objects
-       by Karel Zak <zakkr@zf.jcu.cz>
-
-pgbench -
-       TPC-B like benchmarking tool
-       by Tatsuo Ishii <t-ishii@sra.co.jp>
-
-pgcrypto -
-       Cryptographic hash functions
-       by Marko Kreen <marko@l-t.ee>
-
-seg -
-       Confidence-interval datatype (GiST indexing example)
-       by Gene Selkov, Jr. <selkovjr@mcs.anl.gov>
-
-soundex -
-       Soundex function
-
-spi -
-       Various trigger functions, examples for using SPI.
-
-string -
-       C-like input/output conversion routines for strings
-       by Massimo Dal Zotto <dz@cs.unitn.it>
-
-tips/apache_logging -
-       Getting Apache to log to PostgreSQL
-       by Terry Mackintosh <terry@terrym.com>
-
-tools -
-       Assorted developer tools
-       by Massimo Dal Zotto <dz@cs.unitn.it>
-
-unixdate -
-       Conversions from integer to datetime
-       by Thomas Lockhart <lockhart@alumni.caltech.edu>
-
-userlock -
-       User locks
-       by Massimo Dal Zotto <dz@cs.unitn.it>
-
-vacuumlo -
-       Remove orphaned large objects
-       by Peter T Mount <peter@retep.org.uk>
+See the PostgreSQL documentation for more information about this
+procedure.