Appendix F. Additional Supplied Modules

Table of Contents

F.1. adminpack
F.2. amcheck
F.2.1. Functions
F.2.2. Optional heapallindexed Verification
F.2.3. Using amcheck Effectively
F.2.4. Repairing Corruption
F.3. auth_delay
F.3.1. Configuration Parameters
F.3.2. Author
F.4. auto_explain
F.4.1. Configuration Parameters
F.4.2. Example
F.4.3. Author
F.5. bloom
F.5.1. Parameters
F.5.2. Examples
F.5.3. Operator Class Interface
F.5.4. Limitations
F.5.5. Authors
F.6. btree_gin
F.6.1. Example Usage
F.6.2. Authors
F.7. btree_gist
F.7.1. Example Usage
F.7.2. Authors
F.8. canopy
F.9. citext
F.9.1. Rationale
F.9.2. How to Use It
F.9.3. String Comparison Behavior
F.9.4. Limitations
F.9.5. Author
F.10. cube
F.10.1. Syntax
F.10.2. Precision
F.10.3. Usage
F.10.4. Defaults
F.10.5. Notes
F.10.6. Credits
F.11. dblink
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
F.12.1. Configuration
F.12.2. Usage
F.13. dict_xsyn
F.13.1. Configuration
F.13.2. Usage
F.14. earthdistance
F.14.1. Cube-Based Earth Distances
F.14.2. Point-Based Earth Distances
F.15. file_fdw
F.16. fuzzystrmatch
F.16.1. Soundex
F.16.2. Levenshtein
F.16.3. Metaphone
F.16.4. Double Metaphone
F.17. hstore
F.17.1. hstore External Representation
F.17.2. hstore Operators and Functions
F.17.3. Indexes
F.17.4. Examples
F.17.5. Statistics
F.17.6. Compatibility
F.17.7. Transforms
F.17.8. Authors
F.18. intagg
F.18.1. Functions
F.18.2. Sample Uses
F.19. intarray
F.19.1. intarray Functions and Operators
F.19.2. Index Support
F.19.3. Example
F.19.4. Benchmark
F.19.5. Authors
F.20. isn
F.20.1. Data Types
F.20.2. Casts
F.20.3. Functions and Operators
F.20.4. Examples
F.20.5. Bibliography
F.20.6. Author
F.21. lo
F.21.1. Rationale
F.21.2. How to Use It
F.21.3. Limitations
F.21.4. Author
F.22. lt_buffercache
F.22.1. The pg_buffercache View
F.22.2. Sample Output
F.22.3. Authors
F.23. lt_bulkload
F.23.1. Synopsis
F.23.2. Description
F.23.3. Usage
F.23.4. Options
F.23.5. Control Files
F.23.6. Restrictions
F.23.7. Details
F.24. lt_cheat_funcs
F.24.1. Functions
F.24.2. Encoding Conversions
F.24.3. Configuration Parameters
F.25. ltcluster
F.26. lt_cron
F.26.1. What is lt_cron?
F.27. lt_freespacemap
F.27.1. Functions
F.27.2. Sample Output
F.27.3. Author
F.28. lt_hint_plan
F.28.1. Name
F.28.2. Synopsis
F.28.3. Description
F.28.4. The hint table
F.28.5. Details in hinting
F.28.6. Subqueries
F.28.7. Compatible with canopy
F.28.8. Errors
F.28.9. Functional limitations
F.28.10. Hint list
F.29. lt_log_long_xact
F.29.1. Usage
F.30. lt_ope
F.30.1. What is lt_ope?
F.30.2. function usage
F.31. lt_pathman
F.31.1. Overview
F.31.2. Feature highlights
F.31.3. Available functions
F.31.4. Views and tables
F.31.5. Declarative partitioning
F.31.6. Custom plan nodes
F.31.7. Examples
F.32. lt_prewarm
F.32.1. Functions
F.32.2. Configuration Parameters
F.32.3. Author
F.33. lt_probackup
F.33.1. Limitations
F.34. lt_proctab
F.34.1. functions
F.35. lt_profile
F.35.1. Concepts
F.35.2. Extension architecture
F.35.3. Prerequisites
F.35.4. Creating Extensions
F.35.5. Privileges
F.35.6. Using lt_profile
F.35.7. Sections of PWR report
F.35.8. Sections of PSH report
F.36. lt_qualstats
F.36.1. Configuration
F.36.2. Updating the extension
F.36.3. Usage
F.37. lt_show_plans
F.37.1. Configuration Parameters
F.37.2. Usage
F.37.3. Functions
F.38. lt_sm
F.38.1. What is lt_sm?
F.38.2. function usage
F.38.3. key management
F.39. lt_standby_forward
F.39.1. Configuration Parameters
F.39.2. Usage
F.39.3. Authentication
F.39.4. Features/Limitations
F.40. lt_stat_activity
F.40.1. Concepts
F.40.2. Prerequisites
F.40.3. Creating Extensions
F.41. lt_statement_rollback
F.41.1. Concepts
F.41.2. Prerequisites
F.41.3. Creating Extensions
F.41.4. Examples
F.42. lt_stat_statements
F.42.1. The pg_stat_statements View
F.42.2. Functions
F.42.3. Configuration Parameters
F.42.4. Sample Output
F.42.5. Authors
F.43. lt_tempfile
F.44. lt_trgm
F.44.1. Trigram (or Trigraph) Concepts
F.44.2. Functions and Operators
F.44.3. GUC Parameters
F.44.4. Index Support
F.44.5. Text Search Integration
F.44.6. References
F.44.7. Authors
F.45. lt_visibility
F.45.1. Functions
F.45.2. Author
F.46. ltaudit
F.46.1. Introduction
F.46.2. Why ltaudit?
F.46.3. Usage Considerations
F.46.4. Settings
F.46.5. Session Audit Logging
F.46.6. Object Audit Logging
F.46.7. Format
F.46.8. Caveats
F.47. ltcrypto
F.47.1. General Hashing Functions
F.47.2. Password Hashing Functions
F.47.3. PGP Encryption Functions
F.47.4. Raw Encryption Functions
F.47.5. Random-Data Functions
F.47.6. Notes
F.47.7. Author
F.48. ltfincore
F.48.1. DESCRIPTION
F.48.2. EXAMPLES
F.48.3. SYNOPSIS
F.48.4. DOCUMENTATION
F.48.5. DEBUG
F.48.6. REQUIREMENTS
F.48.7. LIMITATIONS
F.49. ltree
F.49.1. Definitions
F.49.2. Operators and Functions
F.49.3. Indexes
F.49.4. Example
F.49.5. Authors
F.50. ltrowlocks
F.50.1. Overview
F.50.2. Sample Output
F.50.3. Author
F.51. ltstattuple
F.51.1. Functions
F.51.2. Authors
F.52. myfce
F.52.1. Features Compatible with Mysql Databases
F.52.2. SQL Functions Reference
F.53. mysql_fdw
F.53.1. Installation
F.53.2. Enhancements
F.53.3. Usage
F.53.4. Examples
F.54. oracle_fdw
F.54.1. Cookbook
F.54.2. Objects created by the extension
F.54.3. Options
F.54.4. Usage
F.54.5. Internals
F.54.6. Problems
F.55. orafce
F.55.1. Features Compatible with Oracle Databases
F.55.2. Notes on Using orafce
F.55.3. Data Types
F.55.4. Queries
F.55.5. SQL Functions Reference
F.55.6. Package Reference
F.55.7. Transaction behavior
F.55.8. System View Reference
F.56. pageinspect
F.56.1. General Functions
F.56.2. Heap Functions
F.56.3. B-Tree Functions
F.56.4. BRIN Functions
F.56.5. GIN Functions
F.56.6. Hash Functions
F.57. passwordcheck
F.58. postgres_fdw
F.58.1. FDW Options of postgres_fdw
F.58.2. Connection Management
F.58.3. Transaction Management
F.58.4. Remote Query Optimization
F.58.5. Remote Query Execution Environment
F.58.6. Cross-Version Compatibility
F.58.7. Examples
F.58.8. Author
F.59. rum
F.59.1. Introduction
F.59.2. Common operators and functions
F.59.3. Operator classes
F.60. seg
F.60.1. Rationale
F.60.2. Syntax
F.60.3. Precision
F.60.4. Usage
F.60.5. Notes
F.60.6. Credits
F.61. sepgsql
F.61.1. Overview
F.61.2. Installation
F.61.3. Regression Tests
F.61.4. GUC Parameters
F.61.5. Features
F.61.6. Sepgsql Functions
F.61.7. Limitations
F.61.8. External Resources
F.61.9. Author
F.62. spi
F.62.1. refint — Functions for Implementing Referential Integrity
F.62.2. autoinc — Functions for Autoincrementing Fields
F.62.3. insert_username — Functions for Tracking Who Changed a Table
F.62.4. moddatetime — Functions for Tracking Last Modification Time
F.63. sslinfo
F.63.1. Functions Provided
F.63.2. Author
F.64. system_stats
F.64.1. Security
F.64.2. Functions
F.64.3. Detailed output of each functions
F.65. tablefunc
F.65.1. Functions Provided
F.65.2. Author
F.66. tcn
F.67. test_decoding
F.68. tsm_system_rows
F.68.1. Examples
F.69. tsm_system_time
F.69.1. Examples
F.70. tsvector2
F.70.1. tsvector2 specific functions
F.70.2. Common functions that could be safely used on both types
F.71. unaccent
F.71.1. Configuration
F.71.2. Usage
F.71.3. Functions
F.72. uuid-ossp
F.72.1. uuid-ossp Functions
F.72.2. Building uuid-ossp
F.72.3. Author
F.73. wal2sql
F.73.1. Configuration
F.73.2. Configuration Parameters
F.73.3. Examples of Parameters
F.73.4. Note
F.74. xml2
F.74.1. Deprecation Notice
F.74.2. Description of Functions
F.74.3. xpath_table
F.74.4. XSLT Functions
F.74.5. Author
F.75. zhparser
F.75.1. CONFIGURATION
F.75.2. EXAMPLE
F.75.3. Custom dictionary
F.75.4. Custom dictionary 2.1

This appendix and the next one contain information regarding the modules that can be found in the contrib directory of the LightDB distribution. These include porting tools, analysis utilities, and plug-in features that are not part of the core LightDB system, 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 contrib. Appendix G covers utility programs.

If you are using a pre-packaged version of LightDB, these modules are typically made available as a separate subpackage, such as lightdb-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 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 module_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 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 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 provide access to outside-the-database functionality.

Many modules 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 modules 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 module for details.