Appendix F. Additional Supplied Modules and Extensions
Table of Contents
- F.1. amcheck - tools to verify table and index consistency
- F.2. auth_delay - pause on authentication failure
- F.3. auto_explain - log execution plans of slow queries
- F.4. basebackup_to_shell - example "shell" pg_basebackup module
- F.5. basic_archive - an example WAL archive module
- F.6. bloom - bloom filter index access method
- F.7. btree_gin - GIN operator classes with B-tree behavior
- F.8. btree_gist - GiST operator classes with B-tree behavior
- F.9. citext - a case-insensitive character string type
- F.10. cube - a multi-dimensional cube data type
- F.11. dblink - connect to other PostgreSQL databases
-
- dblink_connect - opens a persistent connection to a remote database
- dblink_connect_u - opens a persistent connection to a remote database, insecurely
- dblink_disconnect - closes a persistent connection to a remote database
- dblink - executes a query in a remote database
- dblink_exec - executes a command in a remote database
- dblink_open - opens a cursor in a remote database
- dblink_fetch - returns rows from an open cursor in a remote database
- dblink_close - closes a cursor in a remote database
- dblink_get_connections - returns the names of all open named dblink connections
- dblink_error_message - gets last error message on the named connection
- dblink_send_query - sends an async query to a remote database
- dblink_is_busy - checks if connection is busy with an async query
- dblink_get_notify - retrieve async notifications on a connection
- dblink_get_result - gets an async query result
- dblink_cancel_query - cancels any active query on the named connection
- dblink_get_pkey - returns the positions and field names of a relation's primary key fields
- dblink_build_sql_insert - builds an INSERT statement using a local tuple, replacing the primary key field values with alternative supplied values
- dblink_build_sql_delete - builds a DELETE statement using supplied values for primary key field values
- dblink_build_sql_update - builds an UPDATE statement using a local tuple, replacing the primary key field values with alternative supplied values
- F.12. dict_int - example full-text search dictionary for integers
- F.13. dict_xsyn - example synonym full-text search dictionary
- F.14. earthdistance - calculate great-circle distances
- F.15. file_fdw - access data files in the server's file system
- F.16. fuzzystrmatch - determine string similarities and distance
- F.17. hstore - hstore key/value datatype
- F.18. intagg - integer aggregator and enumerator
- F.19. intarray - manipulate arrays of integers
- F.20. isn - data types for international standard numbers (ISBN, EAN, UPC, etc.)
- F.21. lo - manage large objects
- F.22. ltree - hierarchical tree-like data type
- F.23. pageinspect - low-level inspection of database pages
- F.24. passwordcheck - verify password strength
- F.25. pg_buffercache - inspect PostgreSQL buffer cache state
- F.26. pgcrypto - cryptographic functions
- F.27. pg_freespacemap - examine the free space map
- F.28. pg_prewarm - preload relation data into buffer caches
- F.29. pgrowlocks - show a table's row locking information
- F.30. pg_stat_statements - track statistics of SQL planning and execution
- F.31. pgstattuple - obtain tuple-level statistics
- F.32. pg_surgery - perform low-level surgery on relation data
- F.33. pg_trgm - support for similarity of text using trigram matching
- F.34. pg_visibility - visibility map information and utilities
- F.35. pg_walinspect - low-level WAL inspection
- F.36. postgres_fdw - access data stored in external PostgreSQL servers
-
- F.36.1. FDW Options of postgres_fdw
- F.36.2. Functions
- F.36.3. Connection Management
- F.36.4. Transaction Management
- F.36.5. Remote Query Optimization
- F.36.6. Remote Query Execution Environment
- F.36.7. Cross-Version Compatibility
- F.36.8. Wait Events
- F.36.9. Configuration Parameters
- F.36.10. Examples
- F.36.11. Author
- F.37. seg - a datatype for line segments or floating point intervals
- F.38. sepgsql - SELinux-, label-based mandatory access control (MAC) security module
- F.39. spi - Server Programming Interface features/examples
- F.40. sslinfo - obtain client SSL information
-
F.41. tablefunc - functions that return tables (
crosstaband others) - F.42. tcn - a trigger function to notify listeners of changes to table content
- F.43. test_decoding - SQL-based test/example module for WAL logical decoding
-
F.44. tsm_system_rows -
the
SYSTEM_ROWSsampling method forTABLESAMPLE -
F.45. tsm_system_time -
the
SYSTEM_TIMEsampling method forTABLESAMPLE - F.46. unaccent - a text search dictionary which removes diacritics
- F.47. uuid-ossp - a UUID generator
- F.48. xml2 - XPath querying and XSLT functionality
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.
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 module
libraries found in
contrib
.
Appendix G
covers utility
programs.
When building from the source distribution, these optional components are not built automatically, unless you build the "world" target (see Step 2 ). You can build and install all of them by running:
makemake install
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
running:
make check
before installation or
make installcheck
once you have a PostgreSQL server running.
If you are using a pre-packaged version of
PostgreSQL
,
these components are typically made available as a separate subpackage,
such as
postgresql-contrib
.
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 CREATE EXTENSION command. In a fresh database, you can simply do
CREATE EXTENSION extension_name;
This command registers the new SQL objects in the current database only,
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 extensions, the
CREATE EXTENSION
command 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. 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.
The following extensions are trusted in a default installation:
| btree_gin | fuzzystrmatch | ltree | tcn |
| btree_gist | hstore | pgcrypto | tsm_system_rows |
| citext | intarray | pg_trgm | tsm_system_time |
| cube | isn | seg | unaccent |
| dict_int | lo | tablefunc | uuid-ossp |
Many extensions allow you to install their objects in a schema of your
choice. To do that, add
SCHEMA
to the
schema_name
CREATE EXTENSION
command. By default, the objects will be placed in your current creation
target schema, which in turn defaults to
public
.
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 shared_preload_libraries . See the documentation of each component for details.