summaryrefslogtreecommitdiff
path: root/contrib/README
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/README')
-rw-r--r--contrib/README144
1 files changed, 86 insertions, 58 deletions
diff --git a/contrib/README b/contrib/README
index 23cfe8c4d29..0187c2ae5b6 100644
--- a/contrib/README
+++ b/contrib/README
@@ -1,81 +1,109 @@
+The PostgreSQL contrib tree
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
- 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.
- FIXME:
- odbc
- spi/preprocessor
- tools
+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,
- - the contrib contain is in the "Contrib.index"
+ $ psql -d dbname -f module.sql
- - in each directory must be Makefile, possible Makefile template
- is below this text,
+See the PostgreSQL documentation for more information about this
+procedure.
---------
-#
-# $Header: /cvsroot/pgsql/contrib/README,v 1.19 2000/06/19 13:52:59 momjian Exp $
-#
-TOPDIR=../..
+Index:
+------
-include ../Makefile.global
+array -
+ Array iterator functions
+ by Massimo Dal Zotto <dz@cs.unitn.it>
-NAME = some_name
+earthdistance -
+ Operator for computing earth distance for two points
+ by Hal Snyder <hal@vailsys.com>
-PROGRAM =
-OBJS = $(NAME).o
-DOCS = $(NAME).doc
-SQLS = $(NAME).sql
-BINS =
-EXAMPLES=
-MODS = $(NAME)$(DLSUFFIX)
+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>
-CFLAGS += -I. $(CFLAGS_SL)
+fulltextindex -
+ Full text indexing using triggers
+ by Maarten Boekhold <maartenb@dutepp0.et.tudelft.nl>
-OTHER_CLEAN = $(SQLS)
+isbn_issn -
+ PostgreSQL type extensions for ISBN (books) and ISSN (serials)
+ by Garrett A. Wollman <wollman@khavrinen.lcs.mit.edu>
-all: $(MODS) $(SQLS)
+linux -
+ Scripts for starting and stopping the PostgreSQL server on
+ a Linux system
+ by Thomas Lockhart <lockhart@alumni.caltech.edu>
-%.sql: %.sql.in
- $(SED) "s|MODULE_PATHNAME|$(CONTRIB_MODDIR)/$@|" < $< > $@
+lo -
+ Large Object maintenance
+ by Peter Mount <peter@retep.org.uk>
+mSQL-interface -
+ mSQL API translation library
+ by Aldrin Leal <aldrin@americasnet.com>
-install: install_doc install_sql install_mod install_bin install_example
+mac -
+ Support functions for MAC address types
+ by Lawrence E. Rosenman <ler@lerctr.org>
-install_doc:
- for inst_file in $(DOCS); do \
- $(INSTALL) $(INSTL_LIB_OPTS) $$inst_file $(CONTRIB_DOCDIR); \
- done
+miscutil -
+ PostgreSQL assert checking and various utility functions
+ by Massimo Dal Zotto <dz@cs.unitn.it>
-install_sql:
- for inst_file in $(SQLS); do \
- $(INSTALL) $(INSTL_LIB_OPTS) $$inst_file $(CONTRIB_SQLDIR); \
- done
+noupdate -
+ trigger to prevent updates on single columns
-install_mod:
- for inst_file in $(MODS); do \
- $(INSTALL) $(INSTL_SHLIB_OPTS) $$inst_file $(CONTRIB_MODDIR); \
- done
+pgbench -
+ TPC-B like benchmarking tool
+ by Tatsuo Ishii <t-ishii@sra.co.jp>
-install_bin:
- for inst_file in $(BINS); do \
- $(INSTALL) $(INSTL_EXE_OPTS) $$inst_file $(CONTRIB_BINDIR); \
- done
+pg_dumplo -
+ Dump large objects
+ by Karel Zak <zakkr@zf.jcu.cz>
-install_example:
- for inst_file in $(EXAMPLES); do \
- $(INSTALL) $(INSTL_LIB_OPTS) $$inst_file $(CONTRIB_EXAMPLESDIR); \
- done
+soundex -
+ Soundex function
-depend dep:
- $(CC) -MM -MG $(CFLAGS) *.c > depend
+spi -
+ Various trigger functions, examples for using SPI.
-clean:
- $(RM) *~ $(OBJS) $(MODS) $(PROGRAM) depend $(OTHER_CLEAN) core log
+string -
+ C-like input/output conversion routines for strings
+ by Massimo Dal Zotto <dz@cs.unitn.it>
-ifeq (depend,$(wildcard depend))
-include depend
-endif
------------
- \ No newline at end of file
+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>