Skip to content

Commit 48ea558

Browse files
committed
Update contrib/README
Remove lots of outdated information that is duplicated by the better-maintained SGML documentation. In particular, remove the outdated listing of contrib modules. Update the installation instructions to mention CREATE EXTENSION, but don't go into too much detail.
1 parent aacc50d commit 48ea558

File tree

1 file changed

+18
-201
lines changed

1 file changed

+18
-201
lines changed

contrib/README

+18-201
Original file line numberDiff line numberDiff line change
@@ -2,210 +2,27 @@ The PostgreSQL contrib tree
22
---------------------------
33

44
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.
5+
features that are not part of the core PostgreSQL system, mainly
6+
because they address a limited audience or are too experimental to be
7+
part of the main source tree. This does not preclude their
8+
usefulness.
89

9-
User documentation for each module appears in the main SGML documentation.
10+
User documentation for each module appears in the main SGML
11+
documentation.
1012

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,
13+
When building from the source distribution, these modules are not
14+
built automatically, unless you build the "world" target. You can
15+
also build and install them all by running "gmake all" and "gmake
16+
install" in this directory; or to build and install just one selected
17+
module, do the same in that module's subdirectory.
1718

18-
$ psql -d dbname -f module.sql
19+
Some directories supply new user-defined functions, operators, or
20+
types. To make use of one of these modules, after you have installed
21+
the code you need to register the new SQL objects in the database
22+
system by executing a CREATE EXTENSION command. In a fresh database,
23+
you can simply do
24+
25+
CREATE EXTENSION module_name;
1926

2027
See the PostgreSQL documentation for more information about this
2128
procedure.
22-
23-
24-
Index:
25-
------
26-
27-
adminpack -
28-
File and log manipulation routines, used by pgAdmin
29-
by Dave Page <[email protected]>
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 <[email protected]>
35-
36-
auto_explain -
37-
Log EXPLAIN output for long-running queries
38-
by Takahiro Itagaki <[email protected]>
39-
40-
btree_gin -
41-
Support for emulating BTREE indexing in GIN
42-
by Oleg Bartunov <[email protected]> and Teodor Sigaev <[email protected]>
43-
44-
btree_gist -
45-
Support for emulating BTREE indexing in GiST
46-
by Oleg Bartunov <[email protected]> and Teodor Sigaev <[email protected]>
47-
48-
chkpass -
49-
An auto-encrypted password datatype
50-
by D'Arcy J.M. Cain <[email protected]>
51-
52-
citext -
53-
A case-insensitive character string datatype
54-
by David E. Wheeler <[email protected]>
55-
56-
cube -
57-
Multidimensional-cube datatype (GiST indexing example)
58-
by Gene Selkov, Jr. <[email protected]>
59-
60-
dblink -
61-
Allows remote query execution
62-
by Joe Conway <[email protected]>
63-
64-
dict_int -
65-
Text search dictionary template for integers
66-
by Sergey Karpov <[email protected]>
67-
68-
dict_xsyn -
69-
Text search dictionary template for extended synonym processing
70-
by Sergey Karpov <[email protected]>
71-
72-
earthdistance -
73-
Functions for computing distances between two points on Earth
74-
by Bruno Wolff III <[email protected]> and Hal Snyder <[email protected]>
75-
76-
file_fdw
77-
Foreign-data wrapper for server-side CSV/TEXT files
78-
by Shigeru Hanada <[email protected]>
79-
80-
fuzzystrmatch -
81-
Levenshtein, metaphone, and soundex fuzzy string matching
82-
by Joe Conway <[email protected]> and Joel Burton <[email protected]>
83-
84-
hstore -
85-
Module for storing (key, value) pairs
86-
by Oleg Bartunov <[email protected]> and Teodor Sigaev <[email protected]>
87-
88-
intagg -
89-
Integer aggregator
90-
91-
92-
intarray -
93-
Index support for arrays of int4, using GiST
94-
by Teodor Sigaev <[email protected]> and Oleg Bartunov <[email protected]>
95-
96-
isn -
97-
PostgreSQL type extensions for ISBN, ISSN, ISMN, EAN13 product numbers
98-
by Germán Méndez Bravo (Kronuz) <[email protected]>
99-
100-
lo -
101-
Large Object maintenance
102-
by Peter Mount <[email protected]>
103-
104-
ltree -
105-
Tree-like data structures
106-
by Teodor Sigaev <[email protected]> and Oleg Bartunov <[email protected]>
107-
108-
oid2name -
109-
Maps numeric files to table names
110-
by B Palmer <[email protected]>
111-
112-
pageinspect -
113-
Allows inspection of database pages
114-
Heikki Linnakangas <[email protected]>
115-
116-
passwordcheck -
117-
Simple password strength checker
118-
Laurenz Albe <[email protected]>
119-
120-
pg_buffercache -
121-
Real time queries on the shared buffer cache
122-
by Mark Kirkwood <[email protected]>
123-
124-
pg_freespacemap -
125-
Displays the contents of the free space map (FSM)
126-
by Mark Kirkwood <[email protected]>
127-
128-
pg_standby -
129-
Sample archive_command for warm standby operation
130-
by Simon Riggs <[email protected]>
131-
132-
pg_stat_statements -
133-
Track statement execution times across a whole database cluster
134-
by Takahiro Itagaki <[email protected]>
135-
136-
pg_test_fsync -
137-
Test different wal_sync_method settings
138-
by Bruce Momjian <[email protected]>
139-
140-
pg_trgm -
141-
Functions for determining the similarity of text based on trigram
142-
matching.
143-
by Oleg Bartunov <[email protected]> and Teodor Sigaev <[email protected]>
144-
145-
pg_upgrade -
146-
Support for in-place upgrade between major releases of PostgreSQL
147-
Bruce Momjian <[email protected]> and others
148-
149-
pgbench -
150-
TPC-B like benchmarking tool
151-
by Tatsuo Ishii <[email protected]>
152-
153-
pgcrypto -
154-
Cryptographic functions
155-
by Marko Kreen <[email protected]>
156-
157-
pgrowlocks -
158-
A function to return row locking information
159-
by Tatsuo Ishii <[email protected]>
160-
161-
pgstattuple -
162-
Functions to return statistics about "dead" tuples and free
163-
space within a table
164-
by Tatsuo Ishii <[email protected]>
165-
166-
seg -
167-
Confidence-interval datatype (GiST indexing example)
168-
by Gene Selkov, Jr. <[email protected]>
169-
170-
sepgsql -
171-
External security provider using SELinux
172-
by KaiGai Kohei <[email protected]>
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 <[email protected]>
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 <[email protected]>
187-
188-
test_parser -
189-
Sample text search parser
190-
by Sergey Karpov <[email protected]>
191-
192-
tsearch2 -
193-
Compatibility package for the pre-8.3 implementation of text search.
194-
Pavel Stehule <[email protected]>, based on code originally by
195-
Teodor Sigaev <[email protected]> and Oleg Bartunov <[email protected]>.
196-
197-
unaccent -
198-
Unaccent dictionary for text search
199-
Teodor Sigaev <[email protected]> and Oleg Bartunov <[email protected]>.
200-
201-
uuid-ossp -
202-
UUID generation functions
203-
by Peter Eisentraut <[email protected]>
204-
205-
vacuumlo -
206-
Remove orphaned large objects
207-
by Peter T Mount <[email protected]>
208-
209-
xml2 -
210-
Storing XML in PostgreSQL
211-
by John Gray <[email protected]>

0 commit comments

Comments
 (0)