1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix F. Additional Supplied Modules and Extensions</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="release-prior.html" title="E.4. Prior Releases" /><link rel="next" href="adminpack.html" title="F.1. adminpack — pgAdmin support toolpack" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">Appendix F. Additional Supplied Modules and Extensions</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="release-prior.html" title="E.4. Prior Releases">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="appendixes.html" title="Part VIII. Appendixes">Up</a></td><th width="60%" align="center">Part VIII. Appendixes</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 16.2 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="adminpack.html" title="F.1. adminpack — pgAdmin support toolpack">Next</a></td></tr></table><hr /></div><div class="appendix" id="CONTRIB"><div class="titlepage"><div><div><h2 class="title">Appendix F. Additional Supplied Modules and Extensions</h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="sect1"><a href="adminpack.html">F.1. adminpack — pgAdmin support toolpack</a></span></dt><dt><span class="sect1"><a href="amcheck.html">F.2. amcheck — tools to verify table and index consistency</a></span></dt><dd><dl><dt><span class="sect2"><a href="amcheck.html#AMCHECK-FUNCTIONS">F.2.1. Functions</a></span></dt><dt><span class="sect2"><a href="amcheck.html#AMCHECK-OPTIONAL-HEAPALLINDEXED-VERIFICATION">F.2.2. Optional <em class="parameter"><code>heapallindexed</code></em> Verification</a></span></dt><dt><span class="sect2"><a href="amcheck.html#AMCHECK-USING-AMCHECK-EFFECTIVELY">F.2.3. Using <code class="filename">amcheck</code> Effectively</a></span></dt><dt><span class="sect2"><a href="amcheck.html#AMCHECK-REPAIRING-CORRUPTION">F.2.4. Repairing Corruption</a></span></dt></dl></dd><dt><span class="sect1"><a href="auth-delay.html">F.3. auth_delay — pause on authentication failure</a></span></dt><dd><dl><dt><span class="sect2"><a href="auth-delay.html#AUTH-DELAY-CONFIGURATION-PARAMETERS">F.3.1. Configuration Parameters</a></span></dt><dt><span class="sect2"><a href="auth-delay.html#AUTH-DELAY-AUTHOR">F.3.2. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="auto-explain.html">F.4. auto_explain — log execution plans of slow queries</a></span></dt><dd><dl><dt><span class="sect2"><a href="auto-explain.html#AUTO-EXPLAIN-CONFIGURATION-PARAMETERS">F.4.1. Configuration Parameters</a></span></dt><dt><span class="sect2"><a href="auto-explain.html#AUTO-EXPLAIN-EXAMPLE">F.4.2. Example</a></span></dt><dt><span class="sect2"><a href="auto-explain.html#AUTO-EXPLAIN-AUTHOR">F.4.3. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="basebackup-to-shell.html">F.5. basebackup_to_shell — example "shell" pg_basebackup module</a></span></dt><dd><dl><dt><span class="sect2"><a href="basebackup-to-shell.html#BASEBACKUP-TO-SHELL-CONFIGURATION-PARAMETERS">F.5.1. Configuration Parameters</a></span></dt><dt><span class="sect2"><a href="basebackup-to-shell.html#BASEBACKUP-TO-SHELL-AUTHOR">F.5.2. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="basic-archive.html">F.6. basic_archive — an example WAL archive module</a></span></dt><dd><dl><dt><span class="sect2"><a href="basic-archive.html#BASIC-ARCHIVE-CONFIGURATION-PARAMETERS">F.6.1. Configuration Parameters</a></span></dt><dt><span class="sect2"><a href="basic-archive.html#BASIC-ARCHIVE-NOTES">F.6.2. Notes</a></span></dt><dt><span class="sect2"><a href="basic-archive.html#BASIC-ARCHIVE-AUTHOR">F.6.3. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="bloom.html">F.7. bloom — bloom filter index access method</a></span></dt><dd><dl><dt><span class="sect2"><a href="bloom.html#BLOOM-PARAMETERS">F.7.1. Parameters</a></span></dt><dt><span class="sect2"><a href="bloom.html#BLOOM-EXAMPLES">F.7.2. Examples</a></span></dt><dt><span class="sect2"><a href="bloom.html#BLOOM-OPERATOR-CLASS-INTERFACE">F.7.3. Operator Class Interface</a></span></dt><dt><span class="sect2"><a href="bloom.html#BLOOM-LIMITATIONS">F.7.4. Limitations</a></span></dt><dt><span class="sect2"><a href="bloom.html#BLOOM-AUTHORS">F.7.5. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="btree-gin.html">F.8. btree_gin — GIN operator classes with B-tree behavior</a></span></dt><dd><dl><dt><span class="sect2"><a href="btree-gin.html#BTREE-GIN-EXAMPLE-USAGE">F.8.1. Example Usage</a></span></dt><dt><span class="sect2"><a href="btree-gin.html#BTREE-GIN-AUTHORS">F.8.2. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="btree-gist.html">F.9. btree_gist — GiST operator classes with B-tree behavior</a></span></dt><dd><dl><dt><span class="sect2"><a href="btree-gist.html#BTREE-GIST-EXAMPLE-USAGE">F.9.1. Example Usage</a></span></dt><dt><span class="sect2"><a href="btree-gist.html#BTREE-GIST-AUTHORS">F.9.2. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="citext.html">F.10. citext — a case-insensitive character string type</a></span></dt><dd><dl><dt><span class="sect2"><a href="citext.html#CITEXT-RATIONALE">F.10.1. Rationale</a></span></dt><dt><span class="sect2"><a href="citext.html#CITEXT-HOW-TO-USE-IT">F.10.2. How to Use It</a></span></dt><dt><span class="sect2"><a href="citext.html#CITEXT-STRING-COMPARISON-BEHAVIOR">F.10.3. String Comparison Behavior</a></span></dt><dt><span class="sect2"><a href="citext.html#CITEXT-LIMITATIONS">F.10.4. Limitations</a></span></dt><dt><span class="sect2"><a href="citext.html#CITEXT-AUTHOR">F.10.5. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="cube.html">F.11. cube — a multi-dimensional cube data type</a></span></dt><dd><dl><dt><span class="sect2"><a href="cube.html#CUBE-SYNTAX">F.11.1. Syntax</a></span></dt><dt><span class="sect2"><a href="cube.html#CUBE-PRECISION">F.11.2. Precision</a></span></dt><dt><span class="sect2"><a href="cube.html#CUBE-USAGE">F.11.3. Usage</a></span></dt><dt><span class="sect2"><a href="cube.html#CUBE-DEFAULTS">F.11.4. Defaults</a></span></dt><dt><span class="sect2"><a href="cube.html#CUBE-NOTES">F.11.5. Notes</a></span></dt><dt><span class="sect2"><a href="cube.html#CUBE-CREDITS">F.11.6. Credits</a></span></dt></dl></dd><dt><span class="sect1"><a href="dblink.html">F.12. dblink — connect to other PostgreSQL databases</a></span></dt><dd><dl><dt><span class="refentrytitle"><a href="contrib-dblink-connect.html">dblink_connect</a></span><span class="refpurpose"> — opens a persistent connection to a remote database</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-connect-u.html">dblink_connect_u</a></span><span class="refpurpose"> — opens a persistent connection to a remote database, insecurely</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-disconnect.html">dblink_disconnect</a></span><span class="refpurpose"> — closes a persistent connection to a remote database</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-function.html">dblink</a></span><span class="refpurpose"> — executes a query in a remote database</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-exec.html">dblink_exec</a></span><span class="refpurpose"> — executes a command in a remote database</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-open.html">dblink_open</a></span><span class="refpurpose"> — opens a cursor in a remote database</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-fetch.html">dblink_fetch</a></span><span class="refpurpose"> — returns rows from an open cursor in a remote database</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-close.html">dblink_close</a></span><span class="refpurpose"> — closes a cursor in a remote database</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-get-connections.html">dblink_get_connections</a></span><span class="refpurpose"> — returns the names of all open named dblink connections</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-error-message.html">dblink_error_message</a></span><span class="refpurpose"> — gets last error message on the named connection</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-send-query.html">dblink_send_query</a></span><span class="refpurpose"> — sends an async query to a remote database</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-is-busy.html">dblink_is_busy</a></span><span class="refpurpose"> — checks if connection is busy with an async query</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-get-notify.html">dblink_get_notify</a></span><span class="refpurpose"> — retrieve async notifications on a connection</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-get-result.html">dblink_get_result</a></span><span class="refpurpose"> — gets an async query result</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-cancel-query.html">dblink_cancel_query</a></span><span class="refpurpose"> — cancels any active query on the named connection</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-get-pkey.html">dblink_get_pkey</a></span><span class="refpurpose"> — returns the positions and field names of a relation's
primary key fields
</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-build-sql-insert.html">dblink_build_sql_insert</a></span><span class="refpurpose"> —
builds an INSERT statement using a local tuple, replacing the
primary key field values with alternative supplied values
</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-build-sql-delete.html">dblink_build_sql_delete</a></span><span class="refpurpose"> — builds a DELETE statement using supplied values for primary
key field values
</span></dt><dt><span class="refentrytitle"><a href="contrib-dblink-build-sql-update.html">dblink_build_sql_update</a></span><span class="refpurpose"> — builds an UPDATE statement using a local tuple, replacing
the primary key field values with alternative supplied values
</span></dt></dl></dd><dt><span class="sect1"><a href="dict-int.html">F.13. dict_int —
example full-text search dictionary for integers</a></span></dt><dd><dl><dt><span class="sect2"><a href="dict-int.html#DICT-INT-CONFIG">F.13.1. Configuration</a></span></dt><dt><span class="sect2"><a href="dict-int.html#DICT-INT-USAGE">F.13.2. Usage</a></span></dt></dl></dd><dt><span class="sect1"><a href="dict-xsyn.html">F.14. dict_xsyn — example synonym full-text search dictionary</a></span></dt><dd><dl><dt><span class="sect2"><a href="dict-xsyn.html#DICT-XSYN-CONFIG">F.14.1. Configuration</a></span></dt><dt><span class="sect2"><a href="dict-xsyn.html#DICT-XSYN-USAGE">F.14.2. Usage</a></span></dt></dl></dd><dt><span class="sect1"><a href="earthdistance.html">F.15. earthdistance — calculate great-circle distances</a></span></dt><dd><dl><dt><span class="sect2"><a href="earthdistance.html#EARTHDISTANCE-CUBE-BASED">F.15.1. Cube-Based Earth Distances</a></span></dt><dt><span class="sect2"><a href="earthdistance.html#EARTHDISTANCE-POINT-BASED">F.15.2. Point-Based Earth Distances</a></span></dt></dl></dd><dt><span class="sect1"><a href="file-fdw.html">F.16. file_fdw — access data files in the server's file system</a></span></dt><dt><span class="sect1"><a href="fuzzystrmatch.html">F.17. fuzzystrmatch — determine string similarities and distance</a></span></dt><dd><dl><dt><span class="sect2"><a href="fuzzystrmatch.html#FUZZYSTRMATCH-SOUNDEX">F.17.1. Soundex</a></span></dt><dt><span class="sect2"><a href="fuzzystrmatch.html#FUZZYSTRMATCH-DAITCH-MOKOTOFF">F.17.2. Daitch-Mokotoff Soundex</a></span></dt><dt><span class="sect2"><a href="fuzzystrmatch.html#FUZZYSTRMATCH-LEVENSHTEIN">F.17.3. Levenshtein</a></span></dt><dt><span class="sect2"><a href="fuzzystrmatch.html#FUZZYSTRMATCH-METAPHONE">F.17.4. Metaphone</a></span></dt><dt><span class="sect2"><a href="fuzzystrmatch.html#FUZZYSTRMATCH-DOUBLE-METAPHONE">F.17.5. Double Metaphone</a></span></dt></dl></dd><dt><span class="sect1"><a href="hstore.html">F.18. hstore — hstore key/value datatype</a></span></dt><dd><dl><dt><span class="sect2"><a href="hstore.html#HSTORE-EXTERNAL-REP">F.18.1. <code class="type">hstore</code> External Representation</a></span></dt><dt><span class="sect2"><a href="hstore.html#HSTORE-OPS-FUNCS">F.18.2. <code class="type">hstore</code> Operators and Functions</a></span></dt><dt><span class="sect2"><a href="hstore.html#HSTORE-INDEXES">F.18.3. Indexes</a></span></dt><dt><span class="sect2"><a href="hstore.html#HSTORE-EXAMPLES">F.18.4. Examples</a></span></dt><dt><span class="sect2"><a href="hstore.html#HSTORE-STATISTICS">F.18.5. Statistics</a></span></dt><dt><span class="sect2"><a href="hstore.html#HSTORE-COMPATIBILITY">F.18.6. Compatibility</a></span></dt><dt><span class="sect2"><a href="hstore.html#HSTORE-TRANSFORMS">F.18.7. Transforms</a></span></dt><dt><span class="sect2"><a href="hstore.html#HSTORE-AUTHORS">F.18.8. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="intagg.html">F.19. intagg — integer aggregator and enumerator</a></span></dt><dd><dl><dt><span class="sect2"><a href="intagg.html#INTAGG-FUNCTIONS">F.19.1. Functions</a></span></dt><dt><span class="sect2"><a href="intagg.html#INTAGG-SAMPLES">F.19.2. Sample Uses</a></span></dt></dl></dd><dt><span class="sect1"><a href="intarray.html">F.20. intarray — manipulate arrays of integers</a></span></dt><dd><dl><dt><span class="sect2"><a href="intarray.html#INTARRAY-FUNCS-OPS">F.20.1. <code class="filename">intarray</code> Functions and Operators</a></span></dt><dt><span class="sect2"><a href="intarray.html#INTARRAY-INDEX">F.20.2. Index Support</a></span></dt><dt><span class="sect2"><a href="intarray.html#INTARRAY-EXAMPLE">F.20.3. Example</a></span></dt><dt><span class="sect2"><a href="intarray.html#INTARRAY-BENCHMARK">F.20.4. Benchmark</a></span></dt><dt><span class="sect2"><a href="intarray.html#INTARRAY-AUTHORS">F.20.5. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="isn.html">F.21. isn — data types for international standard numbers (ISBN, EAN, UPC, etc.)</a></span></dt><dd><dl><dt><span class="sect2"><a href="isn.html#ISN-DATA-TYPES">F.21.1. Data Types</a></span></dt><dt><span class="sect2"><a href="isn.html#ISN-CASTS">F.21.2. Casts</a></span></dt><dt><span class="sect2"><a href="isn.html#ISN-FUNCS-OPS">F.21.3. Functions and Operators</a></span></dt><dt><span class="sect2"><a href="isn.html#ISN-EXAMPLES">F.21.4. Examples</a></span></dt><dt><span class="sect2"><a href="isn.html#ISN-BIBLIOGRAPHY">F.21.5. Bibliography</a></span></dt><dt><span class="sect2"><a href="isn.html#ISN-AUTHOR">F.21.6. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="lo.html">F.22. lo — manage large objects</a></span></dt><dd><dl><dt><span class="sect2"><a href="lo.html#LO-RATIONALE">F.22.1. Rationale</a></span></dt><dt><span class="sect2"><a href="lo.html#LO-HOW-TO-USE">F.22.2. How to Use It</a></span></dt><dt><span class="sect2"><a href="lo.html#LO-LIMITATIONS">F.22.3. Limitations</a></span></dt><dt><span class="sect2"><a href="lo.html#LO-AUTHOR">F.22.4. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="ltree.html">F.23. ltree — hierarchical tree-like data type</a></span></dt><dd><dl><dt><span class="sect2"><a href="ltree.html#LTREE-DEFINITIONS">F.23.1. Definitions</a></span></dt><dt><span class="sect2"><a href="ltree.html#LTREE-OPS-FUNCS">F.23.2. Operators and Functions</a></span></dt><dt><span class="sect2"><a href="ltree.html#LTREE-INDEXES">F.23.3. Indexes</a></span></dt><dt><span class="sect2"><a href="ltree.html#LTREE-EXAMPLE">F.23.4. Example</a></span></dt><dt><span class="sect2"><a href="ltree.html#LTREE-TRANSFORMS">F.23.5. Transforms</a></span></dt><dt><span class="sect2"><a href="ltree.html#LTREE-AUTHORS">F.23.6. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="oldsnapshot.html">F.24. old_snapshot — inspect <code class="literal">old_snapshot_threshold</code> state</a></span></dt><dd><dl><dt><span class="sect2"><a href="oldsnapshot.html#OLDSNAPSHOT-FUNCTIONS">F.24.1. Functions</a></span></dt></dl></dd><dt><span class="sect1"><a href="pageinspect.html">F.25. pageinspect — low-level inspection of database pages</a></span></dt><dd><dl><dt><span class="sect2"><a href="pageinspect.html#PAGEINSPECT-GENERAL-FUNCS">F.25.1. General Functions</a></span></dt><dt><span class="sect2"><a href="pageinspect.html#PAGEINSPECT-HEAP-FUNCS">F.25.2. Heap Functions</a></span></dt><dt><span class="sect2"><a href="pageinspect.html#PAGEINSPECT-B-TREE-FUNCS">F.25.3. B-Tree Functions</a></span></dt><dt><span class="sect2"><a href="pageinspect.html#PAGEINSPECT-BRIN-FUNCS">F.25.4. BRIN Functions</a></span></dt><dt><span class="sect2"><a href="pageinspect.html#PAGEINSPECT-GIN-FUNCS">F.25.5. GIN Functions</a></span></dt><dt><span class="sect2"><a href="pageinspect.html#PAGEINSPECT-GIST-FUNCS">F.25.6. GiST Functions</a></span></dt><dt><span class="sect2"><a href="pageinspect.html#PAGEINSPECT-HASH-FUNCS">F.25.7. Hash Functions</a></span></dt></dl></dd><dt><span class="sect1"><a href="passwordcheck.html">F.26. passwordcheck — verify password strength</a></span></dt><dt><span class="sect1"><a href="pgbuffercache.html">F.27. pg_buffercache — inspect <span class="productname">PostgreSQL</span>
buffer cache state</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgbuffercache.html#PGBUFFERCACHE-PG-BUFFERCACHE">F.27.1. The <code class="structname">pg_buffercache</code> View</a></span></dt><dt><span class="sect2"><a href="pgbuffercache.html#PGBUFFERCACHE-SUMMARY">F.27.2. The <code class="function">pg_buffercache_summary()</code> Function</a></span></dt><dt><span class="sect2"><a href="pgbuffercache.html#PGBUFFERCACHE-USAGE-COUNTS">F.27.3. The <code class="function">pg_buffercache_usage_counts()</code> Function</a></span></dt><dt><span class="sect2"><a href="pgbuffercache.html#PGBUFFERCACHE-SAMPLE-OUTPUT">F.27.4. Sample Output</a></span></dt><dt><span class="sect2"><a href="pgbuffercache.html#PGBUFFERCACHE-AUTHORS">F.27.5. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="pgcrypto.html">F.28. pgcrypto — cryptographic functions</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgcrypto.html#PGCRYPTO-GENERAL-HASHING-FUNCS">F.28.1. General Hashing Functions</a></span></dt><dt><span class="sect2"><a href="pgcrypto.html#PGCRYPTO-PASSWORD-HASHING-FUNCS">F.28.2. Password Hashing Functions</a></span></dt><dt><span class="sect2"><a href="pgcrypto.html#PGCRYPTO-PGP-ENC-FUNCS">F.28.3. PGP Encryption Functions</a></span></dt><dt><span class="sect2"><a href="pgcrypto.html#PGCRYPTO-RAW-ENC-FUNCS">F.28.4. Raw Encryption Functions</a></span></dt><dt><span class="sect2"><a href="pgcrypto.html#PGCRYPTO-RANDOM-DATA-FUNCS">F.28.5. Random-Data Functions</a></span></dt><dt><span class="sect2"><a href="pgcrypto.html#PGCRYPTO-NOTES">F.28.6. Notes</a></span></dt><dt><span class="sect2"><a href="pgcrypto.html#PGCRYPTO-AUTHOR">F.28.7. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="pgfreespacemap.html">F.29. pg_freespacemap — examine the free space map</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgfreespacemap.html#PGFREESPACEMAP-FUNCS">F.29.1. Functions</a></span></dt><dt><span class="sect2"><a href="pgfreespacemap.html#PGFREESPACEMAP-SAMPLE-OUTPUT">F.29.2. Sample Output</a></span></dt><dt><span class="sect2"><a href="pgfreespacemap.html#PGFREESPACEMAP-AUTHOR">F.29.3. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="pgprewarm.html">F.30. pg_prewarm — preload relation data into buffer caches</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgprewarm.html#PGPREWARM-FUNCS">F.30.1. Functions</a></span></dt><dt><span class="sect2"><a href="pgprewarm.html#PGPREWARM-CONFIG-PARAMS">F.30.2. Configuration Parameters</a></span></dt><dt><span class="sect2"><a href="pgprewarm.html#PGPREWARM-AUTHOR">F.30.3. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="pgrowlocks.html">F.31. pgrowlocks — show a table's row locking information</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgrowlocks.html#PGROWLOCKS-OVERVIEW">F.31.1. Overview</a></span></dt><dt><span class="sect2"><a href="pgrowlocks.html#PGROWLOCKS-SAMPLE-OUTPUT">F.31.2. Sample Output</a></span></dt><dt><span class="sect2"><a href="pgrowlocks.html#PGROWLOCKS-AUTHOR">F.31.3. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="pgstatstatements.html">F.32. pg_stat_statements — track statistics of SQL planning and execution</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgstatstatements.html#PGSTATSTATEMENTS-PG-STAT-STATEMENTS">F.32.1. The <code class="structname">pg_stat_statements</code> View</a></span></dt><dt><span class="sect2"><a href="pgstatstatements.html#PGSTATSTATEMENTS-PG-STAT-STATEMENTS-INFO">F.32.2. The <code class="structname">pg_stat_statements_info</code> View</a></span></dt><dt><span class="sect2"><a href="pgstatstatements.html#PGSTATSTATEMENTS-FUNCS">F.32.3. Functions</a></span></dt><dt><span class="sect2"><a href="pgstatstatements.html#PGSTATSTATEMENTS-CONFIG-PARAMS">F.32.4. Configuration Parameters</a></span></dt><dt><span class="sect2"><a href="pgstatstatements.html#PGSTATSTATEMENTS-SAMPLE-OUTPUT">F.32.5. Sample Output</a></span></dt><dt><span class="sect2"><a href="pgstatstatements.html#PGSTATSTATEMENTS-AUTHORS">F.32.6. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="pgstattuple.html">F.33. pgstattuple — obtain tuple-level statistics</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgstattuple.html#PGSTATTUPLE-FUNCS">F.33.1. Functions</a></span></dt><dt><span class="sect2"><a href="pgstattuple.html#PGSTATTUPLE-AUTHORS">F.33.2. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="pgsurgery.html">F.34. pg_surgery — perform low-level surgery on relation data</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgsurgery.html#PGSURGERY-FUNCS">F.34.1. Functions</a></span></dt><dt><span class="sect2"><a href="pgsurgery.html#PGSURGERY-AUTHORS">F.34.2. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="pgtrgm.html">F.35. pg_trgm —
support for similarity of text using trigram matching</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgtrgm.html#PGTRGM-CONCEPTS">F.35.1. Trigram (or Trigraph) Concepts</a></span></dt><dt><span class="sect2"><a href="pgtrgm.html#PGTRGM-FUNCS-OPS">F.35.2. Functions and Operators</a></span></dt><dt><span class="sect2"><a href="pgtrgm.html#PGTRGM-GUC">F.35.3. GUC Parameters</a></span></dt><dt><span class="sect2"><a href="pgtrgm.html#PGTRGM-INDEX">F.35.4. Index Support</a></span></dt><dt><span class="sect2"><a href="pgtrgm.html#PGTRGM-TEXT-SEARCH">F.35.5. Text Search Integration</a></span></dt><dt><span class="sect2"><a href="pgtrgm.html#PGTRGM-REFERENCES">F.35.6. References</a></span></dt><dt><span class="sect2"><a href="pgtrgm.html#PGTRGM-AUTHORS">F.35.7. Authors</a></span></dt></dl></dd><dt><span class="sect1"><a href="pgvisibility.html">F.36. pg_visibility — visibility map information and utilities</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgvisibility.html#PGVISIBILITY-FUNCS">F.36.1. Functions</a></span></dt><dt><span class="sect2"><a href="pgvisibility.html#PGVISIBILITY-AUTHOR">F.36.2. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="pgwalinspect.html">F.37. pg_walinspect — low-level WAL inspection</a></span></dt><dd><dl><dt><span class="sect2"><a href="pgwalinspect.html#PGWALINSPECT-FUNCS">F.37.1. General Functions</a></span></dt><dt><span class="sect2"><a href="pgwalinspect.html#PGWALINSPECT-AUTHOR">F.37.2. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="postgres-fdw.html">F.38. postgres_fdw —
access data stored in external <span class="productname">PostgreSQL</span>
servers</a></span></dt><dd><dl><dt><span class="sect2"><a href="postgres-fdw.html#POSTGRES-FDW-OPTIONS">F.38.1. FDW Options of postgres_fdw</a></span></dt><dt><span class="sect2"><a href="postgres-fdw.html#POSTGRES-FDW-FUNCTIONS">F.38.2. Functions</a></span></dt><dt><span class="sect2"><a href="postgres-fdw.html#POSTGRES-FDW-CONNECTION-MANAGEMENT">F.38.3. Connection Management</a></span></dt><dt><span class="sect2"><a href="postgres-fdw.html#POSTGRES-FDW-TRANSACTION-MANAGEMENT">F.38.4. Transaction Management</a></span></dt><dt><span class="sect2"><a href="postgres-fdw.html#POSTGRES-FDW-REMOTE-QUERY-OPTIMIZATION">F.38.5. Remote Query Optimization</a></span></dt><dt><span class="sect2"><a href="postgres-fdw.html#POSTGRES-FDW-REMOTE-QUERY-EXECUTION-ENVIRONMENT">F.38.6. Remote Query Execution Environment</a></span></dt><dt><span class="sect2"><a href="postgres-fdw.html#POSTGRES-FDW-CROSS-VERSION-COMPATIBILITY">F.38.7. Cross-Version Compatibility</a></span></dt><dt><span class="sect2"><a href="postgres-fdw.html#POSTGRES-FDW-CONFIGURATION-PARAMETERS">F.38.8. Configuration Parameters</a></span></dt><dt><span class="sect2"><a href="postgres-fdw.html#POSTGRES-FDW-EXAMPLES">F.38.9. Examples</a></span></dt><dt><span class="sect2"><a href="postgres-fdw.html#POSTGRES-FDW-AUTHOR">F.38.10. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="seg.html">F.39. seg — a datatype for line segments or floating point intervals</a></span></dt><dd><dl><dt><span class="sect2"><a href="seg.html#SEG-RATIONALE">F.39.1. Rationale</a></span></dt><dt><span class="sect2"><a href="seg.html#SEG-SYNTAX">F.39.2. Syntax</a></span></dt><dt><span class="sect2"><a href="seg.html#SEG-PRECISION">F.39.3. Precision</a></span></dt><dt><span class="sect2"><a href="seg.html#SEG-USAGE">F.39.4. Usage</a></span></dt><dt><span class="sect2"><a href="seg.html#SEG-NOTES">F.39.5. Notes</a></span></dt><dt><span class="sect2"><a href="seg.html#SEG-CREDITS">F.39.6. Credits</a></span></dt></dl></dd><dt><span class="sect1"><a href="sepgsql.html">F.40. sepgsql —
SELinux-, label-based mandatory access control (MAC) security module</a></span></dt><dd><dl><dt><span class="sect2"><a href="sepgsql.html#SEPGSQL-OVERVIEW">F.40.1. Overview</a></span></dt><dt><span class="sect2"><a href="sepgsql.html#SEPGSQL-INSTALLATION">F.40.2. Installation</a></span></dt><dt><span class="sect2"><a href="sepgsql.html#SEPGSQL-REGRESSION">F.40.3. Regression Tests</a></span></dt><dt><span class="sect2"><a href="sepgsql.html#SEPGSQL-PARAMETERS">F.40.4. GUC Parameters</a></span></dt><dt><span class="sect2"><a href="sepgsql.html#SEPGSQL-FEATURES">F.40.5. Features</a></span></dt><dt><span class="sect2"><a href="sepgsql.html#SEPGSQL-FUNCTIONS">F.40.6. Sepgsql Functions</a></span></dt><dt><span class="sect2"><a href="sepgsql.html#SEPGSQL-LIMITATIONS">F.40.7. Limitations</a></span></dt><dt><span class="sect2"><a href="sepgsql.html#SEPGSQL-RESOURCES">F.40.8. External Resources</a></span></dt><dt><span class="sect2"><a href="sepgsql.html#SEPGSQL-AUTHOR">F.40.9. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="contrib-spi.html">F.41. spi — Server Programming Interface features/examples</a></span></dt><dd><dl><dt><span class="sect2"><a href="contrib-spi.html#CONTRIB-SPI-REFINT">F.41.1. refint — Functions for Implementing Referential Integrity</a></span></dt><dt><span class="sect2"><a href="contrib-spi.html#CONTRIB-SPI-AUTOINC">F.41.2. autoinc — Functions for Autoincrementing Fields</a></span></dt><dt><span class="sect2"><a href="contrib-spi.html#CONTRIB-SPI-INSERT-USERNAME">F.41.3. insert_username — Functions for Tracking Who Changed a Table</a></span></dt><dt><span class="sect2"><a href="contrib-spi.html#CONTRIB-SPI-MODDATETIME">F.41.4. moddatetime — Functions for Tracking Last Modification Time</a></span></dt></dl></dd><dt><span class="sect1"><a href="sslinfo.html">F.42. sslinfo — obtain client SSL information</a></span></dt><dd><dl><dt><span class="sect2"><a href="sslinfo.html#SSLINFO-FUNCTIONS">F.42.1. Functions Provided</a></span></dt><dt><span class="sect2"><a href="sslinfo.html#SSLINFO-AUTHOR">F.42.2. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="tablefunc.html">F.43. tablefunc — functions that return tables (<code class="function">crosstab</code> and others)</a></span></dt><dd><dl><dt><span class="sect2"><a href="tablefunc.html#TABLEFUNC-FUNCTIONS-SECT">F.43.1. Functions Provided</a></span></dt><dt><span class="sect2"><a href="tablefunc.html#TABLEFUNC-AUTHOR">F.43.2. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="tcn.html">F.44. tcn — a trigger function to notify listeners of changes to table content</a></span></dt><dt><span class="sect1"><a href="test-decoding.html">F.45. test_decoding — SQL-based test/example module for WAL logical decoding</a></span></dt><dt><span class="sect1"><a href="tsm-system-rows.html">F.46. tsm_system_rows —
the <code class="literal">SYSTEM_ROWS</code> sampling method for <code class="literal">TABLESAMPLE</code></a></span></dt><dd><dl><dt><span class="sect2"><a href="tsm-system-rows.html#TSM-SYSTEM-ROWS-EXAMPLES">F.46.1. Examples</a></span></dt></dl></dd><dt><span class="sect1"><a href="tsm-system-time.html">F.47. tsm_system_time —
the <code class="literal">SYSTEM_TIME</code> sampling method for <code class="literal">TABLESAMPLE</code></a></span></dt><dd><dl><dt><span class="sect2"><a href="tsm-system-time.html#TSM-SYSTEM-TIME-EXAMPLES">F.47.1. Examples</a></span></dt></dl></dd><dt><span class="sect1"><a href="unaccent.html">F.48. unaccent — a text search dictionary which removes diacritics</a></span></dt><dd><dl><dt><span class="sect2"><a href="unaccent.html#UNACCENT-CONFIGURATION">F.48.1. Configuration</a></span></dt><dt><span class="sect2"><a href="unaccent.html#UNACCENT-USAGE">F.48.2. Usage</a></span></dt><dt><span class="sect2"><a href="unaccent.html#UNACCENT-FUNCTIONS">F.48.3. Functions</a></span></dt></dl></dd><dt><span class="sect1"><a href="uuid-ossp.html">F.49. uuid-ossp — a UUID generator</a></span></dt><dd><dl><dt><span class="sect2"><a href="uuid-ossp.html#UUID-OSSP-FUNCTIONS-SECT">F.49.1. <code class="literal">uuid-ossp</code> Functions</a></span></dt><dt><span class="sect2"><a href="uuid-ossp.html#UUID-OSSP-BUILDING">F.49.2. Building <code class="filename">uuid-ossp</code></a></span></dt><dt><span class="sect2"><a href="uuid-ossp.html#UUID-OSSP-AUTHOR">F.49.3. Author</a></span></dt></dl></dd><dt><span class="sect1"><a href="xml2.html">F.50. xml2 — XPath querying and XSLT functionality</a></span></dt><dd><dl><dt><span class="sect2"><a href="xml2.html#XML2-DEPRECATION">F.50.1. Deprecation Notice</a></span></dt><dt><span class="sect2"><a href="xml2.html#XML2-FUNCTIONS">F.50.2. Description of Functions</a></span></dt><dt><span class="sect2"><a href="xml2.html#XML2-XPATH-TABLE">F.50.3. <code class="literal">xpath_table</code></a></span></dt><dt><span class="sect2"><a href="xml2.html#XML2-XSLT">F.50.4. XSLT Functions</a></span></dt><dt><span class="sect2"><a href="xml2.html#XML2-AUTHOR">F.50.5. Author</a></span></dt></dl></dd></dl></div><p>
This appendix and the next one contain information on the
optional components
found in the <code class="literal">contrib</code> directory of the
<span class="productname">PostgreSQL</span> 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.
</p><p>
This appendix covers extensions and other server plug-in module
libraries found in
<code class="literal">contrib</code>. <a class="xref" href="contrib-prog.html" title="Appendix G. Additional Supplied Programs">Appendix G</a> covers utility
programs.
</p><p>
When building from the source distribution, these optional
components are not built
automatically, unless you build the "world" target
(see <a class="xref" href="install-make.html#BUILD" title="Build">Step 2</a>).
You can build and install all of them by running:
</p><pre class="screen">
<strong class="userinput"><code>make</code></strong>
<strong class="userinput"><code>make install</code></strong>
</pre><p>
in the <code class="literal">contrib</code> 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:
</p><pre class="screen">
<strong class="userinput"><code>make check</code></strong>
</pre><p>
before installation or
</p><pre class="screen">
<strong class="userinput"><code>make installcheck</code></strong>
</pre><p>
once you have a <span class="productname">PostgreSQL</span> server running.
</p><p>
If you are using a pre-packaged version of <span class="productname">PostgreSQL</span>,
these components are typically made available as a separate subpackage,
such as <code class="literal">postgresql-contrib</code>.
</p><p>
Many components supply new user-defined functions, operators, or types,
packaged as <em class="firstterm">extensions</em>.
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 <a class="xref" href="sql-createextension.html" title="CREATE EXTENSION"><span class="refentrytitle">CREATE EXTENSION</span></a> command. In a fresh database,
you can simply do
</p><pre class="programlisting">
CREATE EXTENSION <em class="replaceable"><code>extension_name</code></em>;
</pre><p>
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 <code class="literal">template1</code> so that the extension will be copied into
subsequently-created databases by default.
</p><p>
For all extensions, the <code class="command">CREATE EXTENSION</code> command must be
run by a database superuser, unless the extension is
considered <span class="quote">“<span class="quote">trusted</span>”</span>. Trusted extensions can be run by any
user who has <code class="literal">CREATE</code> 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.
</p><p id="CONTRIB-TRUSTED-EXTENSIONS">
The following extensions are trusted in a default installation:
</p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="btree-gin.html" title="F.8. btree_gin — GIN operator classes with B-tree behavior">btree_gin</a></td><td><a class="xref" href="fuzzystrmatch.html" title="F.17. fuzzystrmatch — determine string similarities and distance">fuzzystrmatch</a></td><td><a class="xref" href="ltree.html" title="F.23. ltree — hierarchical tree-like data type">ltree</a></td><td><a class="xref" href="tcn.html" title="F.44. tcn — a trigger function to notify listeners of changes to table content">tcn</a></td></tr><tr><td><a class="xref" href="btree-gist.html" title="F.9. btree_gist — GiST operator classes with B-tree behavior">btree_gist</a></td><td><a class="xref" href="hstore.html" title="F.18. hstore — hstore key/value datatype">hstore</a></td><td><a class="xref" href="pgcrypto.html" title="F.28. pgcrypto — cryptographic functions">pgcrypto</a></td><td><a class="xref" href="tsm-system-rows.html" title="F.46. tsm_system_rows — the SYSTEM_ROWS sampling method for TABLESAMPLE">tsm_system_rows</a></td></tr><tr><td><a class="xref" href="citext.html" title="F.10. citext — a case-insensitive character string type">citext</a></td><td><a class="xref" href="intarray.html" title="F.20. intarray — manipulate arrays of integers">intarray</a></td><td><a class="xref" href="pgtrgm.html" title="F.35. pg_trgm — support for similarity of text using trigram matching">pg_trgm</a></td><td><a class="xref" href="tsm-system-time.html" title="F.47. tsm_system_time — the SYSTEM_TIME sampling method for TABLESAMPLE">tsm_system_time</a></td></tr><tr><td><a class="xref" href="cube.html" title="F.11. cube — a multi-dimensional cube data type">cube</a></td><td><a class="xref" href="isn.html" title="F.21. isn — data types for international standard numbers (ISBN, EAN, UPC, etc.)">isn</a></td><td><a class="xref" href="seg.html" title="F.39. seg — a datatype for line segments or floating point intervals">seg</a></td><td><a class="xref" href="unaccent.html" title="F.48. unaccent — a text search dictionary which removes diacritics">unaccent</a></td></tr><tr><td><a class="xref" href="dict-int.html" title="F.13. dict_int — example full-text search dictionary for integers">dict_int</a></td><td><a class="xref" href="lo.html" title="F.22. lo — manage large objects">lo</a></td><td><a class="xref" href="tablefunc.html" title="F.43. tablefunc — functions that return tables (crosstab and others)">tablefunc</a></td><td><a class="xref" href="uuid-ossp.html" title="F.49. uuid-ossp — a UUID generator">uuid-ossp</a></td></tr></table><p>
</p><p>
Many extensions allow you to install their objects in a schema of your
choice. To do that, add <code class="literal">SCHEMA
<em class="replaceable"><code>schema_name</code></em></code> to the <code class="command">CREATE EXTENSION</code>
command. By default, the objects will be placed in your current creation
target schema, which in turn defaults to <code class="literal">public</code>.
</p><p>
Note, however, that some of these components are not <span class="quote">“<span class="quote">extensions</span>”</span>
in this sense, but are loaded into the server in some other way, for instance
by way of
<a class="xref" href="runtime-config-client.html#GUC-SHARED-PRELOAD-LIBRARIES">shared_preload_libraries</a>. See the documentation of each
component for details.
</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="release-prior.html" title="E.4. Prior Releases">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="appendixes.html" title="Part VIII. Appendixes">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="adminpack.html" title="F.1. adminpack — pgAdmin support toolpack">Next</a></td></tr><tr><td width="40%" align="left" valign="top">E.4. Prior Releases </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 16.2 Documentation">Home</a></td><td width="40%" align="right" valign="top"> F.1. adminpack — pgAdmin support toolpack</td></tr></table></div></body></html>
|
