Appendix F. Additional Supplied Modules and Extensions

Table of Contents

F.1. adminpack — pgAdmin support toolpack
F.2. amcheck — tools to verify table and index consistency
F.3. apache_age — graph database functionality
F.4. aqo — cost-based query optimization
F.5. auth_delay — pause on authentication failure
F.6. auto_explain — log execution plans of slow queries
F.7. basebackup_to_shell — example "shell" pg_basebackup module
F.8. basic_archive — an example WAL archive module
F.9. biha — built-in high-availability cluster
F.10. bloom — bloom filter index access method
F.11. btree_gin — GIN operator classes with B-tree behavior
F.12. btree_gist — GiST operator classes with B-tree behavior
F.13. citext — a case-insensitive character string type
F.14. cube — a multi-dimensional cube data type
F.15. dbcopies_decoding
F.16. dblink — connect to other Postgres Pro databases
F.17. dbms_lob — operate on large objects
F.18. dict_int — example full-text search dictionary for integers
F.19. dict_xsyn — example synonym full-text search dictionary
F.20. dump_stat — functions to backup and recover the pg_statistic table
F.21. earthdistance — calculate great-circle distances
F.22. fasttrun — a transaction unsafe function to truncate temporary tables
F.23. file_fdw — access data files in the server's file system
F.24. fulleq — an additional equivalence operator for compatibility with Microsoft SQL Server
F.25. fuzzystrmatch — determine string similarities and distance
F.26. hstore — hstore key/value datatype
F.27. Hunspell Dictionaries Modules
F.28. in_memory — store data in shared memory using tables implemented via FDW
F.29. intagg — integer aggregator and enumerator
F.30. intarray — manipulate arrays of integers
F.31. isn — data types for international standard numbers (ISBN, EAN, UPC, etc.)
F.32. jsquery — a language to query jsonb data type
F.33. lo — manage large objects
F.34. ltree — hierarchical tree-like data type
F.35. mchar — additional data types for compatibility with Microsoft SQL Server
F.36. multimaster — synchronous cluster to provide OLTP scalability and high availability
F.37. online_analyze — update statistics after INSERT, UPDATE, DELETE, or SELECT INTO operations
F.38. old_snapshot — inspect old_snapshot_threshold state
F.39. pageinspect — low-level inspection of database pages
F.40. passwordcheck — verify password strength
F.41. pg_buffercache — inspect Postgres Pro buffer cache state
F.42. pgcrypto — cryptographic functions
F.43. pg_freespacemap — examine the free space map
F.44. pg_hint_plan — control an execution plan with hinting phrases
F.45. pg_pathman — an optimized partitioning solution for large and distributed databases
F.46. pgpro_anonymizer — mask or replace sensitive data
F.47. pgpro_application_info — port applications using DBMS_APPLICATION_INFO package
F.48. pgpro_bfile — a composite type to access an external file or S3 storage
F.49. pg_proaudit — enables detailed logging of various security events
F.50. pgpro_pwr — workload reports
F.51. pg_prewarm — preload relation data into buffer caches
F.52. pgpro_rp — resource prioritization
F.53. pgpro_scheduler — scheduling, monitoring and managing job execution
F.54. pgpro_sfile — storage for large objects
F.55. pgpro_stats — a means for tracking planning and execution statistics of all SQL statements executed by a server
F.56. pg_query_state — a facility to know the current state of query execution on working backend
F.57. pgrowlocks — show a table's row locking information
F.58. pg_stat_statements — track statistics of SQL planning and execution
F.59. pgstattuple — obtain tuple-level statistics
F.60. pg_surgery — perform low-level surgery on relation data
F.61. pg_transfer — quick transfer of tables between instances
F.62. pg_trgm — support for similarity of text using trigram matching
F.63. pg_tsparser — an extension for text search
F.64. pg_variables — functions for working with variables of various types
F.65. pg_visibility — visibility map information and utilities
F.66. pg_wait_sampling — collecting sampling-based statistics on wait events
F.67. pg_walinspect — low-level WAL inspection
F.68. plantuner — hints for the planner to disable or enable indexes for query execution
F.69. postgres_fdw — access data stored in external Postgres Pro servers
F.70. ptrack — a block-level incremental backup engine for Postgres Pro
F.71. referee — manage quorum settings with an even number of nodes configured with multimaster
F.72. rum — an access method to work with the RUM indexes
F.73. seg — a datatype for line segments or floating point intervals
F.74. shared_ispell — a shared ispell dictionary
F.75. spi — Server Programming Interface features/examples
F.76. sr_plan — save a specific plan of a parameterized query for future usage
F.77. sslinfo — obtain client SSL information
F.78. tablefunc — functions that return tables (crosstab and others)
F.79. tcn — a trigger function to notify listeners of changes to table content
F.80. test_decoding — SQL-based test/example module for WAL logical decoding
F.81. tsm_system_rows — the SYSTEM_ROWS sampling method for TABLESAMPLE
F.82. tsm_system_time — the SYSTEM_TIME sampling method for TABLESAMPLE
F.83. unaccent — a text search dictionary which removes diacritics
F.84. utl_http — access data on the Internet over the HTTP protocol
F.85. utl_mail — manage emails
F.86. utl_smtp — send emails over SMTP
F.87. uuid-ossp — a UUID generator
F.88. vops — support for vector operations
F.89. xml2 — XPath querying and XSLT functionality

This appendix and the next one contain information on the optional components available in the Postgres Pro Enterprise distribution. These include porting tools, analysis utilities, and plug-in features that are not part of the core Postgres Pro 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 the extensions and other server plug-in modules. Appendix G covers the utility programs.

In Postgres Pro Enterprise, these modules are made available as a separate subpackage postgrespro-ent-16-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:


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 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.