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 5d61a33936..48d72a24a3 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 3bc9cfb207..690774f86f 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 394fec94e8..a80910dab5 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 b2ecc373eb..fd082ceb0b 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 0b650f17a8..c412590dd6 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 a3f51cfdc4..4a188ad5f1 100644 --- a/doc/src/sgml/bloom.sgml +++ b/doc/src/sgml/bloom.sgml @@ -1,7 +1,7 @@ - bloom + bloom — bloom filter index access bloom diff --git a/doc/src/sgml/btree-gin.sgml b/doc/src/sgml/btree-gin.sgml index 5bc5a054e8..5aafe856b5 100644 --- a/doc/src/sgml/btree-gin.sgml +++ b/doc/src/sgml/btree-gin.sgml @@ -1,7 +1,8 @@ - btree_gin + btree_gin — + sample GIN B-tree equalivent operator classes [trusted] btree_gin diff --git a/doc/src/sgml/btree-gist.sgml b/doc/src/sgml/btree-gist.sgml index b67f20a00f..67ff13c77f 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 equalivent GiST index operators [trusted] btree_gist diff --git a/doc/src/sgml/citext.sgml b/doc/src/sgml/citext.sgml index 5986601327..bf08e9e6a2 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 fed6f24932..edeb5b6346 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..fd2e40980d 100644 --- a/doc/src/sgml/contrib.sgml +++ b/doc/src/sgml/contrib.sgml @@ -1,27 +1,31 @@ - Additional Supplied Modules + Additional Supplied Modules and Extensions - 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,41 @@ 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. + 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,11 +92,11 @@ 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; diff --git a/doc/src/sgml/cube.sgml b/doc/src/sgml/cube.sgml index 52506fc822..fc8d7988c3 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 8babfdd5c2..3e53a468e1 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 256aff7c58..fc1ab863d6 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 4377249c36..cc29b83164 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 382e54be91..6087aeca4f 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 335d64641b..a491a13f4d 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 c410f64f3e..67e6de6c3b 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 18c6f8c3ba..9563950397 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 709bc8345c..bde88e6ee9 100644 --- a/doc/src/sgml/isn.sgml +++ b/doc/src/sgml/isn.sgml @@ -1,7 +1,8 @@ - isn + isn — + data types for various ISN standards (UPC, books, etc.) [trusted] isn diff --git a/doc/src/sgml/lo.sgml b/doc/src/sgml/lo.sgml index f46cd392df..a3fb7aed40 100644 --- a/doc/src/sgml/lo.sgml +++ b/doc/src/sgml/lo.sgml @@ -1,7 +1,7 @@ - lo + lo — manage large objects (BLOBs) [trusted] lo diff --git a/doc/src/sgml/ltree.sgml b/doc/src/sgml/ltree.sgml index 508f404ae8..597e359fcf 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 a665ae72e7..0be8b858ac 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 04aca998e7..60a18664c4 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..6cd4f6af0e 100644 --- a/doc/src/sgml/passwordcheck.sgml +++ b/doc/src/sgml/passwordcheck.sgml @@ -1,7 +1,7 @@ - passwordcheck + passwordcheck — check for weak password when (re)set passwordcheck diff --git a/doc/src/sgml/pgcrypto.sgml b/doc/src/sgml/pgcrypto.sgml index 5316472b96..453ffcac0e 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 4dd7a084b9..e79de8f859 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 754a21a076..abf788830b 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 ad15cda668..8eb60bf288 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 ea90365c7f..063b06ede4 100644 --- a/doc/src/sgml/pgstatstatements.sgml +++ b/doc/src/sgml/pgstatstatements.sgml @@ -1,7 +1,8 @@ - pg_stat_statements + pg_stat_statements — + track SQL planning and execution statistics pg_stat_statements diff --git a/doc/src/sgml/pgstattuple.sgml b/doc/src/sgml/pgstattuple.sgml index b17b3c59e0..aa7eeecf4a 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 4bba14f217..611a173feb 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 fefe30afb7..7f295d0a6f 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 8090aa5207..b2ae8c1372 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 1a1bee7d6a..413121a9ba 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 6c94318485..f4d6fe9f94 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 9be69e3609..9280adaaac 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 620d0636e8..13f89c85b0 100644 --- a/doc/src/sgml/sepgsql.sgml +++ b/doc/src/sgml/sepgsql.sgml @@ -1,7 +1,8 @@ - sepgsql + sepgsql — + label-based, SELinux-like, mandatory access control sepgsql diff --git a/doc/src/sgml/sslinfo.sgml b/doc/src/sgml/sslinfo.sgml index 2a9c45a111..8cd1006fe0 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/tablefunc.sgml b/doc/src/sgml/tablefunc.sgml index 808162b89b..25280b598d 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 d960aa3e0f..7e53a716cb 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 df6e83a923..fd709ce012 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 5cd716a2aa..a34de537e5 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 26bfb908da..e037cbf2a1 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 47650d9dfd..ebe3246405 100644 --- a/doc/src/sgml/xml2.sgml +++ b/doc/src/sgml/xml2.sgml @@ -1,7 +1,7 @@ - xml2 + xml2 — XPath qeurying and XSLT functionality [obsolete] xml2