Search PostgreSQL documentation
PG 18 · Browse by category, or enter a name or keyword
Category index4025
pg_class52.11. pg_class
The catalog pg_class describes tables and other objects that have columns or are otherwise similar to a table. This includes indexes (but see also pg_index), sequences (but s…pg_class
pg_collation52.12. pg_collation
The catalog pg_collation describes the available collations, which are essentially mappings from an SQL name to operating system locale categories. See Section 23.2 for m…pg_collation
pg_combinebackuppg_combinebackup pg_combinebackup — reconstruct a full backup from an incremental backup and dependent backups
Synopsis pg_combinebackup [option...] [backup_directory...]pg_combinebackup
pg_configpg_config pg_config — retrieve information about the installed version of PostgreSQL
Synopsis pg_config [option...]pg_config
pg_config53.6. pg_config
The view pg_config describes the compile-time configuration parameters of the currently installed version of PostgreSQL. It is intended, for example, to be used by software p…pg_config
pg_constraint52.13. pg_constraint
The catalog pg_constraint stores check, not-null, primary key, unique, foreign key, and exclusion constraints on tables. (Column constraints are not treated specially. E…pg_constraint
pg_controldatapg_controldata pg_controldata — display control information of a PostgreSQL database cluster
Synopsis pg_controldata [option] [[ -D | --pgdata ]datadir]pg_controldata
pg_conversion52.14. pg_conversion
The catalog pg_conversion describes encoding conversion functions. See CREATE CONVERSION for more information.
Table 52.14. pg_conversion Columns Column Type Description…pg_conversion
pg_createsubscriberpg_createsubscriber pg_createsubscriber — convert a physical replica into a new logical replica
Synopsis pg_createsubscriber [option...] { -d | --database }dbname { -D | --pgdata }datadir { …pg_createsubscriber
pg_ctlpg_ctl pg_ctl — initialize, start, stop, or control a PostgreSQL server
Synopsis pg_ctl init[db] [-D datadir] [-s] [-o initdb-options] pg_ctl start [-D datadir] [-l filename] [-W] [-t second…pg_ctl
pg_cursors53.7. pg_cursors
The pg_cursors view lists the cursors that are currently available. Cursors can be defined in several ways:
via the DECLARE statement in SQL via the Bind message in the fron…pg_cursors
pg_database52.15. pg_database
The catalog pg_database stores information about the available databases. Databases are created with the CREATE DATABASE command. Consult Chapter 22 for details about the …pg_database
pg_db_role_setting52.16. pg_db_role_setting
The catalog pg_db_role_setting records the default values that have been set for run-time configuration variables, for each role and database combination.
Unlike mo…pg_db_role_setting
pg_default_acl52.17. pg_default_acl
The catalog pg_default_acl stores initial privileges to be assigned to newly created objects.
Table 52.17. pg_default_acl Columns Column Type Description oid oid Row id…pg_default_acl
pg_depend52.18. pg_depend
The catalog pg_depend records the dependency relationships between database objects. This information allows DROP commands to find which other objects must be dropped by DRO…pg_depend
pg_description52.19. pg_description
The catalog pg_description stores optional descriptions (comments) for each database object. Descriptions can be manipulated with the COMMENT command and viewed with ps…pg_description
pg_dumppg_dump pg_dump — export a PostgreSQL database as an SQL script or to other formats
Synopsis pg_dump [connection-option...] [option...] [dbname]pg_dump
pg_dump/pg_dumpall/pg_restoreE.6.3.7.1. pg_dump/pg_dumpall/pg_restore
Add pg_dump option --statistics (Jeff Davis) § § Add pg_dump and pg_dumpall option --sequence-data to dump sequence data that would normally be exclu…pg_dump/pg_dumpall/pg_restore
pg_dumpallpg_dumpall pg_dumpall — extract a PostgreSQL database cluster into a script file
Synopsis pg_dumpall [connection-option...] [option...]pg_dumpall
pg_enum52.20. pg_enum
The pg_enum catalog contains entries showing the values and labels for each enum type. The internal representation of a given enum value is actually the OID of its associated …pg_enum
pg_event_trigger52.21. pg_event_trigger
The catalog pg_event_trigger stores event triggers. See Chapter 38 for more information.
Table 52.21. pg_event_trigger Columns Column Type Description oid oid Row ide…pg_event_trigger
pg_extension52.22. pg_extension
The catalog pg_extension stores information about the installed extensions. See Section 36.17 for details about extensions.
Table 52.22. pg_extension Columns Column Type …pg_extension
pg_file_settings53.8. pg_file_settings
The view pg_file_settings provides a summary of the contents of the server's configuration file(s). A row appears in this view for each “name = value” entry appearing …pg_file_settings
pg_foreign_data_wrapper52.23. pg_foreign_data_wrapper
The catalog pg_foreign_data_wrapper stores foreign-data wrapper definitions. A foreign-data wrapper is the mechanism by which external data, residing on foreig…pg_foreign_data_wrapper
pg_foreign_server52.24. pg_foreign_server
The catalog pg_foreign_server stores foreign server definitions. A foreign server describes a source of external data, such as a remote server. Foreign servers are a…pg_foreign_server
pg_foreign_table52.25. pg_foreign_table
The catalog pg_foreign_table contains auxiliary information about foreign tables. A foreign table is primarily represented by a pg_class entry, just like a regular ta…pg_foreign_table
pg_freespacemap — examine the free space mapF.27. pg_freespacemap — examine the free space map
The pg_freespacemap module provides a means for examining the free space map (FSM). It provides a function called pg_freespace, or two over…pg_freespacemap — examine the free space map
pg_group53.9. pg_group
The view pg_group exists for backwards compatibility: it emulates a catalog that existed in PostgreSQL before version 8.1. It shows the names and members of all roles that are…pg_group
pg_hba_file_rules53.10. pg_hba_file_rules
The view pg_hba_file_rules provides a summary of the contents of the client authentication configuration file, pg_hba.conf. A row appears in this view for each non-e…pg_hba_file_rules
pg_ident_file_mappings53.11. pg_ident_file_mappings
The view pg_ident_file_mappings provides a summary of the contents of the client user name mapping configuration file, pg_ident.conf. A row appears in this view…pg_ident_file_mappings
pg_index52.26. pg_index
The catalog pg_index contains part of the information about indexes. The rest is mostly in pg_class.
Table 52.26. pg_index Columns Column Type Description indexrelid oid (ref…pg_index
pg_indexes53.12. pg_indexes
The view pg_indexes provides access to useful information about each index in the database.
Table 53.12. pg_indexes Columns Column Type Description schemaname name (referen…pg_indexes
pg_inherits52.27. pg_inherits
The catalog pg_inherits records information about table and index inheritance hierarchies. There is one entry for each direct parent-child table or index relationship in t…pg_inherits
pg_init_privs52.28. pg_init_privs
The catalog pg_init_privs records information about the initial privileges of objects in the system. There is one entry for each object in the database which has a non-d…pg_init_privs
pg_isreadypg_isready pg_isready — check the connection status of a PostgreSQL server
Synopsis pg_isready [connection-option...] [option...]pg_isready
pg_language52.29. pg_language
The catalog pg_language registers languages in which you can write functions or stored procedures. See CREATE LANGUAGE and Chapter 40 for more information about language h…pg_language
pg_largeobject52.30. pg_largeobject
The catalog pg_largeobject holds the data making up “large objects”. A large object is identified by an OID assigned when it is created. Each large object is broken int…pg_largeobject
pg_largeobject_metadata52.31. pg_largeobject_metadata
The catalog pg_largeobject_metadata holds metadata associated with large objects. The actual large object data is stored in pg_largeobject.
Table 52.31. pg_lar…pg_largeobject_metadata
pg_locks53.13. pg_locks
The view pg_locks provides access to information about the locks held by active processes within the database server. See Chapter 13 for more discussion of locking.
pg_locks …pg_locks
pg_logicalinspect — logical decoding components inspectionF.28. pg_logicalinspect — logical decoding components inspection
The pg_logicalinspect module provides SQL functions that allow you to inspect the contents of logical decoding components. It…pg_logicalinspect — logical decoding components inspection
More results
Find definitions in the PostgreSQL manuals, reference library, and extension catalogue.
pg17: choose a version ex: extensions only ↑↓ select ↵ open