begriffs open source - ai-pg/blob - full-docs/txt/reference.txt

   1
   2 Part VI. Reference
   3
   4    The entries in this Reference are meant to provide in reasonable length
   5    an authoritative, complete, and formal summary about their respective
   6    subjects. More information about the use of PostgreSQL, in narrative,
   7    tutorial, or example form, can be found in other parts of this book.
   8    See the cross-references listed on each reference page.
   9
  10    The reference entries are also available as traditional “man” pages.
  11
  12    Table of Contents
  13
  14    I. SQL Commands
  15
  16         ABORT — abort the current transaction
  17         ALTER AGGREGATE — change the definition of an aggregate function
  18         ALTER COLLATION — change the definition of a collation
  19         ALTER CONVERSION — change the definition of a conversion
  20         ALTER DATABASE — change a database
  21         ALTER DEFAULT PRIVILEGES — define default access privileges
  22         ALTER DOMAIN — change the definition of a domain
  23         ALTER EVENT TRIGGER — change the definition of an event trigger
  24         ALTER EXTENSION — change the definition of an extension
  25         ALTER FOREIGN DATA WRAPPER — change the definition of a
  26                 foreign-data wrapper
  27
  28         ALTER FOREIGN TABLE — change the definition of a foreign table
  29         ALTER FUNCTION — change the definition of a function
  30         ALTER GROUP — change role name or membership
  31         ALTER INDEX — change the definition of an index
  32         ALTER LANGUAGE — change the definition of a procedural language
  33         ALTER LARGE OBJECT — change the definition of a large object
  34         ALTER MATERIALIZED VIEW — change the definition of a materialized
  35                 view
  36
  37         ALTER OPERATOR — change the definition of an operator
  38         ALTER OPERATOR CLASS — change the definition of an operator class
  39         ALTER OPERATOR FAMILY — change the definition of an operator
  40                 family
  41
  42         ALTER POLICY — change the definition of a row-level security
  43                 policy
  44
  45         ALTER PROCEDURE — change the definition of a procedure
  46         ALTER PUBLICATION — change the definition of a publication
  47         ALTER ROLE — change a database role
  48         ALTER ROUTINE — change the definition of a routine
  49         ALTER RULE — change the definition of a rule
  50         ALTER SCHEMA — change the definition of a schema
  51         ALTER SEQUENCE — change the definition of a sequence generator
  52         ALTER SERVER — change the definition of a foreign server
  53         ALTER STATISTICS — change the definition of an extended statistics
  54                 object
  55
  56         ALTER SUBSCRIPTION — change the definition of a subscription
  57         ALTER SYSTEM — change a server configuration parameter
  58         ALTER TABLE — change the definition of a table
  59         ALTER TABLESPACE — change the definition of a tablespace
  60         ALTER TEXT SEARCH CONFIGURATION — change the definition of a text
  61                 search configuration
  62
  63         ALTER TEXT SEARCH DICTIONARY — change the definition of a text
  64                 search dictionary
  65
  66         ALTER TEXT SEARCH PARSER — change the definition of a text search
  67                 parser
  68
  69         ALTER TEXT SEARCH TEMPLATE — change the definition of a text
  70                 search template
  71
  72         ALTER TRIGGER — change the definition of a trigger
  73         ALTER TYPE — change the definition of a type
  74         ALTER USER — change a database role
  75         ALTER USER MAPPING — change the definition of a user mapping
  76         ALTER VIEW — change the definition of a view
  77         ANALYZE — collect statistics about a database
  78         BEGIN — start a transaction block
  79         CALL — invoke a procedure
  80         CHECKPOINT — force a write-ahead log checkpoint
  81         CLOSE — close a cursor
  82         CLUSTER — cluster a table according to an index
  83         COMMENT — define or change the comment of an object
  84         COMMIT — commit the current transaction
  85         COMMIT PREPARED — commit a transaction that was earlier prepared
  86                 for two-phase commit
  87
  88         COPY — copy data between a file and a table
  89         CREATE ACCESS METHOD — define a new access method
  90         CREATE AGGREGATE — define a new aggregate function
  91         CREATE CAST — define a new cast
  92         CREATE COLLATION — define a new collation
  93         CREATE CONVERSION — define a new encoding conversion
  94         CREATE DATABASE — create a new database
  95         CREATE DOMAIN — define a new domain
  96         CREATE EVENT TRIGGER — define a new event trigger
  97         CREATE EXTENSION — install an extension
  98         CREATE FOREIGN DATA WRAPPER — define a new foreign-data wrapper
  99         CREATE FOREIGN TABLE — define a new foreign table
 100         CREATE FUNCTION — define a new function
 101         CREATE GROUP — define a new database role
 102         CREATE INDEX — define a new index
 103         CREATE LANGUAGE — define a new procedural language
 104         CREATE MATERIALIZED VIEW — define a new materialized view
 105         CREATE OPERATOR — define a new operator
 106         CREATE OPERATOR CLASS — define a new operator class
 107         CREATE OPERATOR FAMILY — define a new operator family
 108         CREATE POLICY — define a new row-level security policy for a table
 109         CREATE PROCEDURE — define a new procedure
 110         CREATE PUBLICATION — define a new publication
 111         CREATE ROLE — define a new database role
 112         CREATE RULE — define a new rewrite rule
 113         CREATE SCHEMA — define a new schema
 114         CREATE SEQUENCE — define a new sequence generator
 115         CREATE SERVER — define a new foreign server
 116         CREATE STATISTICS — define extended statistics
 117         CREATE SUBSCRIPTION — define a new subscription
 118         CREATE TABLE — define a new table
 119         CREATE TABLE AS — define a new table from the results of a query
 120         CREATE TABLESPACE — define a new tablespace
 121         CREATE TEXT SEARCH CONFIGURATION — define a new text search
 122                 configuration
 123
 124         CREATE TEXT SEARCH DICTIONARY — define a new text search
 125                 dictionary
 126
 127         CREATE TEXT SEARCH PARSER — define a new text search parser
 128         CREATE TEXT SEARCH TEMPLATE — define a new text search template
 129         CREATE TRANSFORM — define a new transform
 130         CREATE TRIGGER — define a new trigger
 131         CREATE TYPE — define a new data type
 132         CREATE USER — define a new database role
 133         CREATE USER MAPPING — define a new mapping of a user to a foreign
 134                 server
 135
 136         CREATE VIEW — define a new view
 137         DEALLOCATE — deallocate a prepared statement
 138         DECLARE — define a cursor
 139         DELETE — delete rows of a table
 140         DISCARD — discard session state
 141         DO — execute an anonymous code block
 142         DROP ACCESS METHOD — remove an access method
 143         DROP AGGREGATE — remove an aggregate function
 144         DROP CAST — remove a cast
 145         DROP COLLATION — remove a collation
 146         DROP CONVERSION — remove a conversion
 147         DROP DATABASE — remove a database
 148         DROP DOMAIN — remove a domain
 149         DROP EVENT TRIGGER — remove an event trigger
 150         DROP EXTENSION — remove an extension
 151         DROP FOREIGN DATA WRAPPER — remove a foreign-data wrapper
 152         DROP FOREIGN TABLE — remove a foreign table
 153         DROP FUNCTION — remove a function
 154         DROP GROUP — remove a database role
 155         DROP INDEX — remove an index
 156         DROP LANGUAGE — remove a procedural language
 157         DROP MATERIALIZED VIEW — remove a materialized view
 158         DROP OPERATOR — remove an operator
 159         DROP OPERATOR CLASS — remove an operator class
 160         DROP OPERATOR FAMILY — remove an operator family
 161         DROP OWNED — remove database objects owned by a database role
 162         DROP POLICY — remove a row-level security policy from a table
 163         DROP PROCEDURE — remove a procedure
 164         DROP PUBLICATION — remove a publication
 165         DROP ROLE — remove a database role
 166         DROP ROUTINE — remove a routine
 167         DROP RULE — remove a rewrite rule
 168         DROP SCHEMA — remove a schema
 169         DROP SEQUENCE — remove a sequence
 170         DROP SERVER — remove a foreign server descriptor
 171         DROP STATISTICS — remove extended statistics
 172         DROP SUBSCRIPTION — remove a subscription
 173         DROP TABLE — remove a table
 174         DROP TABLESPACE — remove a tablespace
 175         DROP TEXT SEARCH CONFIGURATION — remove a text search
 176                 configuration
 177
 178         DROP TEXT SEARCH DICTIONARY — remove a text search dictionary
 179         DROP TEXT SEARCH PARSER — remove a text search parser
 180         DROP TEXT SEARCH TEMPLATE — remove a text search template
 181         DROP TRANSFORM — remove a transform
 182         DROP TRIGGER — remove a trigger
 183         DROP TYPE — remove a data type
 184         DROP USER — remove a database role
 185         DROP USER MAPPING — remove a user mapping for a foreign server
 186         DROP VIEW — remove a view
 187         END — commit the current transaction
 188         EXECUTE — execute a prepared statement
 189         EXPLAIN — show the execution plan of a statement
 190         FETCH — retrieve rows from a query using a cursor
 191         GRANT — define access privileges
 192         IMPORT FOREIGN SCHEMA — import table definitions from a foreign
 193                 server
 194
 195         INSERT — create new rows in a table
 196         LISTEN — listen for a notification
 197         LOAD — load a shared library file
 198         LOCK — lock a table
 199         MERGE — conditionally insert, update, or delete rows of a table
 200         MOVE — position a cursor
 201         NOTIFY — generate a notification
 202         PREPARE — prepare a statement for execution
 203         PREPARE TRANSACTION — prepare the current transaction for
 204                 two-phase commit
 205
 206         REASSIGN OWNED — change the ownership of database objects owned by
 207                 a database role
 208
 209         REFRESH MATERIALIZED VIEW — replace the contents of a materialized
 210                 view
 211
 212         REINDEX — rebuild indexes
 213         RELEASE SAVEPOINT — release a previously defined savepoint
 214         RESET — restore the value of a run-time parameter to the default
 215                 value
 216
 217         REVOKE — remove access privileges
 218         ROLLBACK — abort the current transaction
 219         ROLLBACK PREPARED — cancel a transaction that was earlier prepared
 220                 for two-phase commit
 221
 222         ROLLBACK TO SAVEPOINT — roll back to a savepoint
 223         SAVEPOINT — define a new savepoint within the current transaction
 224         SECURITY LABEL — define or change a security label applied to an
 225                 object
 226
 227         SELECT — retrieve rows from a table or view
 228         SELECT INTO — define a new table from the results of a query
 229         SET — change a run-time parameter
 230         SET CONSTRAINTS — set constraint check timing for the current
 231                 transaction
 232
 233         SET ROLE — set the current user identifier of the current session
 234         SET SESSION AUTHORIZATION — set the session user identifier and
 235                 the current user identifier of the current session
 236
 237         SET TRANSACTION — set the characteristics of the current
 238                 transaction
 239
 240         SHOW — show the value of a run-time parameter
 241         START TRANSACTION — start a transaction block
 242         TRUNCATE — empty a table or set of tables
 243         UNLISTEN — stop listening for a notification
 244         UPDATE — update rows of a table
 245         VACUUM — garbage-collect and optionally analyze a database
 246         VALUES — compute a set of rows
 247
 248    II. PostgreSQL Client Applications
 249
 250         clusterdb — cluster a PostgreSQL database
 251         createdb — create a new PostgreSQL database
 252         createuser — define a new PostgreSQL user account
 253         dropdb — remove a PostgreSQL database
 254         dropuser — remove a PostgreSQL user account
 255         ecpg — embedded SQL C preprocessor
 256         pg_amcheck — checks for corruption in one or more PostgreSQL
 257                 databases
 258
 259         pg_basebackup — take a base backup of a PostgreSQL cluster
 260         pgbench — run a benchmark test on PostgreSQL
 261         pg_combinebackup — reconstruct a full backup from an incremental
 262                 backup and dependent backups
 263
 264         pg_config — retrieve information about the installed version of
 265                 PostgreSQL
 266
 267         pg_dump — export a PostgreSQL database as an SQL script or to
 268                 other formats
 269
 270         pg_dumpall — extract a PostgreSQL database cluster into a script
 271                 file
 272
 273         pg_isready — check the connection status of a PostgreSQL server
 274         pg_receivewal — stream write-ahead logs from a PostgreSQL server
 275         pg_recvlogical — control PostgreSQL logical decoding streams
 276         pg_restore — restore a PostgreSQL database from an archive file
 277                 created by pg_dump
 278
 279         pg_verifybackup — verify the integrity of a base backup of a
 280                 PostgreSQL cluster
 281
 282         psql — PostgreSQL interactive terminal
 283         reindexdb — reindex a PostgreSQL database
 284         vacuumdb — garbage-collect and analyze a PostgreSQL database
 285
 286    III. PostgreSQL Server Applications
 287
 288         initdb — create a new PostgreSQL database cluster
 289         pg_archivecleanup — clean up PostgreSQL WAL archive files
 290         pg_checksums — enable, disable or check data checksums in a
 291                 PostgreSQL database cluster
 292
 293         pg_controldata — display control information of a PostgreSQL
 294                 database cluster
 295
 296         pg_createsubscriber — convert a physical replica into a new
 297                 logical replica
 298
 299         pg_ctl — initialize, start, stop, or control a PostgreSQL server
 300         pg_resetwal — reset the write-ahead log and other control
 301                 information of a PostgreSQL database cluster
 302
 303         pg_rewind — synchronize a PostgreSQL data directory with another
 304                 data directory that was forked from it
 305
 306         pg_test_fsync — determine fastest wal_sync_method for PostgreSQL
 307         pg_test_timing — measure timing overhead
 308         pg_upgrade — upgrade a PostgreSQL server instance
 309         pg_waldump — display a human-readable rendering of the write-ahead
 310                 log of a PostgreSQL database cluster
 311
 312         pg_walsummary — print contents of WAL summary files
 313         postgres — PostgreSQL database server