Search PostgreSQL documentation
PG 18 · Browse by category, or enter a name or keyword
Popular entries9981
OpenSSL Support Functionsfips_mode() returns boolean
Returns true if OpenSSL is running with FIPS mode enabled, otherwise false.
opentdeOpen Transparent Data Encryption for PostgreSQL.
opentde
Security
Operator Class InterfaceAn operator class for bloom indexes requires only a hash function for the indexed data type and an equality operator for searching. This example shows the operator class definition for the t…
Operator Class ParametersSome of the built-in operator classes allow specifying parameters affecting behavior of the operator class. Each operator class has its own set of allowed parameters. Only the bloom and minm…
Operator Classes and Operator FamiliesAn index definition can specify an operator class for each column of an index.
CREATE INDEX name ON table (column opclass [ ( opclass_options ) ] [sort options] [, ...]);
The operator class …
Operator Classes and Operator FamiliesSo far we have implicitly assumed that an operator class deals with only one data type. While there certainly can be only one data type in a particular index column, it is often useful to in…
Operator InvocationsThere are two possible syntaxes for an operator invocation:
expression operator expression (binary infix operator) operator expression (unary prefix operator)
where the operator token follow…
Operator Optimization InformationA PostgreSQL operator definition can include several optional clauses that tell the system useful things about how the operator behaves. These clauses should be provided whenever appropriate…
Operator PrecedenceTable 4.2 shows the precedence and associativity of the operators in PostgreSQL. Most operators have the same precedence and are left-associative. The precedence and associativity of the ope…
OperatorsAn operator name is a sequence of up to NAMEDATALEN-1 (63 by default) characters from the following list:
+ - * / < > = ~ ! @ # % ^ & | ` ?
There are a few restrictions on operator names, ho…
OperatorsThe specific operator that is referenced by an operator expression is determined using the following procedure. Note that this procedure is indirectly affected by the precedence of the opera…
Operators and FunctionsType ltree has the usual comparison operators =, <>, <, >, <=, >=. Comparison sorts in the order of a tree traversal, with the children of a node sorted by label text. In addition, the speci…
opm_coreCentral module of the OPM suite
opm_core
Monitoring
optimExperimental pgrx extension defining optimization-direction and hyperparameter trial types.
pgrx
optim
Data types
OptimizationLLVM has support for optimizing generated code. Some of the optimizations are cheap enough to be performed whenever JIT is used, while others are only beneficial for longer-running queries. …
optimized_row_formatExperimental table access method for compact, cache-friendly row storage.
table-am storage row-format compression
optimized_row_format
Analytics
OptimizerAutomatically remove some unnecessary table self-joins (Andrey Lepikhov, Alexander Kuzmenkov, Alexander Korotkov, Alena Rybakina) § This optimization can be disabled using server variable en…
Optimizing PL/pgSQL FunctionsPostgreSQL gives you two function creation modifiers to optimize execution: “volatility” (whether the function always returns the same result when given the same arguments) and “strictness” …
Optional heapallindexed VerificationWhen the heapallindexed argument to B-Tree verification functions is true, an additional phase of verification is performed against the table associated with the target index relation. This …
Optionsclusterdb accepts the following command-line arguments:
-a--all Cluster all databases. [-d] dbname[--dbname=]dbname Specifies the name of the database to be clustered, when -a/--all is not u…
Optionscreatedb accepts the following command-line arguments:
dbname Specifies the name of the database to be created. The name must be unique among all PostgreSQL databases in this cluster. The de…
Optionscreateuser accepts the following command-line arguments:
username Specifies the name of the PostgreSQL user to be created. This name must be different from all existing roles in this Postgre…
Optionsdropdb accepts the following command-line arguments:
dbname Specifies the name of the database to be removed. -e--echo Echo the commands that dropdb generates and sends to the server. -f--fo…
Optionsdropuser accepts the following command-line arguments:
username Specifies the name of the PostgreSQL user to be removed. You will be prompted for a name if none is specified on the command l…
Optionsecpg accepts the following command-line arguments:
-c Automatically generate certain C code from SQL code. Currently, this works for EXEC SQL TYPE. -C mode Set a compatibility mode. mode can…
OptionsA authmethod--auth=authmethod # This option specifies the default authentication method for local users used in pg_hba.conf (host and local lines). See Section 20.1 for an overview of valid …
Optionsc--core-files Attempt to allow server crashes to produce core files, on platforms where this is possible, by lifting any soft resource limit placed on core files. This is useful in debugging…
OptionsThe following command-line options control the content and format of the output.
-a--data-only
Dump only the data, not the schema (data definitions) or statistics.
-c--clean
Emit SQL command…
Optionsd dbname--dbname=dbname Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command lin…
OptionsThe following command-line options control what is checked:
-a--all Check all databases, except for any excluded via --exclude-database. -d pattern--database=pattern Check databases matching…
OptionsThe following command-line options control the location and format of the output:
-D directory--pgdata=directory
Sets the target directory to write the output to. pg_basebackup will create t…
OptionsThe following command-line options are available:
-D directory--pgdata=directory Specifies the directory where the database cluster is stored. -c--check Checks checksums. This is the default…
Optionsd--debug Print lots of debug logging output on stderr. -k--link Use hard links instead of copying files to the synthetic backup. Reconstruction of the synthetic backup might be faster (no fi…
OptionsTo use pg_config, supply one or more of the following options:
--bindir Print the location of user executables. Use this, for example, to find the psql program. This is normally also the loc…
Optionspg_createsubscriber accepts the following command-line arguments:
-a--all Create one subscription per database on the target server. Exceptions are template databases and databases that don'…
OptionsThe following command-line options control the content and format of the output.
dbname
Specifies the name of the database to be dumped. If this is not specified, the environment variable PG…
OptionsD directory--directory=directory Directory to write the output to. This parameter is required. -E lsn--endpos=lsn Automatically stop replication and exit with normal exit status 0 when recei…
OptionsAt least one of the following options must be specified to select an action:
--create-slot Create a new logical replication slot with the name specified by --slot, using the output plugin sp…
Optionsdatadir-D datadir--pgdata=datadir Specifies the location of the database directory. For safety reasons, you must specify the data directory on the command line. pg_resetwal does not use the …
Optionspg_restore accepts the following command line arguments.
filename
Specifies the location of the archive file (or directory, for a directory-format archive) to be restored. If not specified, …
More results
Find definitions in the PostgreSQL manuals, reference library, and extension catalogue.
Searching every version by default. Manual pages are indexed for PostgreSQL 10–20; the reference library and extension catalogue are not version-bound.
all: every version pg17: one version ex: extensions only ↑↓ select ↵ open