diff --git a/doc/src/sgml/adminpack.sgml b/doc/src/sgml/adminpack.sgml index 184e96d7a0..04f3b52379 100644 --- a/doc/src/sgml/adminpack.sgml +++ b/doc/src/sgml/adminpack.sgml @@ -1,7 +1,7 @@ - adminpack + adminpack — pgAdmin support toolpack adminpack diff --git a/doc/src/sgml/amcheck.sgml b/doc/src/sgml/amcheck.sgml index 923cbde9dd..4006c75cdf 100644 --- a/doc/src/sgml/amcheck.sgml +++ b/doc/src/sgml/amcheck.sgml @@ -1,7 +1,7 @@ - amcheck + amcheck — tools to verify index consistency amcheck diff --git a/doc/src/sgml/auth-delay.sgml b/doc/src/sgml/auth-delay.sgml index 40629311b1..0571f2a99d 100644 --- a/doc/src/sgml/auth-delay.sgml +++ b/doc/src/sgml/auth-delay.sgml @@ -1,7 +1,7 @@ - auth_delay + auth_delay — pause on authentication failure auth_delay diff --git a/doc/src/sgml/auto-explain.sgml b/doc/src/sgml/auto-explain.sgml index bb7342b120..0c4656ee30 100644 --- a/doc/src/sgml/auto-explain.sgml +++ b/doc/src/sgml/auto-explain.sgml @@ -1,7 +1,7 @@ - auto_explain + auto_explain — log execution plans of slow queries auto_explain diff --git a/doc/src/sgml/basebackup-to-shell.sgml b/doc/src/sgml/basebackup-to-shell.sgml index 491368eb8f..b6a3b39541 100644 --- a/doc/src/sgml/basebackup-to-shell.sgml +++ b/doc/src/sgml/basebackup-to-shell.sgml @@ -1,7 +1,7 @@ - basebackup_to_shell + basebackup_to_shell — example "shell" pg_basebackup module basebackup_to_shell diff --git a/doc/src/sgml/basic-archive.sgml b/doc/src/sgml/basic-archive.sgml index 60f23d2855..b4d43ced20 100644 --- a/doc/src/sgml/basic-archive.sgml +++ b/doc/src/sgml/basic-archive.sgml @@ -1,7 +1,7 @@ - basic_archive + basic_archive — an example WAL archive module basic_archive diff --git a/doc/src/sgml/bloom.sgml b/doc/src/sgml/bloom.sgml index 98d0316175..19f2b172cc 100644 --- a/doc/src/sgml/bloom.sgml +++ b/doc/src/sgml/bloom.sgml @@ -1,7 +1,7 @@ - bloom + bloom — bloom filter index access method bloom diff --git a/doc/src/sgml/btree-gin.sgml b/doc/src/sgml/btree-gin.sgml index 870c25559e..f0cda0e32a 100644 --- a/doc/src/sgml/btree-gin.sgml +++ b/doc/src/sgml/btree-gin.sgml @@ -1,14 +1,15 @@ - btree_gin + btree_gin — + GIN B-tree equivalent operator classes [trusted] btree_gin - btree_gin provides sample GIN operator classes that + btree_gin provides GIN operator classes that implement B-tree equivalent behavior for the data types int2, int4, int8, float4, float8, timestamp with time zone, diff --git a/doc/src/sgml/btree-gist.sgml b/doc/src/sgml/btree-gist.sgml index 92aa8e277e..c08d1fdfc3 100644 --- a/doc/src/sgml/btree-gist.sgml +++ b/doc/src/sgml/btree-gist.sgml @@ -1,7 +1,8 @@ - btree_gist + btree_gist — + B-tree equivalent GiST index operators [trusted] btree_gist diff --git a/doc/src/sgml/citext.sgml b/doc/src/sgml/citext.sgml index 3df2825592..710fbdddf2 100644 --- a/doc/src/sgml/citext.sgml +++ b/doc/src/sgml/citext.sgml @@ -1,7 +1,8 @@ - citext + citext — + a case-insensitive character string type [trusted] citext diff --git a/doc/src/sgml/contrib-spi.sgml b/doc/src/sgml/contrib-spi.sgml index 77328ae6e8..e7cae4e38d 100644 --- a/doc/src/sgml/contrib-spi.sgml +++ b/doc/src/sgml/contrib-spi.sgml @@ -1,7 +1,7 @@ - spi + spi — Server Programming Interface features/examples SPI diff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgml index 4e7b87a42f..e412680e46 100644 --- a/doc/src/sgml/contrib.sgml +++ b/doc/src/sgml/contrib.sgml @@ -1,27 +1,31 @@ - Additional Supplied Modules + Additional Supplied Extensions and Modules - This appendix and the next one contain information regarding the modules that - can be found in the contrib directory of the + This appendix and the next one contain information on the + optional components + found in the contrib directory of the PostgreSQL distribution. These include 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 + and plug-in features that are not part of the core PostgreSQL system. + They are separate 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. - This appendix covers extensions and other server plug-in modules found in + This appendix covers extensions and other server plug-in module + libraries found in contrib. covers utility programs. - When building from the source distribution, these components are not built + When building from the source distribution, these optional + components are not built automatically, unless you build the "world" target (see ). You can build and install all of them by running: @@ -31,8 +35,8 @@ in the contrib directory of a configured source tree; or to build and install - just one selected module, do the same in that module's subdirectory. - Many of the modules have regression tests, which can be executed by + just one selection, do the same in that selection's subdirectory. + Many have regression tests, which can be executed by running: make check @@ -46,41 +50,42 @@ If you are using a pre-packaged version of PostgreSQL, - these modules are typically made available as a separate subpackage, + these components are typically made available as a separate subpackage, such as postgresql-contrib. - Many modules supply new user-defined functions, operators, or types. - To make use of one of these modules, after you have installed the code + Many components supply new user-defined functions, operators, or types, + packaged as extensions. + To make use of one of these extensions, after you have installed the code you need to register the new SQL objects in the database system. This is done by executing a command. In a fresh database, you can simply do -CREATE EXTENSION module_name; +CREATE EXTENSION extension_name; - This command registers the new SQL objects in the current database only, - so you need to run it in each database that you want - the module's facilities to be available in. Alternatively, run it in + This command only registers the new SQL objects in the current database, + so you need to run it in every database in which you want + the extension's facilities to be available. Alternatively, run it in database template1 so that the extension will be copied into subsequently-created databases by default. - For all these modules, CREATE EXTENSION must be run - by a database superuser, unless the module is - considered trusted, in which case it can be run by any + For all extensions the CREATE EXTENSION must be run + by a database superuser, unless the extension is + considered trusted. Trusted extensions can be run by any user who has CREATE privilege on the current - database. Modules that are trusted are identified as such in the - sections that follow. Generally, trusted modules are ones that cannot + database. Extensions that are trusted are identified as such in the + sections that follow. Generally, trusted extensions are ones that cannot provide access to outside-the-database functionality. - Many modules allow you to install their objects in a schema of your + Many extensions allow you to install their objects in a schema of your choice. To do that, add SCHEMA schema_name to the CREATE EXTENSION command. By default, the objects will be placed in your current creation @@ -88,62 +93,112 @@ CREATE EXTENSION module_name; - Note, however, that some of these modules are not extensions + Note, however, that some of these components are not extensions in this sense, but are loaded into the server in some other way, for instance by way of . See the documentation of each - module for details. + component for details. + &adminpack; + &amcheck; + &auth-delay; + &auto-explain; + &basebackup-to-shell; + &basic-archive; + &bloom; + &btree-gin; + &btree-gist; + &citext; + &cube; + &dblink; + &dict-int; + &dict-xsyn; + &earthdistance; + &file-fdw; + &fuzzystrmatch; + &hstore; + &intagg; + &intarray; + &isn; + &lo; + <ree; + &oldsnapshot; + &pageinspect; + &passwordcheck; + &pgbuffercache; + &pgcrypto; + &pgfreespacemap; + &pgprewarm; + &pgrowlocks; + &pgstatstatements; + &pgstattuple; + &pgsurgery; + &pgtrgm; + &pgvisibility; + &pgwalinspect; + &postgres-fdw; + &seg; + &sepgsql; + &contrib-spi; + &sslinfo; + &tablefunc; + &tcn; + &test-decoding; + &tsm-system-rows; + &tsm-system-time; + &unaccent; + &uuid-ossp; + &xml2; diff --git a/doc/src/sgml/cube.sgml b/doc/src/sgml/cube.sgml index 0744816e7c..1998e6d81a 100644 --- a/doc/src/sgml/cube.sgml +++ b/doc/src/sgml/cube.sgml @@ -1,7 +1,7 @@ - cube + cube — a multi-dimensional cube data type [trusted] cube (extension) diff --git a/doc/src/sgml/dblink.sgml b/doc/src/sgml/dblink.sgml index 50c49f533b..17f9d99b1c 100644 --- a/doc/src/sgml/dblink.sgml +++ b/doc/src/sgml/dblink.sgml @@ -1,7 +1,7 @@ - dblink + dblink — connect to other PostgreSQL databases dblink diff --git a/doc/src/sgml/dict-int.sgml b/doc/src/sgml/dict-int.sgml index 53ae8b6637..293ba83ce6 100644 --- a/doc/src/sgml/dict-int.sgml +++ b/doc/src/sgml/dict-int.sgml @@ -1,7 +1,8 @@ - dict_int + dict_int — + example full-text search dictionary for integers [trusted] dict_int diff --git a/doc/src/sgml/dict-xsyn.sgml b/doc/src/sgml/dict-xsyn.sgml index 27b24628d4..a94c6430ed 100644 --- a/doc/src/sgml/dict-xsyn.sgml +++ b/doc/src/sgml/dict-xsyn.sgml @@ -1,7 +1,7 @@ - dict_xsyn + dict_xsyn — example synonym full-text search dictionary dict_xsyn diff --git a/doc/src/sgml/earthdistance.sgml b/doc/src/sgml/earthdistance.sgml index f15dde3a66..5a709e3d47 100644 --- a/doc/src/sgml/earthdistance.sgml +++ b/doc/src/sgml/earthdistance.sgml @@ -1,7 +1,7 @@ - earthdistance + earthdistance — calculate great-circle distances earthdistance diff --git a/doc/src/sgml/file-fdw.sgml b/doc/src/sgml/file-fdw.sgml index 5b98782064..56d696c323 100644 --- a/doc/src/sgml/file-fdw.sgml +++ b/doc/src/sgml/file-fdw.sgml @@ -1,7 +1,7 @@ - file_fdw + file_fdw — access data files in the server's file system file_fdw diff --git a/doc/src/sgml/fuzzystrmatch.sgml b/doc/src/sgml/fuzzystrmatch.sgml index 5dedbd8f7a..2c6a666da8 100644 --- a/doc/src/sgml/fuzzystrmatch.sgml +++ b/doc/src/sgml/fuzzystrmatch.sgml @@ -1,7 +1,8 @@ - fuzzystrmatch + fuzzystrmatch — + determine string similarities and distance [trusted] fuzzystrmatch diff --git a/doc/src/sgml/hstore.sgml b/doc/src/sgml/hstore.sgml index 815ef641a0..b75c63f348 100644 --- a/doc/src/sgml/hstore.sgml +++ b/doc/src/sgml/hstore.sgml @@ -1,7 +1,7 @@ - hstore + hstore — hstore key/value datatype [trusted] hstore diff --git a/doc/src/sgml/intagg.sgml b/doc/src/sgml/intagg.sgml index 34562a66c8..ce7b929a34 100644 --- a/doc/src/sgml/intagg.sgml +++ b/doc/src/sgml/intagg.sgml @@ -1,7 +1,7 @@ - intagg + intagg — integer aggregator and enumerator [obsolete] intagg diff --git a/doc/src/sgml/intarray.sgml b/doc/src/sgml/intarray.sgml index c861f50497..9194e94c28 100644 --- a/doc/src/sgml/intarray.sgml +++ b/doc/src/sgml/intarray.sgml @@ -1,7 +1,7 @@ - intarray + intarray — manipulate arrays of integers [trusted] intarray diff --git a/doc/src/sgml/isn.sgml b/doc/src/sgml/isn.sgml index 14bf2d14aa..8008c84fe4 100644 --- a/doc/src/sgml/isn.sgml +++ b/doc/src/sgml/isn.sgml @@ -1,7 +1,8 @@ - isn + isn — data types for international standard numbers + (ISBN, EAN, UPC, etc.) [trusted] isn diff --git a/doc/src/sgml/lo.sgml b/doc/src/sgml/lo.sgml index d6076aeb7f..511e576cac 100644 --- a/doc/src/sgml/lo.sgml +++ b/doc/src/sgml/lo.sgml @@ -1,7 +1,7 @@ - lo + lo — manage large objects [trusted] lo diff --git a/doc/src/sgml/ltree.sgml b/doc/src/sgml/ltree.sgml index 45a86188cb..92264251cd 100644 --- a/doc/src/sgml/ltree.sgml +++ b/doc/src/sgml/ltree.sgml @@ -1,7 +1,7 @@ - ltree + ltree — label tree (ltree) data type [trusted] ltree diff --git a/doc/src/sgml/oldsnapshot.sgml b/doc/src/sgml/oldsnapshot.sgml index 0e03084562..a6e40043d1 100644 --- a/doc/src/sgml/oldsnapshot.sgml +++ b/doc/src/sgml/oldsnapshot.sgml @@ -1,7 +1,7 @@ - old_snapshot + old_snapshot — inspect guc-old-snapshot-threshold state old_snapshot diff --git a/doc/src/sgml/pageinspect.sgml b/doc/src/sgml/pageinspect.sgml index 8674872e8b..01f1e96204 100644 --- a/doc/src/sgml/pageinspect.sgml +++ b/doc/src/sgml/pageinspect.sgml @@ -1,7 +1,7 @@ - pageinspect + pageinspect — low-level inspection of database pages pageinspect diff --git a/doc/src/sgml/passwordcheck.sgml b/doc/src/sgml/passwordcheck.sgml index 0d89bb95b9..601f489227 100644 --- a/doc/src/sgml/passwordcheck.sgml +++ b/doc/src/sgml/passwordcheck.sgml @@ -1,7 +1,7 @@ - passwordcheck + passwordcheck — verify password strength passwordcheck diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml index 7b118f2030..f5d1901af2 100644 --- a/doc/src/sgml/pgbuffercache.sgml +++ b/doc/src/sgml/pgbuffercache.sgml @@ -1,7 +1,7 @@ - pg_buffercache + pg_buffercache — inspect Postgres buffer cache state pg_buffercache diff --git a/doc/src/sgml/pgcrypto.sgml b/doc/src/sgml/pgcrypto.sgml index bde3071923..2231a65dde 100644 --- a/doc/src/sgml/pgcrypto.sgml +++ b/doc/src/sgml/pgcrypto.sgml @@ -1,7 +1,7 @@ - pgcrypto + pgcrypto — cryptographic functions [trusted] pgcrypto diff --git a/doc/src/sgml/pgfreespacemap.sgml b/doc/src/sgml/pgfreespacemap.sgml index 9d93fb5a72..829ad60f32 100644 --- a/doc/src/sgml/pgfreespacemap.sgml +++ b/doc/src/sgml/pgfreespacemap.sgml @@ -1,7 +1,7 @@ - pg_freespacemap + pg_freespacemap — examine the free space map pg_freespacemap diff --git a/doc/src/sgml/pgprewarm.sgml b/doc/src/sgml/pgprewarm.sgml index e103a2746d..6e1de21303 100644 --- a/doc/src/sgml/pgprewarm.sgml +++ b/doc/src/sgml/pgprewarm.sgml @@ -1,7 +1,8 @@ - pg_prewarm + pg_prewarm — + preload relation data into O/S or PG buffer caches pg_prewarm diff --git a/doc/src/sgml/pgrowlocks.sgml b/doc/src/sgml/pgrowlocks.sgml index 91dfd452ee..b5e655735a 100644 --- a/doc/src/sgml/pgrowlocks.sgml +++ b/doc/src/sgml/pgrowlocks.sgml @@ -1,7 +1,7 @@ - pgrowlocks + pgrowlocks — show a table's row locking information pgrowlocks diff --git a/doc/src/sgml/pgstatstatements.sgml b/doc/src/sgml/pgstatstatements.sgml index ded33acd18..abdee744ac 100644 --- a/doc/src/sgml/pgstatstatements.sgml +++ b/doc/src/sgml/pgstatstatements.sgml @@ -1,7 +1,8 @@ - pg_stat_statements + pg_stat_statements — + track statistics of SQL planning and execution pg_stat_statements diff --git a/doc/src/sgml/pgstattuple.sgml b/doc/src/sgml/pgstattuple.sgml index 581bea2788..4071da4ed9 100644 --- a/doc/src/sgml/pgstattuple.sgml +++ b/doc/src/sgml/pgstattuple.sgml @@ -1,7 +1,7 @@ - pgstattuple + pgstattuple — obtain tuple-level statistics pgstattuple diff --git a/doc/src/sgml/pgsurgery.sgml b/doc/src/sgml/pgsurgery.sgml index 6c6be70c24..caadc10309 100644 --- a/doc/src/sgml/pgsurgery.sgml +++ b/doc/src/sgml/pgsurgery.sgml @@ -1,7 +1,7 @@ - pg_surgery + pg_surgery — perform surgery on damaged relations pg_surgery diff --git a/doc/src/sgml/pgtrgm.sgml b/doc/src/sgml/pgtrgm.sgml index f0344590dd..1497172762 100644 --- a/doc/src/sgml/pgtrgm.sgml +++ b/doc/src/sgml/pgtrgm.sgml @@ -1,7 +1,8 @@ - pg_trgm + pg_trgm — + support for similarity of text using trigram matching [trusted] pg_trgm diff --git a/doc/src/sgml/pgvisibility.sgml b/doc/src/sgml/pgvisibility.sgml index 68c43b7f39..097f7e0566 100644 --- a/doc/src/sgml/pgvisibility.sgml +++ b/doc/src/sgml/pgvisibility.sgml @@ -1,7 +1,7 @@ - pg_visibility + pg_visibility — visibility map information and utilities pg_visibility diff --git a/doc/src/sgml/pgwalinspect.sgml b/doc/src/sgml/pgwalinspect.sgml index 08eedab071..119e162e60 100644 --- a/doc/src/sgml/pgwalinspect.sgml +++ b/doc/src/sgml/pgwalinspect.sgml @@ -1,7 +1,7 @@ - pg_walinspect + pg_walinspect — low-level WAL inspection pg_walinspect diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml index 78f2d7d8d5..644f51835b 100644 --- a/doc/src/sgml/postgres-fdw.sgml +++ b/doc/src/sgml/postgres-fdw.sgml @@ -1,7 +1,8 @@ - postgres_fdw + postgres_fdw — + access data stored in external Postgres servers postgres_fdw diff --git a/doc/src/sgml/seg.sgml b/doc/src/sgml/seg.sgml index 72387c7d45..e1d20b4a0e 100644 --- a/doc/src/sgml/seg.sgml +++ b/doc/src/sgml/seg.sgml @@ -1,7 +1,8 @@ - seg + seg — + line segment/floating point interval data type [trusted] seg diff --git a/doc/src/sgml/sepgsql.sgml b/doc/src/sgml/sepgsql.sgml index fd4bb83cbf..786fdbbc26 100644 --- a/doc/src/sgml/sepgsql.sgml +++ b/doc/src/sgml/sepgsql.sgml @@ -1,7 +1,8 @@ - sepgsql + sepgsql — + SELinux-based row-level security mandatory access control sepgsql diff --git a/doc/src/sgml/sslinfo.sgml b/doc/src/sgml/sslinfo.sgml index 786f113072..85d49f6653 100644 --- a/doc/src/sgml/sslinfo.sgml +++ b/doc/src/sgml/sslinfo.sgml @@ -1,7 +1,7 @@ - sslinfo + sslinfo — obtain client SSL information sslinfo diff --git a/doc/src/sgml/stylesheet-fo.xsl b/doc/src/sgml/stylesheet-fo.xsl index 0c4dff92c4..9dde0a89dd 100644 --- a/doc/src/sgml/stylesheet-fo.xsl +++ b/doc/src/sgml/stylesheet-fo.xsl @@ -132,4 +132,10 @@ + + + + + diff --git a/doc/src/sgml/tablefunc.sgml b/doc/src/sgml/tablefunc.sgml index c1b70953f0..77e0178902 100644 --- a/doc/src/sgml/tablefunc.sgml +++ b/doc/src/sgml/tablefunc.sgml @@ -1,7 +1,8 @@ - tablefunc + tablefunc — + useful/example functions which return tables [trusted] tablefunc diff --git a/doc/src/sgml/tcn.sgml b/doc/src/sgml/tcn.sgml index 82afe9ada4..60f8ebb80f 100644 --- a/doc/src/sgml/tcn.sgml +++ b/doc/src/sgml/tcn.sgml @@ -1,7 +1,9 @@ - tcn + tcn — + a trigger function to notify listeners of changes to table content + [trusted] tcn diff --git a/doc/src/sgml/test-decoding.sgml b/doc/src/sgml/test-decoding.sgml index 9b07195427..88f72c204e 100644 --- a/doc/src/sgml/test-decoding.sgml +++ b/doc/src/sgml/test-decoding.sgml @@ -1,7 +1,7 @@ - test_decoding + test_decoding — example of WAL logical decoding in SQL test_decoding diff --git a/doc/src/sgml/tsm-system-rows.sgml b/doc/src/sgml/tsm-system-rows.sgml index f5357791c0..2c8ef6a7d4 100644 --- a/doc/src/sgml/tsm-system-rows.sgml +++ b/doc/src/sgml/tsm-system-rows.sgml @@ -1,7 +1,8 @@ - tsm_system_rows + tsm_system_rows — + a table row sampling method for TABLESAMPLE clauses [trusted] tsm_system_rows diff --git a/doc/src/sgml/tsm-system-time.sgml b/doc/src/sgml/tsm-system-time.sgml index 0de15ae7e8..e532174eab 100644 --- a/doc/src/sgml/tsm-system-time.sgml +++ b/doc/src/sgml/tsm-system-time.sgml @@ -1,7 +1,9 @@ - tsm_system_time + tsm_system_time — + a SYSTEM_TIME table sampling method for the TABLESAMPLE clauses + [trusted] tsm_system_time diff --git a/doc/src/sgml/unaccent.sgml b/doc/src/sgml/unaccent.sgml index 139a87d4ff..38df3be27d 100644 --- a/doc/src/sgml/unaccent.sgml +++ b/doc/src/sgml/unaccent.sgml @@ -1,7 +1,8 @@ - unaccent + unaccent — + a full-text search dictionary which removes diacritics [trusted] unaccent diff --git a/doc/src/sgml/uuid-ossp.sgml b/doc/src/sgml/uuid-ossp.sgml index 0a42d516e8..7cc68cdd92 100644 --- a/doc/src/sgml/uuid-ossp.sgml +++ b/doc/src/sgml/uuid-ossp.sgml @@ -1,7 +1,8 @@ - uuid-ossp + uuid-ossp — + generate UUIDs when there are special requirements [trusted] uuid-ossp diff --git a/doc/src/sgml/xml2.sgml b/doc/src/sgml/xml2.sgml index e9a223ca5b..2bd4a3fd3a 100644 --- a/doc/src/sgml/xml2.sgml +++ b/doc/src/sgml/xml2.sgml @@ -1,7 +1,7 @@ - xml2 + xml2 — XPath querying and XSLT functionality [obsolete] xml2