diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile
index 164c00bb63b..428eb569fc4 100644
--- a/doc/src/sgml/Makefile
+++ b/doc/src/sgml/Makefile
@@ -66,10 +66,11 @@ ALLSGML := $(wildcard $(srcdir)/*.sgml $(srcdir)/ref/*.sgml) $(GENERATED_SGML)
# Enable some extra warnings
# -wfully-tagged needed to throw a warning on missing tags
# for older tool chains, 2007-08-31
-override SPFLAGS += -wall -wno-unused-param -wno-empty -wfully-tagged
+override SPFLAGS += -wall -wno-unused-param -wfully-tagged
# Additional warnings for XML compatibility. The conditional is meant
# to detect whether we are using OpenSP rather than the ancient
# original SP.
+override SPFLAGS += -wempty
ifneq (,$(filter o%,$(notdir $(OSX))))
override SPFLAGS += -wdata-delim -winstance-ignore-ms -winstance-include-ms -winstance-param-entity
endif
diff --git a/doc/src/sgml/acronyms.sgml b/doc/src/sgml/acronyms.sgml
index 29f85e08468..35514d4d9ac 100644
--- a/doc/src/sgml/acronyms.sgml
+++ b/doc/src/sgml/acronyms.sgml
@@ -4,8 +4,8 @@
Acronyms
- This is a list of acronyms commonly used in the PostgreSQL>
- documentation and in discussions about PostgreSQL>.
+ This is a list of acronyms commonly used in the PostgreSQL
+ documentation and in discussions about PostgreSQL.
@@ -153,7 +153,7 @@
Data
Definition Language, SQL commands such as CREATE
- TABLE>, ALTER USER>
+ TABLE, ALTER USER
@@ -164,8 +164,8 @@
Data
- Manipulation Language, SQL commands such as INSERT>,
- UPDATE>, DELETE>
+ Manipulation Language, SQL commands such as INSERT,
+ UPDATE, DELETE
@@ -281,7 +281,7 @@
Grand Unified Configuration,
- the PostgreSQL> subsystem that handles server configuration
+ the PostgreSQL subsystem that handles server configuration
@@ -384,7 +384,7 @@
LSN
- Log Sequence Number, see pg_lsn>
+ Log Sequence Number, see pg_lsn
and WAL Internals.
@@ -486,7 +486,7 @@
PGSQL
- PostgreSQL>
+ PostgreSQL
@@ -495,7 +495,7 @@
PGXS
- PostgreSQL> Extension System
+ PostgreSQL Extension System
diff --git a/doc/src/sgml/adminpack.sgml b/doc/src/sgml/adminpack.sgml
index fddf90c4a56..b27a4a325d9 100644
--- a/doc/src/sgml/adminpack.sgml
+++ b/doc/src/sgml/adminpack.sgml
@@ -8,8 +8,8 @@
- adminpack> provides a number of support functions which
- pgAdmin> and other administration and management tools can
+ adminpack provides a number of support functions which
+ pgAdmin and other administration and management tools can
use to provide additional functionality, such as remote management
of server log files.
Use of all these functions is restricted to superusers.
@@ -25,7 +25,7 @@
- adminpack> Functions
+ adminpack FunctionsNameReturn TypeDescription
@@ -58,7 +58,7 @@
pg_catalog.pg_logdir_ls()setof record
- List the log files in the log_directory> directory
+ List the log files in the log_directory directory
@@ -69,9 +69,9 @@
pg_file_write
- pg_file_write> writes the specified data> into
- the file named by filename>. If append> is
- false, the file must not already exist. If append> is true,
+ pg_file_write writes the specified data into
+ the file named by filename. If append is
+ false, the file must not already exist. If append is true,
the file can already exist, and will be appended to if so.
Returns the number of bytes written.
@@ -80,15 +80,15 @@
pg_file_rename
- pg_file_rename> renames a file. If archivename>
- is omitted or NULL, it simply renames oldname>
- to newname> (which must not already exist).
- If archivename> is provided, it first
- renames newname> to archivename> (which must
- not already exist), and then renames oldname>
- to newname>. In event of failure of the second rename step,
- it will try to rename archivename> back
- to newname> before reporting the error.
+ pg_file_rename renames a file. If archivename
+ is omitted or NULL, it simply renames oldname
+ to newname (which must not already exist).
+ If archivename is provided, it first
+ renames newname to archivename (which must
+ not already exist), and then renames oldname
+ to newname. In event of failure of the second rename step,
+ it will try to rename archivename back
+ to newname before reporting the error.
Returns true on success, false if the source file(s) are not present or
not writable; other cases throw errors.
@@ -97,19 +97,19 @@
pg_file_unlink
- pg_file_unlink> removes the specified file.
+ pg_file_unlink removes the specified file.
Returns true on success, false if the specified file is not present
- or the unlink()> call fails; other cases throw errors.
+ or the unlink() call fails; other cases throw errors.
pg_logdir_ls
- pg_logdir_ls> returns the start timestamps and path
+ pg_logdir_ls returns the start timestamps and path
names of all the log files in the
directory. The parameter must have its
- default setting (postgresql-%Y-%m-%d_%H%M%S.log>) to use this
+ default setting (postgresql-%Y-%m-%d_%H%M%S.log) to use this
function.
@@ -119,12 +119,12 @@
and should not be used in new applications; instead use those shown
in
and . These functions are
- provided in adminpack> only for compatibility with old
- versions of pgAdmin>.
+ provided in adminpack only for compatibility with old
+ versions of pgAdmin.
- Deprecated adminpack> Functions
+ Deprecated adminpack FunctionsNameReturn TypeDescription
@@ -136,22 +136,22 @@
pg_catalog.pg_file_read(filename text, offset bigint, nbytes bigint)text
- Alternate name for pg_read_file()>
+ Alternate name for pg_read_file()pg_catalog.pg_file_length(filename text)bigint
- Same as size> column returned
- by pg_stat_file()>
+ Same as size column returned
+ by pg_stat_file()pg_catalog.pg_logfile_rotate()integer
- Alternate name for pg_rotate_logfile()>, but note that it
+ Alternate name for pg_rotate_logfile(), but note that it
returns integer 0 or 1 rather than boolean
diff --git a/doc/src/sgml/advanced.sgml b/doc/src/sgml/advanced.sgml
index f47c01987be..bf87df4dcb1 100644
--- a/doc/src/sgml/advanced.sgml
+++ b/doc/src/sgml/advanced.sgml
@@ -145,7 +145,7 @@ DETAIL: Key (city)=(Berkeley) is not present in table "cities".
- Transactions> are a fundamental concept of all database
+ Transactions are a fundamental concept of all database
systems. The essential point of a transaction is that it bundles
multiple steps into a single, all-or-nothing operation. The intermediate
states between the steps are not visible to other concurrent transactions,
@@ -182,8 +182,8 @@ UPDATE branches SET balance = balance + 100.00
remain a happy customer if she was debited without Bob being credited.
We need a guarantee that if something goes wrong partway through the
operation, none of the steps executed so far will take effect. Grouping
- the updates into a transaction> gives us this guarantee.
- A transaction is said to be atomic>: from the point of
+ the updates into a transaction gives us this guarantee.
+ A transaction is said to be atomic: from the point of
view of other transactions, it either happens completely or not at all.
@@ -216,9 +216,9 @@ UPDATE branches SET balance = balance + 100.00
- In PostgreSQL>, a transaction is set up by surrounding
+ In PostgreSQL, a transaction is set up by surrounding
the SQL commands of the transaction with
- BEGIN> and COMMIT> commands. So our banking
+ BEGIN and COMMIT commands. So our banking
transaction would actually look like:
@@ -233,23 +233,23 @@ COMMIT;
If, partway through the transaction, we decide we do not want to
commit (perhaps we just noticed that Alice's balance went negative),
- we can issue the command ROLLBACK> instead of
- COMMIT>, and all our updates so far will be canceled.
+ we can issue the command ROLLBACK instead of
+ COMMIT, and all our updates so far will be canceled.
- PostgreSQL> actually treats every SQL statement as being
- executed within a transaction. If you do not issue a BEGIN>
+ PostgreSQL actually treats every SQL statement as being
+ executed within a transaction. If you do not issue a BEGIN
command,
- then each individual statement has an implicit BEGIN> and
- (if successful) COMMIT> wrapped around it. A group of
- statements surrounded by BEGIN> and COMMIT>
- is sometimes called a transaction block>.
+ then each individual statement has an implicit BEGIN and
+ (if successful) COMMIT wrapped around it. A group of
+ statements surrounded by BEGIN and COMMIT
+ is sometimes called a transaction block.
- Some client libraries issue BEGIN> and COMMIT>
+ Some client libraries issue BEGIN and COMMIT
commands automatically, so that you might get the effect of transaction
blocks without asking. Check the documentation for the interface
you are using.
@@ -258,11 +258,11 @@ COMMIT;
It's possible to control the statements in a transaction in a more
- granular fashion through the use of savepoints>. Savepoints
+ granular fashion through the use of savepoints. Savepoints
allow you to selectively discard parts of the transaction, while
committing the rest. After defining a savepoint with
- SAVEPOINT>, you can if needed roll back to the savepoint
- with ROLLBACK TO>. All the transaction's database changes
+ SAVEPOINT, you can if needed roll back to the savepoint
+ with ROLLBACK TO. All the transaction's database changes
between defining the savepoint and rolling back to it are discarded, but
changes earlier than the savepoint are kept.
@@ -308,7 +308,7 @@ COMMIT;
This example is, of course, oversimplified, but there's a lot of control
possible in a transaction block through the use of savepoints.
- Moreover, ROLLBACK TO> is the only way to regain control of a
+ Moreover, ROLLBACK TO is the only way to regain control of a
transaction block that was put in aborted state by the
system due to an error, short of rolling it back completely and starting
again.
@@ -325,7 +325,7 @@ COMMIT;
- A window function> performs a calculation across a set of
+ A window function performs a calculation across a set of
table rows that are somehow related to the current row. This is comparable
to the type of calculation that can be done with an aggregate function.
However, window functions do not cause rows to become grouped into a single
@@ -360,31 +360,31 @@ SELECT depname, empno, salary, avg(salary) OVER (PARTITION BY depname) FROM emps
The first three output columns come directly from the table
- empsalary>, and there is one output row for each row in the
+ empsalary, and there is one output row for each row in the
table. The fourth column represents an average taken across all the table
- rows that have the same depname> value as the current row.
- (This actually is the same function as the non-window avg>
- aggregate, but the OVER> clause causes it to be
+ rows that have the same depname value as the current row.
+ (This actually is the same function as the non-window avg
+ aggregate, but the OVER clause causes it to be
treated as a window function and computed across the window frame.)
- A window function call always contains an OVER> clause
+ A window function call always contains an OVER clause
directly following the window function's name and argument(s). This is what
syntactically distinguishes it from a normal function or non-window
- aggregate. The OVER> clause determines exactly how the
+ aggregate. The OVER clause determines exactly how the
rows of the query are split up for processing by the window function.
- The PARTITION BY> clause within OVER>
+ The PARTITION BY clause within OVER
divides the rows into groups, or partitions, that share the same
- values of the PARTITION BY> expression(s). For each row,
+ values of the PARTITION BY expression(s). For each row,
the window function is computed across the rows that fall into the
same partition as the current row.
You can also control the order in which rows are processed by
- window functions using ORDER BY> within OVER>.
- (The window ORDER BY> does not even have to match the
+ window functions using ORDER BY within OVER.
+ (The window ORDER BY does not even have to match the
order in which the rows are output.) Here is an example:
@@ -409,39 +409,39 @@ FROM empsalary;
(10 rows)
- As shown here, the rank> function produces a numerical rank
- for each distinct ORDER BY> value in the current row's
- partition, using the order defined by the ORDER BY> clause.
- rank> needs no explicit parameter, because its behavior
- is entirely determined by the OVER> clause.
+ As shown here, the rank function produces a numerical rank
+ for each distinct ORDER BY value in the current row's
+ partition, using the order defined by the ORDER BY clause.
+ rank needs no explicit parameter, because its behavior
+ is entirely determined by the OVER clause.
The rows considered by a window function are those of the virtual
- table> produced by the query's FROM> clause as filtered by its
- WHERE>, GROUP BY>, and HAVING> clauses
+ table produced by the query's FROM clause as filtered by its
+ WHERE, GROUP BY, and HAVING clauses
if any. For example, a row removed because it does not meet the
- WHERE> condition is not seen by any window function.
+ WHERE condition is not seen by any window function.
A query can contain multiple window functions that slice up the data
- in different ways using different OVER> clauses, but
+ in different ways using different OVER clauses, but
they all act on the same collection of rows defined by this virtual table.
- We already saw that ORDER BY> can be omitted if the ordering
+ We already saw that ORDER BY can be omitted if the ordering
of rows is not important. It is also possible to omit PARTITION
- BY>, in which case there is a single partition containing all rows.
+ BY, in which case there is a single partition containing all rows.
There is another important concept associated with window functions:
for each row, there is a set of rows within its partition called its
- window frame>. Some window functions act only
+ window frame. Some window functions act only
on the rows of the window frame, rather than of the whole partition.
- By default, if ORDER BY> is supplied then the frame consists of
+ By default, if ORDER BY is supplied then the frame consists of
all rows from the start of the partition up through the current row, plus
any following rows that are equal to the current row according to the
- ORDER BY> clause. When ORDER BY> is omitted the
+ ORDER BY clause. When ORDER BY is omitted the
default frame consists of all rows in the partition.
@@ -450,7 +450,7 @@ FROM empsalary;
for details.
- Here is an example using sum>:
+ Here is an example using sum:
@@ -474,11 +474,11 @@ SELECT salary, sum(salary) OVER () FROM empsalary;
- Above, since there is no ORDER BY> in the OVER>
+ Above, since there is no ORDER BY in the OVER
clause, the window frame is the same as the partition, which for lack of
- PARTITION BY> is the whole table; in other words each sum is
+ PARTITION BY is the whole table; in other words each sum is
taken over the whole table and so we get the same result for each output
- row. But if we add an ORDER BY> clause, we get very different
+ row. But if we add an ORDER BY clause, we get very different
results:
@@ -510,8 +510,8 @@ SELECT salary, sum(salary) OVER (ORDER BY salary) FROM empsalary;
Window functions are permitted only in the SELECT list
- and the ORDER BY> clause of the query. They are forbidden
- elsewhere, such as in GROUP BY>, HAVING>
+ and the ORDER BY clause of the query. They are forbidden
+ elsewhere, such as in GROUP BY, HAVING
and WHERE clauses. This is because they logically
execute after the processing of those clauses. Also, window functions
execute after non-window aggregate functions. This means it is valid to
@@ -534,15 +534,15 @@ WHERE pos < 3;
The above query only shows the rows from the inner query having
- rank> less than 3.
+ rank less than 3.
When a query involves multiple window functions, it is possible to write
- out each one with a separate OVER> clause, but this is
+ out each one with a separate OVER clause, but this is
duplicative and error-prone if the same windowing behavior is wanted
for several functions. Instead, each windowing behavior can be named
- in a WINDOW> clause and then referenced in OVER>.
+ in a WINDOW clause and then referenced in OVER.
For example:
@@ -623,13 +623,13 @@ CREATE TABLE capitals (
In this case, a row of capitals
- inherits all columns (name>,
- population>, and altitude>) from its
+ inherits all columns (name,
+ population, and altitude) from its
parent, cities. The
type of the column name is
text, a native PostgreSQL
type for variable length character strings. State capitals have
- an extra column, state>, that shows their state. In
+ an extra column, state, that shows their state. In
PostgreSQL, a table can inherit from
zero or more other tables.
diff --git a/doc/src/sgml/amcheck.sgml b/doc/src/sgml/amcheck.sgml
index dd71dbd679b..0dd68f0ba14 100644
--- a/doc/src/sgml/amcheck.sgml
+++ b/doc/src/sgml/amcheck.sgml
@@ -8,19 +8,19 @@
- The amcheck> module provides functions that allow you to
+ The amcheck module provides functions that allow you to
verify the logical consistency of the structure of indexes. If the
structure appears to be valid, no error is raised.
- The functions verify various invariants> in the
+ The functions verify various invariants in the
structure of the representation of particular indexes. The
correctness of the access method functions behind index scans and
other important operations relies on these invariants always
holding. For example, certain functions verify, among other things,
- that all B-Tree pages have items in logical> order (e.g.,
- for B-Tree indexes on text>, index tuples should be in
+ that all B-Tree pages have items in logical order (e.g.,
+ for B-Tree indexes on text, index tuples should be in
collated lexical order). If that particular invariant somehow fails
to hold, we can expect binary searches on the affected page to
incorrectly guide index scans, resulting in wrong answers to SQL
@@ -35,7 +35,7 @@
functions.
- amcheck> functions may be used only by superusers.
+ amcheck functions may be used only by superusers.
@@ -82,7 +82,7 @@ ORDER BY c.relpages DESC LIMIT 10;
(10 rows)
This example shows a session that performs verification of every
- catalog index in the database test>. Details of just
+ catalog index in the database test. Details of just
the 10 largest indexes verified are displayed. Since no error
is raised, all indexes tested appear to be logically consistent.
Naturally, this query could easily be changed to call
@@ -90,10 +90,10 @@ ORDER BY c.relpages DESC LIMIT 10;
database where verification is supported.
- bt_index_check acquires an AccessShareLock>
+ bt_index_check acquires an AccessShareLock
on the target index and the heap relation it belongs to. This lock mode
is the same lock mode acquired on relations by simple
- SELECT> statements.
+ SELECT statements.
bt_index_check does not verify invariants
that span child/parent relationships, nor does it verify that
the target index is consistent with its heap relation. When a
@@ -132,13 +132,13 @@ ORDER BY c.relpages DESC LIMIT 10;
logical inconsistency or other problem.
- A ShareLock> is required on the target index by
+ A ShareLock is required on the target index by
bt_index_parent_check (a
- ShareLock> is also acquired on the heap relation).
+ ShareLock is also acquired on the heap relation).
These locks prevent concurrent data modification from
- INSERT>, UPDATE>, and DELETE>
+ INSERT, UPDATE, and DELETE
commands. The locks also prevent the underlying relation from
- being concurrently processed by VACUUM>, as well as
+ being concurrently processed by VACUUM, as well as
all other utility commands. Note that the function holds locks
only while running, not for the entire transaction.
@@ -159,13 +159,13 @@ ORDER BY c.relpages DESC LIMIT 10;
- Using amcheck> effectively
+ Using amcheck effectively
- amcheck> can be effective at detecting various types of
+ amcheck can be effective at detecting various types of
failure modes that data page
- checksums> will always fail to catch. These include:
+ checksums will always fail to catch. These include:
@@ -176,13 +176,13 @@ ORDER BY c.relpages DESC LIMIT 10;
This includes issues caused by the comparison rules of operating
system collations changing. Comparisons of datums of a collatable
- type like text> must be immutable (just as all
+ type like text must be immutable (just as all
comparisons used for B-Tree index scans must be immutable), which
implies that operating system collation rules must never change.
Though rare, updates to operating system collation rules can
cause these issues. More commonly, an inconsistency in the
collation order between a master server and a standby server is
- implicated, possibly because the major> operating
+ implicated, possibly because the major operating
system version in use is inconsistent. Such inconsistencies will
generally only arise on standby servers, and so can generally
only be detected on standby servers.
@@ -190,25 +190,25 @@ ORDER BY c.relpages DESC LIMIT 10;
If a problem like this arises, it may not affect each individual
index that is ordered using an affected collation, simply because
- indexed> values might happen to have the same
+ indexed values might happen to have the same
absolute ordering regardless of the behavioral inconsistency. See
and for
- further details about how PostgreSQL> uses
+ further details about how PostgreSQL uses
operating system locales and collations.
Corruption caused by hypothetical undiscovered bugs in the
- underlying PostgreSQL> access method code or sort
+ underlying PostgreSQL access method code or sort
code.
Automatic verification of the structural integrity of indexes
plays a role in the general testing of new or proposed
- PostgreSQL> features that could plausibly allow a
+ PostgreSQL features that could plausibly allow a
logical inconsistency to be introduced. One obvious testing
- strategy is to call amcheck> functions continuously
+ strategy is to call amcheck functions continuously
when running the standard regression tests. See for details on running the tests.
@@ -219,12 +219,12 @@ ORDER BY c.relpages DESC LIMIT 10;
simply not be enabled.
- Note that amcheck> examines a page as represented in some
+ Note that amcheck examines a page as represented in some
shared memory buffer at the time of verification if there is only a
shared buffer hit when accessing the block. Consequently,
- amcheck> does not necessarily examine data read from the
+ amcheck does not necessarily examine data read from the
file system at the time of verification. Note that when checksums are
- enabled, amcheck> may raise an error due to a checksum
+ enabled, amcheck may raise an error due to a checksum
failure when a corrupt block is read into a buffer.
@@ -234,7 +234,7 @@ ORDER BY c.relpages DESC LIMIT 10;
and operating system.
- PostgreSQL> does not protect against correctable
+ PostgreSQL does not protect against correctable
memory errors and it is assumed you will operate using RAM that
uses industry standard Error Correcting Codes (ECC) or better
protection. However, ECC memory is typically only immune to
@@ -244,7 +244,7 @@ ORDER BY c.relpages DESC LIMIT 10;
- In general, amcheck> can only prove the presence of
+ In general, amcheck can only prove the presence of
corruption; it cannot prove its absence.
@@ -252,19 +252,19 @@ ORDER BY c.relpages DESC LIMIT 10;
Repairing corruption
- No error concerning corruption raised by amcheck> should
- ever be a false positive. In practice, amcheck> is more
+ No error concerning corruption raised by amcheck should
+ ever be a false positive. In practice, amcheck is more
likely to find software bugs than problems with hardware.
- amcheck> raises errors in the event of conditions that,
+ amcheck raises errors in the event of conditions that,
by definition, should never happen, and so careful analysis of
- amcheck> errors is often required.
+ amcheck errors is often required.
There is no general method of repairing problems that
- amcheck> detects. An explanation for the root cause of
+ amcheck detects. An explanation for the root cause of
an invariant violation should be sought. may play a useful role in diagnosing
- corruption that amcheck> detects. A REINDEX>
+ corruption that amcheck detects. A REINDEX
may not be effective in repairing corruption.
diff --git a/doc/src/sgml/arch-dev.sgml b/doc/src/sgml/arch-dev.sgml
index c835e87215e..5423aadb9c8 100644
--- a/doc/src/sgml/arch-dev.sgml
+++ b/doc/src/sgml/arch-dev.sgml
@@ -118,7 +118,7 @@
PostgreSQL is implemented using a
- simple process per user> client/server model. In this model
+ simple process per user client/server model. In this model
there is one client process connected to
exactly one server process. As we do not
know ahead of time how many connections will be made, we have to
@@ -137,9 +137,9 @@
The client process can be any program that understands the
PostgreSQL protocol described in
. Many clients are based on the
- C-language library libpq>, but several independent
+ C-language library libpq, but several independent
implementations of the protocol exist, such as the Java
- JDBC> driver.
+ JDBC driver.
@@ -184,8 +184,8 @@
text) for valid syntax. If the syntax is correct a
parse tree is built up and handed back;
otherwise an error is returned. The parser and lexer are
- implemented using the well-known Unix tools bison>
- and flex>.
+ implemented using the well-known Unix tools bison
+ and flex.
@@ -251,7 +251,7 @@
back by the parser as input and does the semantic interpretation needed
to understand which tables, functions, and operators are referenced by
the query. The data structure that is built to represent this
- information is called the query tree>.
+ information is called the query tree.
@@ -259,10 +259,10 @@
system catalog lookups can only be done within a transaction, and we
do not wish to start a transaction immediately upon receiving a query
string. The raw parsing stage is sufficient to identify the transaction
- control commands (BEGIN>, ROLLBACK>, etc), and
+ control commands (BEGIN, ROLLBACK, etc), and
these can then be correctly executed without any further analysis.
Once we know that we are dealing with an actual query (such as
- SELECT> or UPDATE>), it is okay to
+ SELECT or UPDATE), it is okay to
start a transaction if we're not already in one. Only then can the
transformation process be invoked.
@@ -270,10 +270,10 @@
The query tree created by the transformation process is structurally
similar to the raw parse tree in most places, but it has many differences
- in detail. For example, a FuncCall> node in the
+ in detail. For example, a FuncCall node in the
parse tree represents something that looks syntactically like a function
- call. This might be transformed to either a FuncExpr>
- or Aggref> node depending on whether the referenced
+ call. This might be transformed to either a FuncExpr
+ or Aggref node depending on whether the referenced
name turns out to be an ordinary function or an aggregate function.
Also, information about the actual data types of columns and expression
results is added to the query tree.
@@ -354,10 +354,10 @@
The planner's search procedure actually works with data structures
- called paths>, which are simply cut-down representations of
+ called paths, which are simply cut-down representations of
plans containing only as much information as the planner needs to make
its decisions. After the cheapest path is determined, a full-fledged
- plan tree> is built to pass to the executor. This represents
+ plan tree is built to pass to the executor. This represents
the desired execution plan in sufficient detail for the executor to run it.
In the rest of this section we'll ignore the distinction between paths
and plans.
@@ -378,12 +378,12 @@
relation.attribute OPR constant. If
relation.attribute happens to match the key of the B-tree
index and OPR is one of the operators listed in
- the index's operator class>, another plan is created using
+ the index's operator class, another plan is created using
the B-tree index to scan the relation. If there are further indexes
present and the restrictions in the query happen to match a key of an
index, further plans will be considered. Index scan plans are also
generated for indexes that have a sort ordering that can match the
- query's ORDER BY> clause (if any), or a sort ordering that
+ query's ORDER BY clause (if any), or a sort ordering that
might be useful for merge joining (see below).
@@ -462,9 +462,9 @@
the base relations, plus nested-loop, merge, or hash join nodes as
needed, plus any auxiliary steps needed, such as sort nodes or
aggregate-function calculation nodes. Most of these plan node
- types have the additional ability to do selection>
+ types have the additional ability to do selection
(discarding rows that do not meet a specified Boolean condition)
- and projection> (computation of a derived column set
+ and projection (computation of a derived column set
based on given column values, that is, evaluation of scalar
expressions where needed). One of the responsibilities of the
planner is to attach selection conditions from the
@@ -496,7 +496,7 @@
subplan) is, let's say, a
Sort node and again recursion is needed to obtain
an input row. The child node of the Sort might
- be a SeqScan> node, representing actual reading of a table.
+ be a SeqScan node, representing actual reading of a table.
Execution of this node causes the executor to fetch a row from the
table and return it up to the calling node. The Sort
node will repeatedly call its child to obtain all the rows to be sorted.
@@ -529,24 +529,24 @@
The executor mechanism is used to evaluate all four basic SQL query types:
- SELECT>, INSERT>, UPDATE>, and
- DELETE>. For SELECT>, the top-level executor
+ SELECT, INSERT, UPDATE, and
+ DELETE. For SELECT, the top-level executor
code only needs to send each row returned by the query plan tree off
- to the client. For INSERT>, each returned row is inserted
- into the target table specified for the INSERT>. This is
- done in a special top-level plan node called ModifyTable>.
+ to the client. For INSERT, each returned row is inserted
+ into the target table specified for the INSERT. This is
+ done in a special top-level plan node called ModifyTable.
(A simple
- INSERT ... VALUES> command creates a trivial plan tree
- consisting of a single Result> node, which computes just one
- result row, and ModifyTable> above it to perform the insertion.
- But INSERT ... SELECT> can demand the full power
- of the executor mechanism.) For UPDATE>, the planner arranges
+ INSERT ... VALUES command creates a trivial plan tree
+ consisting of a single Result node, which computes just one
+ result row, and ModifyTable above it to perform the insertion.
+ But INSERT ... SELECT can demand the full power
+ of the executor mechanism.) For UPDATE, the planner arranges
that each computed row includes all the updated column values, plus
- the TID> (tuple ID, or row ID) of the original target row;
- this data is fed into a ModifyTable> node, which uses the
+ the TID (tuple ID, or row ID) of the original target row;
+ this data is fed into a ModifyTable node, which uses the
information to create a new updated row and mark the old row deleted.
- For DELETE>, the only column that is actually returned by the
- plan is the TID, and the ModifyTable> node simply uses the TID
+ For DELETE, the only column that is actually returned by the
+ plan is the TID, and the ModifyTable node simply uses the TID
to visit each target row and mark it deleted.
diff --git a/doc/src/sgml/array.sgml b/doc/src/sgml/array.sgml
index 88eb4be04d0..9187f6e02e7 100644
--- a/doc/src/sgml/array.sgml
+++ b/doc/src/sgml/array.sgml
@@ -32,7 +32,7 @@ CREATE TABLE sal_emp (
);
As shown, an array data type is named by appending square brackets
- ([]>) to the data type name of the array elements. The
+ ([]) to the data type name of the array elements. The
above command will create a table named
sal_emp with a column of type
text (name), a
@@ -69,7 +69,7 @@ CREATE TABLE tictactoe (
An alternative syntax, which conforms to the SQL standard by using
- the keyword ARRAY>, can be used for one-dimensional arrays.
+ the keyword ARRAY, can be used for one-dimensional arrays.
pay_by_quarter could have been defined
as:
@@ -79,7 +79,7 @@ CREATE TABLE tictactoe (
pay_by_quarter integer ARRAY,
- As before, however, PostgreSQL> does not enforce the
+ As before, however, PostgreSQL does not enforce the
size restriction in any case.
@@ -107,8 +107,8 @@ CREATE TABLE tictactoe (
for the type, as recorded in its pg_type entry.
Among the standard data types provided in the
PostgreSQL distribution, all use a comma
- (,>), except for type box> which uses a semicolon
- (;>). Each val is
+ (,), except for type box which uses a semicolon
+ (;). Each val is
either a constant of the array element type, or a subarray. An example
of an array constant is:
@@ -119,10 +119,10 @@ CREATE TABLE tictactoe (
- To set an element of an array constant to NULL, write NULL>
+ To set an element of an array constant to NULL, write NULL
for the element value. (Any upper- or lower-case variant of
- NULL> will do.) If you want an actual string value
- NULL>, you must put double quotes around it.
+ NULL will do.) If you want an actual string value
+ NULL, you must put double quotes around it.
@@ -176,7 +176,7 @@ ERROR: multidimensional arrays must have array expressions with matching dimens
- The ARRAY> constructor syntax can also be used:
+ The ARRAY constructor syntax can also be used:
INSERT INTO sal_emp
VALUES ('Bill',
@@ -190,7 +190,7 @@ INSERT INTO sal_emp
Notice that the array elements are ordinary SQL constants or
expressions; for instance, string literals are single quoted, instead of
- double quoted as they would be in an array literal. The ARRAY>
+ double quoted as they would be in an array literal. The ARRAY
constructor syntax is discussed in more detail in
.
@@ -222,8 +222,8 @@ SELECT name FROM sal_emp WHERE pay_by_quarter[1] <> pay_by_quarter[2];
The array subscript numbers are written within square brackets.
By default PostgreSQL uses a
one-based numbering convention for arrays, that is,
- an array of n> elements starts with array[1] and
- ends with array[n>].
+ an array of n elements starts with array[1] and
+ ends with array[n].
@@ -259,8 +259,8 @@ SELECT schedule[1:2][1:1] FROM sal_emp WHERE name = 'Bill';
If any dimension is written as a slice, i.e., contains a colon, then all
dimensions are treated as slices. Any dimension that has only a single
number (no colon) is treated as being from 1
- to the number specified. For example, [2]> is treated as
- [1:2]>, as in this example:
+ to the number specified. For example, [2] is treated as
+ [1:2], as in this example:
SELECT schedule[1:2][2] FROM sal_emp WHERE name = 'Bill';
@@ -272,7 +272,7 @@ SELECT schedule[1:2][2] FROM sal_emp WHERE name = 'Bill';
To avoid confusion with the non-slice case, it's best to use slice syntax
- for all dimensions, e.g., [1:2][1:1]>, not [2][1:1]>.
+ for all dimensions, e.g., [1:2][1:1], not [2][1:1].
@@ -302,9 +302,9 @@ SELECT schedule[:][1:1] FROM sal_emp WHERE name = 'Bill';
An array subscript expression will return null if either the array itself or
any of the subscript expressions are null. Also, null is returned if a
subscript is outside the array bounds (this case does not raise an error).
- For example, if schedule>
- currently has the dimensions [1:3][1:2]> then referencing
- schedule[3][3]> yields NULL. Similarly, an array reference
+ For example, if schedule
+ currently has the dimensions [1:3][1:2] then referencing
+ schedule[3][3] yields NULL. Similarly, an array reference
with the wrong number of subscripts yields a null rather than an error.
@@ -423,16 +423,16 @@ UPDATE sal_emp SET pay_by_quarter[1:2] = '{27000,27000}'
A stored array value can be enlarged by assigning to elements not already
present. Any positions between those previously present and the newly
assigned elements will be filled with nulls. For example, if array
- myarray> currently has 4 elements, it will have six
- elements after an update that assigns to myarray[6]>;
- myarray[5]> will contain null.
+ myarray currently has 4 elements, it will have six
+ elements after an update that assigns to myarray[6];
+ myarray[5] will contain null.
Currently, enlargement in this fashion is only allowed for one-dimensional
arrays, not multidimensional arrays.
Subscripted assignment allows creation of arrays that do not use one-based
- subscripts. For example one might assign to myarray[-2:7]> to
+ subscripts. For example one might assign to myarray[-2:7] to
create an array with subscript values from -2 to 7.
@@ -457,8 +457,8 @@ SELECT ARRAY[5,6] || ARRAY[[1,2],[3,4]];
The concatenation operator allows a single element to be pushed onto the
beginning or end of a one-dimensional array. It also accepts two
- N>-dimensional arrays, or an N>-dimensional
- and an N+1>-dimensional array.
+ N-dimensional arrays, or an N-dimensional
+ and an N+1-dimensional array.
@@ -501,10 +501,10 @@ SELECT array_dims(ARRAY[[1,2],[3,4]] || ARRAY[[5,6],[7,8],[9,0]]);
- When an N>-dimensional array is pushed onto the beginning
- or end of an N+1>-dimensional array, the result is
- analogous to the element-array case above. Each N>-dimensional
- sub-array is essentially an element of the N+1>-dimensional
+ When an N-dimensional array is pushed onto the beginning
+ or end of an N+1-dimensional array, the result is
+ analogous to the element-array case above. Each N-dimensional
+ sub-array is essentially an element of the N+1-dimensional
array's outer dimension. For example:
SELECT array_dims(ARRAY[1,2] || ARRAY[[3,4],[5,6]]);
@@ -587,9 +587,9 @@ SELECT array_append(ARRAY[1, 2], NULL); -- this might have been meant
The heuristic it uses to resolve the constant's type is to assume it's of
the same type as the operator's other input — in this case,
integer array. So the concatenation operator is presumed to
- represent array_cat>, not array_append>. When
+ represent array_cat, not array_append. When
that's the wrong choice, it could be fixed by casting the constant to the
- array's element type; but explicit use of array_append> might
+ array's element type; but explicit use of array_append might
be a preferable solution.
@@ -633,7 +633,7 @@ SELECT * FROM sal_emp WHERE 10000 = ALL (pay_by_quarter);
- Alternatively, the generate_subscripts> function can be used.
+ Alternatively, the generate_subscripts function can be used.
For example:
@@ -648,7 +648,7 @@ SELECT * FROM
- You can also search an array using the &&> operator,
+ You can also search an array using the && operator,
which checks whether the left operand overlaps with the right operand.
For instance:
@@ -662,8 +662,8 @@ SELECT * FROM sal_emp WHERE pay_by_quarter && ARRAY[10000];
- You can also search for specific values in an array using the array_position>
- and array_positions> functions. The former returns the subscript of
+ You can also search for specific values in an array using the array_position
+ and array_positions functions. The former returns the subscript of
the first occurrence of a value in an array; the latter returns an array with the
subscripts of all occurrences of the value in the array. For example:
@@ -703,13 +703,13 @@ SELECT array_positions(ARRAY[1, 4, 3, 1, 3, 4, 2, 1], 1);
The external text representation of an array value consists of items that
are interpreted according to the I/O conversion rules for the array's
element type, plus decoration that indicates the array structure.
- The decoration consists of curly braces ({> and }>)
+ The decoration consists of curly braces ({ and })
around the array value plus delimiter characters between adjacent items.
- The delimiter character is usually a comma (,>) but can be
- something else: it is determined by the typdelim> setting
+ The delimiter character is usually a comma (,) but can be
+ something else: it is determined by the typdelim setting
for the array's element type. Among the standard data types provided
in the PostgreSQL distribution, all use a comma,
- except for type box>, which uses a semicolon (;>).
+ except for type box, which uses a semicolon (;).
In a multidimensional array, each dimension (row, plane,
cube, etc.) gets its own level of curly braces, and delimiters
must be written between adjacent curly-braced entities of the same level.
@@ -719,7 +719,7 @@ SELECT array_positions(ARRAY[1, 4, 3, 1, 3, 4, 2, 1], 1);
The array output routine will put double quotes around element values
if they are empty strings, contain curly braces, delimiter characters,
double quotes, backslashes, or white space, or match the word
- NULL>. Double quotes and backslashes
+ NULL. Double quotes and backslashes
embedded in element values will be backslash-escaped. For numeric
data types it is safe to assume that double quotes will never appear, but
for textual data types one should be prepared to cope with either the presence
@@ -731,10 +731,10 @@ SELECT array_positions(ARRAY[1, 4, 3, 1, 3, 4, 2, 1], 1);
set to one. To represent arrays with other lower bounds, the array
subscript ranges can be specified explicitly before writing the
array contents.
- This decoration consists of square brackets ([]>)
+ This decoration consists of square brackets ([])
around each array dimension's lower and upper bounds, with
- a colon (:>) delimiter character in between. The
- array dimension decoration is followed by an equal sign (=>).
+ a colon (:) delimiter character in between. The
+ array dimension decoration is followed by an equal sign (=).
For example:
SELECT f1[1][-2][3] AS e1, f1[1][-1][5] AS e2
@@ -750,23 +750,23 @@ SELECT f1[1][-2][3] AS e1, f1[1][-1][5] AS e2
- If the value written for an element is NULL> (in any case
+ If the value written for an element is NULL (in any case
variant), the element is taken to be NULL. The presence of any quotes
or backslashes disables this and allows the literal string value
- NULL> to be entered. Also, for backward compatibility with
- pre-8.2 versions of PostgreSQL>, the NULL to be entered. Also, for backward compatibility with
+ pre-8.2 versions of PostgreSQL, the configuration parameter can be turned
- off> to suppress recognition of NULL> as a NULL.
+ off to suppress recognition of NULL as a NULL.
As shown previously, when writing an array value you can use double
- quotes around any individual array element. You must> do so
+ quotes around any individual array element. You must do so
if the element value would otherwise confuse the array-value parser.
For example, elements containing curly braces, commas (or the data type's
delimiter character), double quotes, backslashes, or leading or trailing
whitespace must be double-quoted. Empty strings and strings matching the
- word NULL> must be quoted, too. To put a double quote or
+ word NULL must be quoted, too. To put a double quote or
backslash in a quoted array element value, use escape string syntax
and precede it with a backslash. Alternatively, you can avoid quotes and use
backslash-escaping to protect all data characters that would otherwise
@@ -785,17 +785,17 @@ SELECT f1[1][-2][3] AS e1, f1[1][-1][5] AS e2
Remember that what you write in an SQL command will first be interpreted
as a string literal, and then as an array. This doubles the number of
- backslashes you need. For example, to insert a text> array
+ backslashes you need. For example, to insert a text array
value containing a backslash and a double quote, you'd need to write:
INSERT ... VALUES (E'{"\\\\","\\""}');
The escape string processor removes one level of backslashes, so that
- what arrives at the array-value parser looks like {"\\","\""}>.
- In turn, the strings fed to the text> data type's input routine
- become \> and "> respectively. (If we were working
+ what arrives at the array-value parser looks like {"\\","\""}.
+ In turn, the strings fed to the text data type's input routine
+ become \ and " respectively. (If we were working
with a data type whose input routine also treated backslashes specially,
- bytea> for example, we might need as many as eight backslashes
+ bytea for example, we might need as many as eight backslashes
in the command to get one backslash into the stored array element.)
Dollar quoting (see ) can be
used to avoid the need to double backslashes.
@@ -804,10 +804,10 @@ INSERT ... VALUES (E'{"\\\\","\\""}');
- The ARRAY> constructor syntax (see
+ The ARRAY constructor syntax (see
) is often easier to work
with than the array-literal syntax when writing array values in SQL
- commands. In ARRAY>, individual element values are written the
+ commands. In ARRAY, individual element values are written the
same way they would be written when not members of an array.
diff --git a/doc/src/sgml/auth-delay.sgml b/doc/src/sgml/auth-delay.sgml
index 9a6e3e9bb4d..9221d2dfb65 100644
--- a/doc/src/sgml/auth-delay.sgml
+++ b/doc/src/sgml/auth-delay.sgml
@@ -18,7 +18,7 @@
In order to function, this module must be loaded via
- in postgresql.conf>.
+ in postgresql.conf.
@@ -29,7 +29,7 @@
auth_delay.milliseconds (int)
- auth_delay.milliseconds> configuration parameter
+ auth_delay.milliseconds configuration parameter
@@ -42,7 +42,7 @@
- These parameters must be set in postgresql.conf>.
+ These parameters must be set in postgresql.conf.
Typical usage might be:
diff --git a/doc/src/sgml/auto-explain.sgml b/doc/src/sgml/auto-explain.sgml
index 38e6f50c802..240098c82f7 100644
--- a/doc/src/sgml/auto-explain.sgml
+++ b/doc/src/sgml/auto-explain.sgml
@@ -24,10 +24,10 @@ LOAD 'auto_explain';
(You must be superuser to do that.) More typical usage is to preload
- it into some or all sessions by including auto_explain> in
+ it into some or all sessions by including auto_explain in
or
in
- postgresql.conf>. Then you can track unexpectedly slow queries
+ postgresql.conf. Then you can track unexpectedly slow queries
no matter when they happen. Of course there is a price in overhead for
that.
@@ -47,7 +47,7 @@ LOAD 'auto_explain';
auto_explain.log_min_duration (integer)
- auto_explain.log_min_duration> configuration parameter
+ auto_explain.log_min_duration configuration parameter
@@ -66,13 +66,13 @@ LOAD 'auto_explain';
auto_explain.log_analyze (boolean)
- auto_explain.log_analyze> configuration parameter
+ auto_explain.log_analyze configuration parameter
- auto_explain.log_analyze causes EXPLAIN ANALYZE>
- output, rather than just EXPLAIN> output, to be printed
+ auto_explain.log_analyze causes EXPLAIN ANALYZE
+ output, rather than just EXPLAIN output, to be printed
when an execution plan is logged. This parameter is off by default.
Only superusers can change this setting.
@@ -92,14 +92,14 @@ LOAD 'auto_explain';
auto_explain.log_buffers (boolean)
- auto_explain.log_buffers> configuration parameter
+ auto_explain.log_buffers configuration parameterauto_explain.log_buffers controls whether buffer
usage statistics are printed when an execution plan is logged; it's
- equivalent to the BUFFERS> option of EXPLAIN>.
+ equivalent to the BUFFERS option of EXPLAIN.
This parameter has no effect
unless auto_explain.log_analyze is enabled.
This parameter is off by default.
@@ -112,14 +112,14 @@ LOAD 'auto_explain';
auto_explain.log_timing (boolean)
- auto_explain.log_timing> configuration parameter
+ auto_explain.log_timing configuration parameterauto_explain.log_timing controls whether per-node
timing information is printed when an execution plan is logged; it's
- equivalent to the TIMING> option of EXPLAIN>.
+ equivalent to the TIMING option of EXPLAIN.
The overhead of repeatedly reading the system clock can slow down
queries significantly on some systems, so it may be useful to set this
parameter to off when only actual row counts, and not exact times, are
@@ -136,7 +136,7 @@ LOAD 'auto_explain';
auto_explain.log_triggers (boolean)
- auto_explain.log_triggers> configuration parameter
+ auto_explain.log_triggers configuration parameter
@@ -155,14 +155,14 @@ LOAD 'auto_explain';
auto_explain.log_verbose (boolean)
- auto_explain.log_verbose> configuration parameter
+ auto_explain.log_verbose configuration parameterauto_explain.log_verbose controls whether verbose
details are printed when an execution plan is logged; it's
- equivalent to the VERBOSE> option of EXPLAIN>.
+ equivalent to the VERBOSE option of EXPLAIN.
This parameter is off by default.
Only superusers can change this setting.
@@ -173,13 +173,13 @@ LOAD 'auto_explain';
auto_explain.log_format (enum)
- auto_explain.log_format> configuration parameter
+ auto_explain.log_format configuration parameterauto_explain.log_format selects the
- EXPLAIN> output format to be used.
+ EXPLAIN output format to be used.
The allowed values are text, xml,
json, and yaml. The default is text.
Only superusers can change this setting.
@@ -191,7 +191,7 @@ LOAD 'auto_explain';
auto_explain.log_nested_statements (boolean)
- auto_explain.log_nested_statements> configuration parameter
+ auto_explain.log_nested_statements configuration parameter
@@ -208,7 +208,7 @@ LOAD 'auto_explain';
auto_explain.sample_rate (real)
- auto_explain.sample_rate> configuration parameter
+ auto_explain.sample_rate configuration parameter
@@ -224,7 +224,7 @@ LOAD 'auto_explain';
In ordinary usage, these parameters are set
- in postgresql.conf>, although superusers can alter them
+ in postgresql.conf, although superusers can alter them
on-the-fly within their own sessions.
Typical usage might be:
diff --git a/doc/src/sgml/backup.sgml b/doc/src/sgml/backup.sgml
index bd55e8bb775..dd9c1bff5b3 100644
--- a/doc/src/sgml/backup.sgml
+++ b/doc/src/sgml/backup.sgml
@@ -3,10 +3,10 @@
Backup and Restore
- backup>>
+ backup
- As with everything that contains valuable data, PostgreSQL>
+ As with everything that contains valuable data, PostgreSQL
databases should be backed up regularly. While the procedure is
essentially simple, it is important to have a clear understanding of
the underlying techniques and assumptions.
@@ -14,9 +14,9 @@
There are three fundamentally different approaches to backing up
- PostgreSQL> data:
+ PostgreSQL data:
- SQL> dump
+ SQL dumpFile system level backupContinuous archiving
@@ -25,30 +25,30 @@
- SQL> Dump
+ SQL Dump
The idea behind this dump method is to generate a file with SQL
commands that, when fed back to the server, will recreate the
database in the same state as it was at the time of the dump.
- PostgreSQL> provides the utility program
+ PostgreSQL provides the utility program
for this purpose. The basic usage of this
command is:
pg_dump dbname > outfile
- As you see, pg_dump> writes its result to the
+ As you see, pg_dump writes its result to the
standard output. We will see below how this can be useful.
- While the above command creates a text file, pg_dump>
+ While the above command creates a text file, pg_dump
can create files in other formats that allow for parallelism and more
fine-grained control of object restoration.
- pg_dump> is a regular PostgreSQL>
+ pg_dump is a regular PostgreSQL
client application (albeit a particularly clever one). This means
that you can perform this backup procedure from any remote host that has
- access to the database. But remember that pg_dump>
+ access to the database. But remember that pg_dump
does not operate with special permissions. In particular, it must
have read access to all tables that you want to back up, so in order
to back up the entire database you almost always have to run it as a
@@ -60,9 +60,9 @@ pg_dump dbname >
- To specify which database server pg_dump> should
+ To specify which database server pg_dump should
contact, use the command line options ). psql
+ supports options similar to pg_dump for specifying
the database server to connect to and the user name to use. See
the reference page for more information.
Non-text file dumps are restored using the dbname <
- By default, the psql> script will continue to
+ By default, the psql script will continue to
execute after an SQL error is encountered. You might wish to run
psql with
- the ON_ERROR_STOP> variable set to alter that
+ the ON_ERROR_STOP variable set to alter that
behavior and have psql exit with an
exit status of 3 if an SQL error occurs:
@@ -147,8 +147,8 @@ psql --set ON_ERROR_STOP=on dbname < infile
Alternatively, you can specify that the whole dump should be
restored as a single transaction, so the restore is either fully
completed or fully rolled back. This mode can be specified by
- passing the
-1> or
--single-transaction>
- command-line options to psql>. When using this
+ passing the
-1
or
--single-transaction
+ command-line options to psql. When using this
mode, be aware that even a minor error can rollback a
restore that has already run for many hours. However, that might
still be preferable to manually cleaning up a complex database
@@ -156,22 +156,22 @@ psql --set ON_ERROR_STOP=on dbname < infile
- The ability of pg_dump> and psql> to
+ The ability of pg_dump and psql to
write to or read from pipes makes it possible to dump a database
directly from one server to another, for example:
-pg_dump -h host1> dbname> | psql -h host2> dbname>
+pg_dump -h host1dbname | psql -h host2dbname
- The dumps produced by pg_dump> are relative to
- template0>. This means that any languages, procedures,
- etc. added via template1> will also be dumped by
- pg_dump>. As a result, when restoring, if you are
- using a customized template1>, you must create the
- empty database from template0>, as in the example
+ The dumps produced by pg_dump are relative to
+ template0. This means that any languages, procedures,
+ etc. added via template1 will also be dumped by
+ pg_dump. As a result, when restoring, if you are
+ using a customized template1, you must create the
+ empty database from template0, as in the example
above.
@@ -183,52 +183,52 @@ pg_dump -h host1> dbname> | psql -h h
see
and for more information.
For more advice on how to load large amounts of data
- into PostgreSQL> efficiently, refer to PostgreSQL efficiently, refer to .
- Using pg_dumpall>
+ Using pg_dumpall
- pg_dump> dumps only a single database at a time,
+ pg_dump dumps only a single database at a time,
and it does not dump information about roles or tablespaces
(because those are cluster-wide rather than per-database).
To support convenient dumping of the entire contents of a database
cluster, the program is provided.
- pg_dumpall> backs up each database in a given
+ pg_dumpall backs up each database in a given
cluster, and also preserves cluster-wide data such as role and
tablespace definitions. The basic usage of this command is:
-pg_dumpall > outfile>
+pg_dumpall > outfile
- The resulting dump can be restored with psql>:
+ The resulting dump can be restored with psql:
psql -f infile postgres
(Actually, you can specify any existing database name to start from,
- but if you are loading into an empty cluster then postgres>
+ but if you are loading into an empty cluster then postgres
should usually be used.) It is always necessary to have
- database superuser access when restoring a pg_dumpall>
+ database superuser access when restoring a pg_dumpall
dump, as that is required to restore the role and tablespace information.
If you use tablespaces, make sure that the tablespace paths in the
dump are appropriate for the new installation.
- pg_dumpall> works by emitting commands to re-create
+ pg_dumpall works by emitting commands to re-create
roles, tablespaces, and empty databases, then invoking
- pg_dump> for each database. This means that while
+ pg_dump for each database. This means that while
each database will be internally consistent, the snapshots of
different databases are not synchronized.
Cluster-wide data can be dumped alone using the
- pg_dumpall>
--globals-only> option.
+ pg_dumpall
--globals-only
option.
This is necessary to fully backup the cluster if running the
- pg_dump> command on individual databases.
+ pg_dump command on individual databases.
@@ -237,8 +237,8 @@ psql -f infile postgres
Some operating systems have maximum file size limits that cause
- problems when creating large pg_dump> output files.
- Fortunately, pg_dump> can write to the standard
+ problems when creating large pg_dump output files.
+ Fortunately, pg_dump can write to the standard
output, so you can use standard Unix tools to work around this
potential problem. There are several possible methods:
@@ -268,7 +268,7 @@ cat filename.gz | gunzip | psql
- Use split>.
+ Use split.
The split command
allows you to split the output into smaller files that are
@@ -288,10 +288,10 @@ cat filename* | psql
- Use pg_dump>'s custom dump format.
+ Use pg_dump's custom dump format.
If PostgreSQL was built on a system with the
- zlib> compression library installed, the custom dump
+ zlib compression library installed, the custom dump
format will compress data as it writes it to the output file. This will
produce dump file sizes similar to using gzip, but it
has the added advantage that tables can be restored selectively. The
@@ -301,8 +301,8 @@ cat filename* | psql dbname > filename
- A custom-format dump is not a script for psql>, but
- instead must be restored with pg_restore>, for example:
+ A custom-format dump is not a script for psql, but
+ instead must be restored with pg_restore, for example:
pg_restore -d dbnamefilename
@@ -314,12 +314,12 @@ pg_restore -d dbname
- For very large databases, you might need to combine split>
+ For very large databases, you might need to combine split
with one of the other two approaches.
- Use pg_dump>'s parallel dump feature.
+ Use pg_dump's parallel dump feature.
To speed up the dump of a large database, you can use
pg_dump's parallel mode. This will dump
@@ -344,7 +344,7 @@ pg_dump -j num -F d -f
An alternative backup strategy is to directly copy the files that
- PostgreSQL> uses to store the data in the database;
+ PostgreSQL uses to store the data in the database;
explains where these files
are located. You can use whatever method you prefer
for doing file system backups; for example:
@@ -356,13 +356,13 @@ tar -cf backup.tar /usr/local/pgsql/data
There are two restrictions, however, which make this method
- impractical, or at least inferior to the pg_dump>
+ impractical, or at least inferior to the pg_dump
method:
- The database server must> be shut down in order to
+ The database server must be shut down in order to
get a usable backup. Half-way measures such as disallowing all
connections will not work
(in part because tar and similar tools do not take
@@ -379,7 +379,7 @@ tar -cf backup.tar /usr/local/pgsql/data
If you have dug into the details of the file system layout of the
database, you might be tempted to try to back up or restore only certain
individual tables or databases from their respective files or
- directories. This will not> work because the
+ directories. This will not work because the
information contained in these files is not usable without
the commit log files,
pg_xact/*, which contain the commit status of
@@ -399,7 +399,7 @@ tar -cf backup.tar /usr/local/pgsql/data
consistent snapshot of the data directory, if the
file system supports that functionality (and you are willing to
trust that it is implemented correctly). The typical procedure is
- to make a frozen snapshot> of the volume containing the
+ to make a frozen snapshot of the volume containing the
database, then copy the whole data directory (not just parts, see
above) from the snapshot to a backup device, then release the frozen
snapshot. This will work even while the database server is running.
@@ -419,7 +419,7 @@ tar -cf backup.tar /usr/local/pgsql/data
the volumes. For example, if your data files and WAL log are on different
disks, or if tablespaces are on different file systems, it might
not be possible to use snapshot backup because the snapshots
- must> be simultaneous.
+ must be simultaneous.
Read your file system documentation very carefully before trusting
the consistent-snapshot technique in such situations.
@@ -435,13 +435,13 @@ tar -cf backup.tar /usr/local/pgsql/data
- Another option is to use rsync> to perform a file
- system backup. This is done by first running rsync>
+ Another option is to use rsync to perform a file
+ system backup. This is done by first running rsync
while the database server is running, then shutting down the database
- server long enough to do an rsync --checksum>.
- (
--checksum> is necessary because rsync> only
+ server long enough to do an rsync --checksum.
+ (
--checksum
is necessary because rsync only
has file modification-time granularity of one second.) The
- second rsync> will be quicker than the first,
+ second rsync will be quicker than the first,
because it has relatively little data to transfer, and the end result
will be consistent because the server was down. This method
allows a file system backup to be performed with minimal downtime.
@@ -471,12 +471,12 @@ tar -cf backup.tar /usr/local/pgsql/data
- At all times, PostgreSQL> maintains a
- write ahead log> (WAL) in the pg_wal/>
+ At all times, PostgreSQL maintains a
+ write ahead log (WAL) in the pg_wal/
subdirectory of the cluster's data directory. The log records
every change made to the database's data files. This log exists
primarily for crash-safety purposes: if the system crashes, the
- database can be restored to consistency by replaying> the
+ database can be restored to consistency by replaying the
log entries made since the last checkpoint. However, the existence
of the log makes it possible to use a third strategy for backing up
databases: we can combine a file-system-level backup with backup of
@@ -492,7 +492,7 @@ tar -cf backup.tar /usr/local/pgsql/data
Any internal inconsistency in the backup will be corrected by log
replay (this is not significantly different from what happens during
crash recovery). So we do not need a file system snapshot capability,
- just tar> or a similar archiving tool.
+ just tar or a similar archiving tool.
@@ -508,7 +508,7 @@ tar -cf backup.tar /usr/local/pgsql/data
It is not necessary to replay the WAL entries all the
way to the end. We could stop the replay at any point and have a
consistent snapshot of the database as it was at that time. Thus,
- this technique supports point-in-time recovery>: it is
+ this technique supports point-in-time recovery: it is
possible to restore the database to its state at any time since your base
backup was taken.
@@ -517,7 +517,7 @@ tar -cf backup.tar /usr/local/pgsql/data
If we continuously feed the series of WAL files to another
machine that has been loaded with the same base backup file, we
- have a warm standby> system: at any point we can bring up
+ have a warm standby system: at any point we can bring up
the second machine and it will have a nearly-current copy of the
database.
@@ -530,7 +530,7 @@ tar -cf backup.tar /usr/local/pgsql/data
pg_dump and
pg_dumpall do not produce file-system-level
backups and cannot be used as part of a continuous-archiving solution.
- Such dumps are logical> and do not contain enough
+ Such dumps are logical and do not contain enough
information to be used by WAL replay.
@@ -546,10 +546,10 @@ tar -cf backup.tar /usr/local/pgsql/data
To recover successfully using continuous archiving (also called
- online backup> by many database vendors), you need a continuous
+ online backup by many database vendors), you need a continuous
sequence of archived WAL files that extends back at least as far as the
start time of your backup. So to get started, you should set up and test
- your procedure for archiving WAL files before> you take your
+ your procedure for archiving WAL files before you take your
first base backup. Accordingly, we first discuss the mechanics of
archiving WAL files.
@@ -558,15 +558,15 @@ tar -cf backup.tar /usr/local/pgsql/data
Setting Up WAL Archiving
- In an abstract sense, a running PostgreSQL> system
+ In an abstract sense, a running PostgreSQL system
produces an indefinitely long sequence of WAL records. The system
physically divides this sequence into WAL segment
- files>, which are normally 16MB apiece (although the segment size
- can be altered during initdb>). The segment
+ files, which are normally 16MB apiece (although the segment size
+ can be altered during initdb). The segment
files are given numeric names that reflect their position in the
abstract WAL sequence. When not using WAL archiving, the system
normally creates just a few segment files and then
- recycles> them by renaming no-longer-needed segment files
+ recycles them by renaming no-longer-needed segment files
to higher segment numbers. It's assumed that segment files whose
contents precede the checkpoint-before-last are no longer of
interest and can be recycled.
@@ -577,33 +577,33 @@ tar -cf backup.tar /usr/local/pgsql/data
file once it is filled, and save that data somewhere before the segment
file is recycled for reuse. Depending on the application and the
available hardware, there could be many different ways of saving
- the data somewhere>: we could copy the segment files to an NFS-mounted
+ the data somewhere: we could copy the segment files to an NFS-mounted
directory on another machine, write them onto a tape drive (ensuring that
you have a way of identifying the original name of each file), or batch
them together and burn them onto CDs, or something else entirely. To
provide the database administrator with flexibility,
- PostgreSQL> tries not to make any assumptions about how
- the archiving will be done. Instead, PostgreSQL> lets
+ PostgreSQL tries not to make any assumptions about how
+ the archiving will be done. Instead, PostgreSQL lets
the administrator specify a shell command to be executed to copy a
completed segment file to wherever it needs to go. The command could be
- as simple as a cp>, or it could invoke a complex shell
+ as simple as a cp, or it could invoke a complex shell
script — it's all up to you.
To enable WAL archiving, set the
- configuration parameter to replica> or higher,
- to on>,
+ configuration parameter to replica or higher,
+ to on,
and specify the shell command to use in the configuration parameter. In practice
these settings will always be placed in the
postgresql.conf file.
- In archive_command>,
- %p> is replaced by the path name of the file to
- archive, while %f> is replaced by only the file name.
+ In archive_command,
+ %p is replaced by the path name of the file to
+ archive, while %f is replaced by only the file name.
(The path name is relative to the current working directory,
i.e., the cluster's data directory.)
- Use %%> if you need to embed an actual %>
+ Use %% if you need to embed an actual %
character in the command. The simplest useful command is something
like:
@@ -611,9 +611,9 @@ archive_command = 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/ser
archive_command = 'copy "%p" "C:\\server\\archivedir\\%f"' # Windows
which will copy archivable WAL segments to the directory
- /mnt/server/archivedir>. (This is an example, not a
+ /mnt/server/archivedir. (This is an example, not a
recommendation, and might not work on all platforms.) After the
- %p> and %f> parameters have been replaced,
+ %p and %f parameters have been replaced,
the actual command executed might look like this:
test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/00000001000000A900000065 /mnt/server/archivedir/00000001000000A900000065
@@ -623,7 +623,7 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/0
The archive command will be executed under the ownership of the same
- user that the PostgreSQL> server is running as. Since
+ user that the PostgreSQL server is running as. Since
the series of WAL files being archived contains effectively everything
in your database, you will want to be sure that the archived data is
protected from prying eyes; for example, archive into a directory that
@@ -633,9 +633,9 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/0
It is important that the archive command return zero exit status if and
only if it succeeds. Upon getting a zero result,
- PostgreSQL> will assume that the file has been
+ PostgreSQL will assume that the file has been
successfully archived, and will remove or recycle it. However, a nonzero
- status tells PostgreSQL> that the file was not archived;
+ status tells PostgreSQL that the file was not archived;
it will try again periodically until it succeeds.
@@ -650,14 +650,14 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/0
It is advisable to test your proposed archive command to ensure that it
indeed does not overwrite an existing file, and that it returns
- nonzero status in this case>.
+ nonzero status in this case.
The example command above for Unix ensures this by including a separate
- test> step. On some Unix platforms, cp> has
- switches such as
-i> that can be used to do the same thing
+ test step. On some Unix platforms, cp has
+ switches such as
-i
that can be used to do the same thing
less verbosely, but you should not rely on these without verifying that
- the right exit status is returned. (In particular, GNU cp>
- will return status zero when
-i> is used and the target file
- already exists, which is not> the desired behavior.)
+ the right exit status is returned. (In particular, GNU cp
+ will return status zero when
-i
is used and the target file
+ already exists, which is not the desired behavior.)
@@ -668,10 +668,10 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/0
fills, nothing further can be archived until the tape is swapped.
You should ensure that any error condition or request to a human operator
is reported appropriately so that the situation can be
- resolved reasonably quickly. The pg_wal/> directory will
+ resolved reasonably quickly. The pg_wal/ directory will
continue to fill with WAL segment files until the situation is resolved.
- (If the file system containing pg_wal/> fills up,
- PostgreSQL> will do a PANIC shutdown. No committed
+ (If the file system containing pg_wal/ fills up,
+ PostgreSQL will do a PANIC shutdown. No committed
transactions will be lost, but the database will remain offline until
you free some space.)
@@ -682,7 +682,7 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/0
operation continues even if the archiving process falls a little behind.
If archiving falls significantly behind, this will increase the amount of
data that would be lost in the event of a disaster. It will also mean that
- the pg_wal/> directory will contain large numbers of
+ the pg_wal/ directory will contain large numbers of
not-yet-archived segment files, which could eventually exceed available
disk space. You are advised to monitor the archiving process to ensure that
it is working as you intend.
@@ -692,16 +692,16 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/0
In writing your archive command, you should assume that the file names to
be archived can be up to 64 characters long and can contain any
combination of ASCII letters, digits, and dots. It is not necessary to
- preserve the original relative path (%p>) but it is necessary to
- preserve the file name (%f>).
+ preserve the original relative path (%p) but it is necessary to
+ preserve the file name (%f).
Note that although WAL archiving will allow you to restore any
- modifications made to the data in your PostgreSQL> database,
+ modifications made to the data in your PostgreSQL database,
it will not restore changes made to configuration files (that is,
- postgresql.conf>, pg_hba.conf> and
- pg_ident.conf>), since those are edited manually rather
+ postgresql.conf, pg_hba.conf and
+ pg_ident.conf), since those are edited manually rather
than through SQL operations.
You might wish to keep the configuration files in a location that will
be backed up by your regular file system backup procedures. See
@@ -719,32 +719,32 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/0
to a new WAL segment file at least that often. Note that archived
files that are archived early due to a forced switch are still the same
length as completely full files. It is therefore unwise to set a very
- short archive_timeout> — it will bloat your archive
- storage. archive_timeout> settings of a minute or so are
+ short archive_timeout — it will bloat your archive
+ storage. archive_timeout settings of a minute or so are
usually reasonable.
Also, you can force a segment switch manually with
- pg_switch_wal> if you want to ensure that a
+ pg_switch_wal if you want to ensure that a
just-finished transaction is archived as soon as possible. Other utility
functions related to WAL management are listed in .
- When wal_level> is minimal> some SQL commands
+ When wal_level is minimal some SQL commands
are optimized to avoid WAL logging, as described in . If archiving or streaming replication were
turned on during execution of one of these statements, WAL would not
contain enough information for archive recovery. (Crash recovery is
- unaffected.) For this reason, wal_level> can only be changed at
- server start. However, archive_command> can be changed with a
+ unaffected.) For this reason, wal_level can only be changed at
+ server start. However, archive_command can be changed with a
configuration file reload. If you wish to temporarily stop archiving,
- one way to do it is to set archive_command> to the empty
- string (''>).
- This will cause WAL files to accumulate in pg_wal/> until a
- working archive_command> is re-established.
+ one way to do it is to set archive_command to the empty
+ string ('').
+ This will cause WAL files to accumulate in pg_wal/ until a
+ working archive_command is re-established.
@@ -763,8 +763,8 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/0
It is not necessary to be concerned about the amount of time it takes
to make a base backup. However, if you normally run the
- server with full_page_writes> disabled, you might notice a drop
- in performance while the backup runs since full_page_writes> is
+ server with full_page_writes disabled, you might notice a drop
+ in performance while the backup runs since full_page_writes is
effectively forced on during backup mode.
@@ -772,13 +772,13 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/0
To make use of the backup, you will need to keep all the WAL
segment files generated during and after the file system backup.
To aid you in doing this, the base backup process
- creates a backup history file> that is immediately
+ creates a backup history file that is immediately
stored into the WAL archive area. This file is named after the first
WAL segment file that you need for the file system backup.
For example, if the starting WAL file is
- 0000000100001234000055CD> the backup history file will be
+ 0000000100001234000055CD the backup history file will be
named something like
- 0000000100001234000055CD.007C9330.backup>. (The second
+ 0000000100001234000055CD.007C9330.backup. (The second
part of the file name stands for an exact position within the WAL
file, and can ordinarily be ignored.) Once you have safely archived
the file system backup and the WAL segment files used during the
@@ -847,14 +847,14 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 && cp pg_wal/0
SELECT pg_start_backup('label', false, false);
- where label> is any string you want to use to uniquely
+ where label is any string you want to use to uniquely
identify this backup operation. The connection
- calling pg_start_backup> must be maintained until the end of
+ calling pg_start_backup must be maintained until the end of
the backup, or the backup will be automatically aborted.
- By default, pg_start_backup> can take a long time to finish.
+ By default, pg_start_backup can take a long time to finish.
This is because it performs a checkpoint, and the I/O
required for the checkpoint will be spread out over a significant
period of time, by default half your inter-checkpoint interval
@@ -862,19 +862,19 @@ SELECT pg_start_backup('label', false, false);
). This is
usually what you want, because it minimizes the impact on query
processing. If you want to start the backup as soon as
- possible, change the second parameter to true>, which will
+ possible, change the second parameter to true, which will
issue an immediate checkpoint using as much I/O as available.
- The third parameter being false> tells
- pg_start_backup> to initiate a non-exclusive base backup.
+ The third parameter being false tells
+ pg_start_backup to initiate a non-exclusive base backup.
Perform the backup, using any convenient file-system-backup tool
- such as tar> or cpio> (not
+ such as tar or cpio (not
pg_dump or
pg_dumpall). It is neither
necessary nor desirable to stop normal operation of the database
@@ -898,45 +898,45 @@ SELECT * FROM pg_stop_backup(false, true);
ready to archive.
- The pg_stop_backup> will return one row with three
+ The pg_stop_backup will return one row with three
values. The second of these fields should be written to a file named
- backup_label> in the root directory of the backup. The
+ backup_label in the root directory of the backup. The
third field should be written to a file named
- tablespace_map> unless the field is empty. These files are
+ tablespace_map unless the field is empty. These files are
vital to the backup working, and must be written without modification.
Once the WAL segment files active during the backup are archived, you are
- done. The file identified by pg_stop_backup>'s first return
+ done. The file identified by pg_stop_backup's first return
value is the last segment that is required to form a complete set of
- backup files. On a primary, if archive_mode> is enabled and the
- wait_for_archive> parameter is true>,
- pg_stop_backup> does not return until the last segment has
+ backup files. On a primary, if archive_mode is enabled and the
+ wait_for_archive parameter is true,
+ pg_stop_backup does not return until the last segment has
been archived.
- On a standby, archive_mode> must be always> in order
- for pg_stop_backup> to wait.
+ On a standby, archive_mode must be always in order
+ for pg_stop_backup to wait.
Archiving of these files happens automatically since you have
- already configured archive_command>. In most cases this
+ already configured archive_command. In most cases this
happens quickly, but you are advised to monitor your archive
system to ensure there are no delays.
If the archive process has fallen behind
because of failures of the archive command, it will keep retrying
until the archive succeeds and the backup is complete.
If you wish to place a time limit on the execution of
- pg_stop_backup>, set an appropriate
+ pg_stop_backup, set an appropriate
statement_timeout value, but make note that if
- pg_stop_backup> terminates because of this your backup
+ pg_stop_backup terminates because of this your backup
may not be valid.
If the backup process monitors and ensures that all WAL segment files
required for the backup are successfully archived then the
- wait_for_archive> parameter (which defaults to true) can be set
+ wait_for_archive parameter (which defaults to true) can be set
to false to have
- pg_stop_backup> return as soon as the stop backup record is
- written to the WAL. By default, pg_stop_backup> will wait
+ pg_stop_backup return as soon as the stop backup record is
+ written to the WAL. By default, pg_stop_backup will wait
until all WAL has been archived, which can take some time. This option
must be used with caution: if WAL archiving is not monitored correctly
then the backup might not include all of the WAL files and will
@@ -952,7 +952,7 @@ SELECT * FROM pg_stop_backup(false, true);
The process for an exclusive backup is mostly the same as for a
non-exclusive one, but it differs in a few key steps. This type of backup
can only be taken on a primary and does not allow concurrent backups.
- Prior to PostgreSQL> 9.6, this
+ Prior to PostgreSQL 9.6, this
was the only low-level method available, but it is now recommended that
all users upgrade their scripts to use non-exclusive backups if possible.
@@ -971,20 +971,20 @@ SELECT * FROM pg_stop_backup(false, true);
SELECT pg_start_backup('label');
- where label> is any string you want to use to uniquely
+ where label is any string you want to use to uniquely
identify this backup operation.
- pg_start_backup> creates a backup label> file,
- called backup_label>, in the cluster directory with
+ pg_start_backup creates a backup label file,
+ called backup_label, in the cluster directory with
information about your backup, including the start time and label string.
- The function also creates a tablespace map> file,
- called tablespace_map>, in the cluster directory with
- information about tablespace symbolic links in pg_tblspc/> if
+ The function also creates a tablespace map file,
+ called tablespace_map, in the cluster directory with
+ information about tablespace symbolic links in pg_tblspc/ if
one or more such link is present. Both files are critical to the
integrity of the backup, should you need to restore from it.
- By default, pg_start_backup> can take a long time to finish.
+ By default, pg_start_backup can take a long time to finish.
This is because it performs a checkpoint, and the I/O
required for the checkpoint will be spread out over a significant
period of time, by default half your inter-checkpoint interval
@@ -1002,7 +1002,7 @@ SELECT pg_start_backup('label', true);
Perform the backup, using any convenient file-system-backup tool
- such as tar> or cpio> (not
+ such as tar or cpio (not
pg_dump or
pg_dumpall). It is neither
necessary nor desirable to stop normal operation of the database
@@ -1012,7 +1012,7 @@ SELECT pg_start_backup('label', true);
Note that if the server crashes during the backup it may not be
- possible to restart until the backup_label> file has been
+ possible to restart until the backup_label file has been
manually deleted from the PGDATA directory.
@@ -1033,22 +1033,22 @@ SELECT pg_stop_backup();
Once the WAL segment files active during the backup are archived, you are
- done. The file identified by pg_stop_backup>'s result is
+ done. The file identified by pg_stop_backup's result is
the last segment that is required to form a complete set of backup files.
- If archive_mode> is enabled,
- pg_stop_backup> does not return until the last segment has
+ If archive_mode is enabled,
+ pg_stop_backup does not return until the last segment has
been archived.
Archiving of these files happens automatically since you have
- already configured archive_command>. In most cases this
+ already configured archive_command. In most cases this
happens quickly, but you are advised to monitor your archive
system to ensure there are no delays.
If the archive process has fallen behind
because of failures of the archive command, it will keep retrying
until the archive succeeds and the backup is complete.
If you wish to place a time limit on the execution of
- pg_stop_backup>, set an appropriate
+ pg_stop_backup, set an appropriate
statement_timeout value, but make note that if
- pg_stop_backup> terminates because of this your backup
+ pg_stop_backup terminates because of this your backup
may not be valid.
@@ -1063,21 +1063,21 @@ SELECT pg_stop_backup();
When taking a base backup of an active database, this situation is normal
and not an error. However, you need to ensure that you can distinguish
complaints of this sort from real errors. For example, some versions
- of rsync> return a separate exit code for
- vanished source files>, and you can write a driver script to
+ of rsync return a separate exit code for
+ vanished source files, and you can write a driver script to
accept this exit code as a non-error case. Also, some versions of
- GNU tar> return an error code indistinguishable from
- a fatal error if a file was truncated while tar> was
- copying it. Fortunately, GNU tar> versions 1.16 and
+ GNU tar return an error code indistinguishable from
+ a fatal error if a file was truncated while tar was
+ copying it. Fortunately, GNU tar versions 1.16 and
later exit with 1 if a file was changed during the backup,
- and 2 for other errors. With GNU tar> version 1.23 and
+ and 2 for other errors. With GNU tar version 1.23 and
later, you can use the warning options --warning=no-file-changed
--warning=no-file-removed to hide the related warning messages.
Be certain that your backup includes all of the files under
- the database cluster directory (e.g., /usr/local/pgsql/data>).
+ the database cluster directory (e.g., /usr/local/pgsql/data).
If you are using tablespaces that do not reside underneath this directory,
be careful to include them as well (and be sure that your backup
archives symbolic links as links, otherwise the restore will corrupt
@@ -1086,21 +1086,21 @@ SELECT pg_stop_backup();
You should, however, omit from the backup the files within the
- cluster's pg_wal/> subdirectory. This
+ cluster's pg_wal/ subdirectory. This
slight adjustment is worthwhile because it reduces the risk
of mistakes when restoring. This is easy to arrange if
- pg_wal/> is a symbolic link pointing to someplace outside
+ pg_wal/ is a symbolic link pointing to someplace outside
the cluster directory, which is a common setup anyway for performance
- reasons. You might also want to exclude postmaster.pid>
- and postmaster.opts>, which record information
- about the running postmaster>, not about the
- postmaster> which will eventually use this backup.
- (These files can confuse pg_ctl>.)
+ reasons. You might also want to exclude postmaster.pid
+ and postmaster.opts, which record information
+ about the running postmaster, not about the
+ postmaster which will eventually use this backup.
+ (These files can confuse pg_ctl.)
It is often a good idea to also omit from the backup the files
- within the cluster's pg_replslot/> directory, so that
+ within the cluster's pg_replslot/ directory, so that
replication slots that exist on the master do not become part of the
backup. Otherwise, the subsequent use of the backup to create a standby
may result in indefinite retention of WAL files on the standby, and
@@ -1114,10 +1114,10 @@ SELECT pg_stop_backup();
- The contents of the directories pg_dynshmem/>,
- pg_notify/>, pg_serial/>,
- pg_snapshots/>, pg_stat_tmp/>,
- and pg_subtrans/> (but not the directories themselves) can be
+ The contents of the directories pg_dynshmem/,
+ pg_notify/, pg_serial/,
+ pg_snapshots/, pg_stat_tmp/,
+ and pg_subtrans/ (but not the directories themselves) can be
omitted from the backup as they will be initialized on postmaster startup.
If is set and is under the data
directory then the contents of that directory can also be omitted.
@@ -1131,13 +1131,13 @@ SELECT pg_stop_backup();
The backup label
- file includes the label string you gave to pg_start_backup>,
- as well as the time at which pg_start_backup> was run, and
+ file includes the label string you gave to pg_start_backup,
+ as well as the time at which pg_start_backup was run, and
the name of the starting WAL file. In case of confusion it is therefore
possible to look inside a backup file and determine exactly which
backup session the dump file came from. The tablespace map file includes
the symbolic link names as they exist in the directory
- pg_tblspc/> and the full path of each symbolic link.
+ pg_tblspc/ and the full path of each symbolic link.
These files are not merely for your information; their presence and
contents are critical to the proper operation of the system's recovery
process.
@@ -1146,7 +1146,7 @@ SELECT pg_stop_backup();
It is also possible to make a backup while the server is
stopped. In this case, you obviously cannot use
- pg_start_backup> or pg_stop_backup>, and
+ pg_start_backup or pg_stop_backup, and
you will therefore be left to your own devices to keep track of which
backup is which and how far back the associated WAL files go.
It is generally better to follow the continuous archiving procedure above.
@@ -1173,7 +1173,7 @@ SELECT pg_stop_backup();
location in case you need them later. Note that this precaution will
require that you have enough free space on your system to hold two
copies of your existing database. If you do not have enough space,
- you should at least save the contents of the cluster's pg_wal>
+ you should at least save the contents of the cluster's pg_wal
subdirectory, as it might contain logs which
were not archived before the system went down.
@@ -1188,17 +1188,17 @@ SELECT pg_stop_backup();
Restore the database files from your file system backup. Be sure that they
are restored with the right ownership (the database system user, not
- root>!) and with the right permissions. If you are using
+ root!) and with the right permissions. If you are using
tablespaces,
- you should verify that the symbolic links in pg_tblspc/>
+ you should verify that the symbolic links in pg_tblspc/
were correctly restored.
- Remove any files present in pg_wal/>; these came from the
+ Remove any files present in pg_wal/; these came from the
file system backup and are therefore probably obsolete rather than current.
- If you didn't archive pg_wal/> at all, then recreate
+ If you didn't archive pg_wal/ at all, then recreate
it with proper permissions,
being careful to ensure that you re-establish it as a symbolic link
if you had it set up that way before.
@@ -1207,16 +1207,16 @@ SELECT pg_stop_backup();
If you have unarchived WAL segment files that you saved in step 2,
- copy them into pg_wal/>. (It is best to copy them,
+ copy them into pg_wal/. (It is best to copy them,
not move them, so you still have the unmodified files if a
problem occurs and you have to start over.)
- Create a recovery command file recovery.conf> in the cluster
+ Create a recovery command file recovery.conf in the cluster
data directory (see ). You might
- also want to temporarily modify pg_hba.conf> to prevent
+ also want to temporarily modify pg_hba.conf to prevent
ordinary users from connecting until you are sure the recovery was successful.
@@ -1227,7 +1227,7 @@ SELECT pg_stop_backup();
recovery be terminated because of an external error, the server can
simply be restarted and it will continue recovery. Upon completion
of the recovery process, the server will rename
- recovery.conf> to recovery.done> (to prevent
+ recovery.conf to recovery.done (to prevent
accidentally re-entering recovery mode later) and then
commence normal database operations.
@@ -1236,7 +1236,7 @@ SELECT pg_stop_backup();
Inspect the contents of the database to ensure you have recovered to
the desired state. If not, return to step 1. If all is well,
- allow your users to connect by restoring pg_hba.conf> to normal.
+ allow your users to connect by restoring pg_hba.conf to normal.
@@ -1245,32 +1245,32 @@ SELECT pg_stop_backup();
The key part of all this is to set up a recovery configuration file that
describes how you want to recover and how far the recovery should
- run. You can use recovery.conf.sample> (normally
- located in the installation's share/> directory) as a
+ run. You can use recovery.conf.sample (normally
+ located in the installation's share/ directory) as a
prototype. The one thing that you absolutely must specify in
- recovery.conf> is the restore_command>,
- which tells PostgreSQL> how to retrieve archived
- WAL file segments. Like the archive_command>, this is
- a shell command string. It can contain %f>, which is
- replaced by the name of the desired log file, and %p>,
+ recovery.conf is the restore_command,
+ which tells PostgreSQL how to retrieve archived
+ WAL file segments. Like the archive_command, this is
+ a shell command string. It can contain %f, which is
+ replaced by the name of the desired log file, and %p,
which is replaced by the path name to copy the log file to.
(The path name is relative to the current working directory,
i.e., the cluster's data directory.)
- Write %%> if you need to embed an actual %>
+ Write %% if you need to embed an actual %
character in the command. The simplest useful command is
something like:
restore_command = 'cp /mnt/server/archivedir/%f %p'
which will copy previously archived WAL segments from the directory
- /mnt/server/archivedir>. Of course, you can use something
+ /mnt/server/archivedir. Of course, you can use something
much more complicated, perhaps even a shell script that requests the
operator to mount an appropriate tape.
It is important that the command return nonzero exit status on failure.
- The command will> be called requesting files that are not
+ The command will be called requesting files that are not
present in the archive; it must return nonzero when so asked. This is not
an error condition. An exception is that if the command was terminated by
a signal (other than SIGTERM, which is used as
@@ -1282,27 +1282,27 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
Not all of the requested files will be WAL segment
files; you should also expect requests for files with a suffix of
- .backup> or .history>. Also be aware that
- the base name of the %p> path will be different from
- %f>; do not expect them to be interchangeable.
+ .backup or .history. Also be aware that
+ the base name of the %p path will be different from
+ %f; do not expect them to be interchangeable.
WAL segments that cannot be found in the archive will be sought in
- pg_wal/>; this allows use of recent un-archived segments.
+ pg_wal/; this allows use of recent un-archived segments.
However, segments that are available from the archive will be used in
- preference to files in pg_wal/>.
+ preference to files in pg_wal/.
Normally, recovery will proceed through all available WAL segments,
thereby restoring the database to the current point in time (or as
close as possible given the available WAL segments). Therefore, a normal
- recovery will end with a file not found> message, the exact text
+ recovery will end with a file not found message, the exact text
of the error message depending upon your choice of
- restore_command>. You may also see an error message
+ restore_command. You may also see an error message
at the start of recovery for a file named something like
- 00000001.history>. This is also normal and does not
+ 00000001.history. This is also normal and does not
indicate a problem in simple recovery situations; see
for discussion.
@@ -1310,8 +1310,8 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
If you want to recover to some previous point in time (say, right before
the junior DBA dropped your main transaction table), just specify the
- required stopping point in recovery.conf>. You can specify
- the stop point, known as the recovery target>, either by
+ required stopping point in recovery.conf. You can specify
+ the stop point, known as the recovery target, either by
date/time, named restore point or by completion of a specific transaction
ID. As of this writing only the date/time and named restore point options
are very usable, since there are no tools to help you identify with any
@@ -1321,7 +1321,7 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
The stop point must be after the ending time of the base backup, i.e.,
- the end time of pg_stop_backup>. You cannot use a base backup
+ the end time of pg_stop_backup. You cannot use a base backup
to recover to a time when that backup was in progress. (To
recover to such a time, you must go back to your previous base backup
and roll forward from there.)
@@ -1332,14 +1332,14 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
If recovery finds corrupted WAL data, recovery will
halt at that point and the server will not start. In such a case the
recovery process could be re-run from the beginning, specifying a
- recovery target> before the point of corruption so that recovery
+ recovery target before the point of corruption so that recovery
can complete normally.
If recovery fails for an external reason, such as a system crash or
if the WAL archive has become inaccessible, then the recovery can simply
be restarted and it will restart almost from where it failed.
Recovery restart works much like checkpointing in normal operation:
the server periodically forces all its state to disk, and then updates
- the pg_control> file to indicate that the already-processed
+ the pg_control file to indicate that the already-processed
WAL data need not be scanned again.
@@ -1359,7 +1359,7 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
suppose you dropped a critical table at 5:15PM on Tuesday evening, but
didn't realize your mistake until Wednesday noon.
Unfazed, you get out your backup, restore to the point-in-time 5:14PM
- Tuesday evening, and are up and running. In this> history of
+ Tuesday evening, and are up and running. In this history of
the database universe, you never dropped the table. But suppose
you later realize this wasn't such a great idea, and would like
to return to sometime Wednesday morning in the original history.
@@ -1372,8 +1372,8 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
- To deal with this problem, PostgreSQL> has a notion
- of timelines>. Whenever an archive recovery completes,
+ To deal with this problem, PostgreSQL has a notion
+ of timelines. Whenever an archive recovery completes,
a new timeline is created to identify the series of WAL records
generated after that recovery. The timeline
ID number is part of WAL segment file names so a new timeline does
@@ -1384,13 +1384,13 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
and so have to do several point-in-time recoveries by trial and error
until you find the best place to branch off from the old history. Without
timelines this process would soon generate an unmanageable mess. With
- timelines, you can recover to any> prior state, including
+ timelines, you can recover to any prior state, including
states in timeline branches that you abandoned earlier.
- Every time a new timeline is created, PostgreSQL> creates
- a timeline history> file that shows which timeline it branched
+ Every time a new timeline is created, PostgreSQL creates
+ a timeline history file that shows which timeline it branched
off from and when. These history files are necessary to allow the system
to pick the right WAL segment files when recovering from an archive that
contains multiple timelines. Therefore, they are archived into the WAL
@@ -1408,7 +1408,7 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
that was current when the base backup was taken. If you wish to recover
into some child timeline (that is, you want to return to some state that
was itself generated after a recovery attempt), you need to specify the
- target timeline ID in recovery.conf>. You cannot recover into
+ target timeline ID in recovery.conf. You cannot recover into
timelines that branched off earlier than the base backup.
@@ -1424,18 +1424,18 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
Standalone Hot Backups
- It is possible to use PostgreSQL>'s backup facilities to
+ It is possible to use PostgreSQL's backup facilities to
produce standalone hot backups. These are backups that cannot be used
for point-in-time recovery, yet are typically much faster to backup and
- restore than pg_dump> dumps. (They are also much larger
- than pg_dump> dumps, so in some cases the speed advantage
+ restore than pg_dump dumps. (They are also much larger
+ than pg_dump dumps, so in some cases the speed advantage
might be negated.)
As with base backups, the easiest way to produce a standalone
hot backup is to use the
- tool. If you include the -X> parameter when calling
+ tool. If you include the -X parameter when calling
it, all the write-ahead log required to use the backup will be
included in the backup automatically, and no special action is
required to restore the backup.
@@ -1445,16 +1445,16 @@ restore_command = 'cp /mnt/server/archivedir/%f %p'
If more flexibility in copying the backup files is needed, a lower
level process can be used for standalone hot backups as well.
To prepare for low level standalone hot backups, make sure
- wal_level> is set to
- replica> or higher, archive_mode> to
- on>, and set up an archive_command> that performs
- archiving only when a switch file> exists. For example:
+ wal_level is set to
+ replica or higher, archive_mode to
+ on, and set up an archive_command that performs
+ archiving only when a switch file exists. For example:
archive_command = 'test ! -f /var/lib/pgsql/backup_in_progress || (test ! -f /var/lib/pgsql/archive/%f && cp %p /var/lib/pgsql/archive/%f)'
This command will perform archiving when
- /var/lib/pgsql/backup_in_progress> exists, and otherwise
- silently return zero exit status (allowing PostgreSQL>
+ /var/lib/pgsql/backup_in_progress exists, and otherwise
+ silently return zero exit status (allowing PostgreSQL
to recycle the unwanted WAL file).
@@ -1469,11 +1469,11 @@ psql -c "select pg_stop_backup();"
rm /var/lib/pgsql/backup_in_progress
tar -rf /var/lib/pgsql/backup.tar /var/lib/pgsql/archive/
- The switch file /var/lib/pgsql/backup_in_progress> is
+ The switch file /var/lib/pgsql/backup_in_progress is
created first, enabling archiving of completed WAL files to occur.
After the backup the switch file is removed. Archived WAL files are
then added to the backup so that both base backup and all required
- WAL files are part of the same tar> file.
+ WAL files are part of the same tar file.
Please remember to add error handling to your backup scripts.
@@ -1488,7 +1488,7 @@ tar -rf /var/lib/pgsql/backup.tar /var/lib/pgsql/archive/
archive_command = 'gzip < %p > /var/lib/pgsql/archive/%f'
- You will then need to use gunzip> during recovery:
+ You will then need to use gunzip during recovery:
restore_command = 'gunzip < /mnt/server/archivedir/%f > %p'
@@ -1501,7 +1501,7 @@ restore_command = 'gunzip < /mnt/server/archivedir/%f > %p'
Many people choose to use scripts to define their
archive_command, so that their
- postgresql.conf> entry looks very simple:
+ postgresql.conf entry looks very simple:
archive_command = 'local_backup_script.sh "%p" "%f"'
@@ -1509,7 +1509,7 @@ archive_command = 'local_backup_script.sh "%p" "%f"'
more than a single command in the archiving process.
This allows all complexity to be managed within the script, which
can be written in a popular scripting language such as
- bash> or perl>.
+ bash or perl.
@@ -1543,7 +1543,7 @@ archive_command = 'local_backup_script.sh "%p" "%f"'
When using an archive_command script, it's desirable
to enable .
- Any messages written to stderr> from the script will then
+ Any messages written to stderr from the script will then
appear in the database server log, allowing complex configurations to
be diagnosed easily if they fail.
@@ -1563,7 +1563,7 @@ archive_command = 'local_backup_script.sh "%p" "%f"'
If a
command is executed while a base backup is being taken, and then
- the template database that the CREATE DATABASE> copied
+ the template database that the CREATE DATABASE copied
is modified while the base backup is still in progress, it is
possible that recovery will cause those modifications to be
propagated into the created database as well. This is of course
@@ -1602,7 +1602,7 @@ archive_command = 'local_backup_script.sh "%p" "%f"'
before you do so.) Turning off page snapshots does not prevent
use of the logs for PITR operations. An area for future
development is to compress archived WAL data by removing
- unnecessary page copies even when full_page_writes> is
+ unnecessary page copies even when full_page_writes is
on. In the meantime, administrators might wish to reduce the number
of page snapshots included in WAL by increasing the checkpoint
interval parameters as much as feasible.
diff --git a/doc/src/sgml/bgworker.sgml b/doc/src/sgml/bgworker.sgml
index ea1b5c0c8e3..0b092f6e492 100644
--- a/doc/src/sgml/bgworker.sgml
+++ b/doc/src/sgml/bgworker.sgml
@@ -11,17 +11,17 @@
PostgreSQL can be extended to run user-supplied code in separate processes.
Such processes are started, stopped and monitored by postgres,
which permits them to have a lifetime closely linked to the server's status.
- These processes have the option to attach to PostgreSQL>'s
+ These processes have the option to attach to PostgreSQL's
shared memory area and to connect to databases internally; they can also run
multiple transactions serially, just like a regular client-connected server
- process. Also, by linking to libpq> they can connect to the
+ process. Also, by linking to libpq they can connect to the
server and behave like a regular client application.
There are considerable robustness and security risks in using background
- worker processes because, being written in the C> language,
+ worker processes because, being written in the C language,
they have unrestricted access to data. Administrators wishing to enable
modules that include background worker process should exercise extreme
caution. Only carefully audited modules should be permitted to run
@@ -31,15 +31,15 @@
Background workers can be initialized at the time that
- PostgreSQL> is started by including the module name in
- shared_preload_libraries>. A module wishing to run a background
+ PostgreSQL is started by including the module name in
+ shared_preload_libraries. A module wishing to run a background
worker can register it by calling
RegisterBackgroundWorker(BackgroundWorker *worker)
- from its _PG_init()>. Background workers can also be started
+ from its _PG_init(). Background workers can also be started
after the system is up and running by calling the function
RegisterDynamicBackgroundWorker(BackgroundWorker
*worker, BackgroundWorkerHandle **handle). Unlike
- RegisterBackgroundWorker>, which can only be called from within
+ RegisterBackgroundWorker, which can only be called from within
the postmaster, RegisterDynamicBackgroundWorker must be
called from a regular backend.
@@ -65,7 +65,7 @@ typedef struct BackgroundWorker
- bgw_name> and bgw_type are
+ bgw_name and bgw_type are
strings to be used in log messages, process listings and similar contexts.
bgw_type should be the same for all background
workers of the same type, so that it is possible to group such workers in a
@@ -76,7 +76,7 @@ typedef struct BackgroundWorker
- bgw_flags> is a bitwise-or'd bit mask indicating the
+ bgw_flags is a bitwise-or'd bit mask indicating the
capabilities that the module wants. Possible values are:
@@ -114,14 +114,14 @@ typedef struct BackgroundWorker
bgw_start_time is the server state during which
- postgres> should start the process; it can be one of
- BgWorkerStart_PostmasterStart> (start as soon as
- postgres> itself has finished its own initialization; processes
+ postgres should start the process; it can be one of
+ BgWorkerStart_PostmasterStart (start as soon as
+ postgres itself has finished its own initialization; processes
requesting this are not eligible for database connections),
- BgWorkerStart_ConsistentState> (start as soon as a consistent state
+ BgWorkerStart_ConsistentState (start as soon as a consistent state
has been reached in a hot standby, allowing processes to connect to
databases and run read-only queries), and
- BgWorkerStart_RecoveryFinished> (start as soon as the system has
+ BgWorkerStart_RecoveryFinished (start as soon as the system has
entered normal read-write state). Note the last two values are equivalent
in a server that's not a hot standby. Note that this setting only indicates
when the processes are to be started; they do not stop when a different state
@@ -152,9 +152,9 @@ typedef struct BackgroundWorker
- bgw_main_arg is the Datum> argument
+ bgw_main_arg is the Datum argument
to the background worker main function. This main function should take a
- single argument of type Datum> and return void>.
+ single argument of type Datum and return void.
bgw_main_arg will be passed as the argument.
In addition, the global variable MyBgworkerEntry
points to a copy of the BackgroundWorker structure
@@ -165,39 +165,39 @@ typedef struct BackgroundWorker
On Windows (and anywhere else where EXEC_BACKEND is
defined) or in dynamic background workers it is not safe to pass a
- Datum> by reference, only by value. If an argument is required, it
+ Datum by reference, only by value. If an argument is required, it
is safest to pass an int32 or other small value and use that as an index
- into an array allocated in shared memory. If a value like a cstring>
+ into an array allocated in shared memory. If a value like a cstring
or text is passed then the pointer won't be valid from the
new background worker process.
bgw_extra can contain extra data to be passed
- to the background worker. Unlike bgw_main_arg>, this data
+ to the background worker. Unlike bgw_main_arg, this data
is not passed as an argument to the worker's main function, but it can be
accessed via MyBgworkerEntry, as discussed above.
bgw_notify_pid is the PID of a PostgreSQL
- backend process to which the postmaster should send SIGUSR1>
+ backend process to which the postmaster should send SIGUSR1
when the process is started or exits. It should be 0 for workers registered
at postmaster startup time, or when the backend registering the worker does
not wish to wait for the worker to start up. Otherwise, it should be
- initialized to MyProcPid>.
+ initialized to MyProcPid.
Once running, the process can connect to a database by calling
BackgroundWorkerInitializeConnection(char *dbname, char *username) or
BackgroundWorkerInitializeConnectionByOid(Oid dboid, Oid useroid).
This allows the process to run transactions and queries using the
- SPI interface. If dbname> is NULL or
- dboid> is InvalidOid>, the session is not connected
+ SPI interface. If dbname is NULL or
+ dboid is InvalidOid, the session is not connected
to any particular database, but shared catalogs can be accessed.
- If username> is NULL or useroid> is
- InvalidOid>, the process will run as the superuser created
- during initdb>.
+ If username is NULL or useroid is
+ InvalidOid, the process will run as the superuser created
+ during initdb.
A background worker can only call one of these two functions, and only
once. It is not possible to switch databases.
@@ -207,24 +207,24 @@ typedef struct BackgroundWorker
background worker's main function, and must be unblocked by it; this is to
allow the process to customize its signal handlers, if necessary.
Signals can be unblocked in the new process by calling
- BackgroundWorkerUnblockSignals> and blocked by calling
- BackgroundWorkerBlockSignals>.
+ BackgroundWorkerUnblockSignals and blocked by calling
+ BackgroundWorkerBlockSignals.
If bgw_restart_time for a background worker is
- configured as BGW_NEVER_RESTART>, or if it exits with an exit
- code of 0 or is terminated by TerminateBackgroundWorker>,
+ configured as BGW_NEVER_RESTART, or if it exits with an exit
+ code of 0 or is terminated by TerminateBackgroundWorker,
it will be automatically unregistered by the postmaster on exit.
Otherwise, it will be restarted after the time period configured via
- bgw_restart_time>, or immediately if the postmaster
+ bgw_restart_time, or immediately if the postmaster
reinitializes the cluster due to a backend failure. Backends which need
to suspend execution only temporarily should use an interruptible sleep
rather than exiting; this can be achieved by calling
WaitLatch(). Make sure the
- WL_POSTMASTER_DEATH> flag is set when calling that function, and
+ WL_POSTMASTER_DEATH flag is set when calling that function, and
verify the return code for a prompt exit in the emergency case that
- postgres> itself has terminated.
+ postgres itself has terminated.
@@ -238,29 +238,29 @@ typedef struct BackgroundWorker
opaque handle that can subsequently be passed to
GetBackgroundWorkerPid(BackgroundWorkerHandle *, pid_t *) or
TerminateBackgroundWorker(BackgroundWorkerHandle *).
- GetBackgroundWorkerPid> can be used to poll the status of the
- worker: a return value of BGWH_NOT_YET_STARTED> indicates that
+ GetBackgroundWorkerPid can be used to poll the status of the
+ worker: a return value of BGWH_NOT_YET_STARTED indicates that
the worker has not yet been started by the postmaster;
BGWH_STOPPED indicates that it has been started but is
no longer running; and BGWH_STARTED indicates that it is
currently running. In this last case, the PID will also be returned via the
second argument.
- TerminateBackgroundWorker> causes the postmaster to send
- SIGTERM> to the worker if it is running, and to unregister it
+ TerminateBackgroundWorker causes the postmaster to send
+ SIGTERM to the worker if it is running, and to unregister it
as soon as it is not.
In some cases, a process which registers a background worker may wish to
wait for the worker to start up. This can be accomplished by initializing
- bgw_notify_pid to MyProcPid> and
+ bgw_notify_pid to MyProcPid and
then passing the BackgroundWorkerHandle * obtained at
registration time to
WaitForBackgroundWorkerStartup(BackgroundWorkerHandle
*handle, pid_t *) function.
This function will block until the postmaster has attempted to start the
background worker, or until the postmaster dies. If the background runner
- is running, the return value will BGWH_STARTED>, and
+ is running, the return value will BGWH_STARTED, and
the PID will be written to the provided address. Otherwise, the return
value will be BGWH_STOPPED or
BGWH_POSTMASTER_DIED.
@@ -279,7 +279,7 @@ typedef struct BackgroundWorker
- The src/test/modules/worker_spi> module
+ The src/test/modules/worker_spi module
contains a working example,
which demonstrates some useful techniques.
diff --git a/doc/src/sgml/biblio.sgml b/doc/src/sgml/biblio.sgml
index 5462bc38e44..d7547e6e921 100644
--- a/doc/src/sgml/biblio.sgml
+++ b/doc/src/sgml/biblio.sgml
@@ -171,7 +171,7 @@ ssimkovi@ag.or.at
Discusses SQL history and syntax, and describes the addition of
- INTERSECT> and EXCEPT> constructs into
+ INTERSECT and EXCEPT constructs into
PostgreSQL. Prepared as a Master's
Thesis with the support of O. Univ. Prof. Dr. Georg Gottlob and
Univ. Ass. Mag. Katrin Seyr at Vienna University of Technology.
diff --git a/doc/src/sgml/bki.sgml b/doc/src/sgml/bki.sgml
index af6d8d1d2a9..33378b46eaa 100644
--- a/doc/src/sgml/bki.sgml
+++ b/doc/src/sgml/bki.sgml
@@ -21,7 +21,7 @@
input file used by initdb is created as
part of building and installing PostgreSQL
by a program named genbki.pl, which reads some
- specially formatted C header files in the src/include/catalog/>
+ specially formatted C header files in the src/include/catalog/
directory of the source tree. The created BKI file
is called postgres.bki and is
normally installed in the
@@ -67,13 +67,13 @@
- create>
+ createtablenametableoid
- bootstrap>
- shared_relation>
- without_oids>
- rowtype_oid> oid>
+ bootstrap
+ shared_relation
+ without_oids
+ rowtype_oidoid
(name1 =
type1FORCE NOT NULL | FORCE NULL ,
@@ -93,7 +93,7 @@
The following column types are supported directly by
- bootstrap.c>: bool,
+ bootstrap.c: bool,
bytea, char (1 byte),
name, int2,
int4, regproc, regclass,
@@ -104,31 +104,31 @@
_oid (array), _char (array),
_aclitem (array). Although it is possible to create
tables containing columns of other types, this cannot be done until
- after pg_type> has been created and filled with
+ after pg_type has been created and filled with
appropriate entries. (That effectively means that only these
column types can be used in bootstrapped tables, but non-bootstrap
catalogs can contain any built-in type.)
- When bootstrap> is specified,
+ When bootstrap is specified,
the table will only be created on disk; nothing is entered into
pg_class,
pg_attribute, etc, for it. Thus the
table will not be accessible by ordinary SQL operations until
- such entries are made the hard way (with insert>
+ such entries are made the hard way (with insert
commands). This option is used for creating
pg_class etc themselves.
- The table is created as shared if shared_relation> is
+ The table is created as shared if shared_relation is
specified.
- It will have OIDs unless without_oids> is specified.
- The table's row type OID (pg_type> OID) can optionally
- be specified via the rowtype_oid> clause; if not specified,
- an OID is automatically generated for it. (The rowtype_oid>
- clause is useless if bootstrap> is specified, but it can be
+ It will have OIDs unless without_oids is specified.
+ The table's row type OID (pg_type OID) can optionally
+ be specified via the rowtype_oid clause; if not specified,
+ an OID is automatically generated for it. (The rowtype_oid
+ clause is useless if bootstrap is specified, but it can be
provided anyway for documentation.)
@@ -136,7 +136,7 @@
- open> tablename
+ opentablename
@@ -150,7 +150,7 @@
- close> tablename
+ closetablename
@@ -163,7 +163,7 @@
- insert> OID => oid_value(> value1value2 ... )>
+ insertOID =oid_value(value1value2 ... )
@@ -188,14 +188,14 @@
- declare> unique>
- index> indexname
+ declareunique
+ indexindexnameindexoid
- on> tablename
- using> amname
- (> opclass1
+ ontablename
+ usingamname
+ (opclass1name1
- , ...)>
+ , ...)
@@ -220,10 +220,10 @@
- declare toast>
+ declare toasttoasttableoidtoastindexoid
- on> tablename
+ ontablename
@@ -234,14 +234,14 @@
toasttableoid
and its index is assigned OID
toastindexoid.
- As with declare index>, filling of the index
+ As with declare index, filling of the index
is postponed.
- build indices>
+ build indices
@@ -257,17 +257,17 @@
Structure of the Bootstrap BKI File
- The open> command cannot be used until the tables it uses
+ The open command cannot be used until the tables it uses
exist and have entries for the table that is to be opened.
- (These minimum tables are pg_class>,
- pg_attribute>, pg_proc>, and
- pg_type>.) To allow those tables themselves to be filled,
- create> with the bootstrap> option implicitly opens
+ (These minimum tables are pg_class,
+ pg_attribute, pg_proc, and
+ pg_type.) To allow those tables themselves to be filled,
+ create with the bootstrap option implicitly opens
the created table for data insertion.
- Also, the declare index> and declare toast>
+ Also, the declare index and declare toast
commands cannot be used until the system catalogs they need have been
created and filled in.
@@ -278,17 +278,17 @@
- create bootstrap> one of the critical tables
+ create bootstrap one of the critical tables
- insert> data describing at least the critical tables
+ insert data describing at least the critical tables
- close>
+ close
@@ -298,22 +298,22 @@
- create> (without bootstrap>) a noncritical table
+ create (without bootstrap) a noncritical table
- open>
+ open
- insert> desired data
+ insert desired data
- close>
+ close
@@ -328,7 +328,7 @@
- build indices>
+ build indices
diff --git a/doc/src/sgml/bloom.sgml b/doc/src/sgml/bloom.sgml
index 396348c5237..e13ebf80fdf 100644
--- a/doc/src/sgml/bloom.sgml
+++ b/doc/src/sgml/bloom.sgml
@@ -8,7 +8,7 @@
- bloom> provides an index access method based on
+ bloom provides an index access method based on
Bloom filters.
@@ -42,29 +42,29 @@
Parameters
- A bloom> index accepts the following parameters in its
- WITH> clause:
+ A bloom index accepts the following parameters in its
+ WITH clause:
- length>
+ length
Length of each signature (index entry) in bits. The default
- is 80> bits and maximum is 4096>.
+ is 80 bits and maximum is 4096.
- col1 — col32>
+ col1 — col32
Number of bits generated for each index column. Each parameter's name
refers to the number of the index column that it controls. The default
- is 2> bits and maximum is 4095>. Parameters for
+ is 2 bits and maximum is 4095. Parameters for
index columns not actually used are ignored.
@@ -87,8 +87,8 @@ CREATE INDEX bloomidx ON tbloom USING bloom (i1,i2,i3)
The index is created with a signature length of 80 bits, with attributes
i1 and i2 mapped to 2 bits, and attribute i3 mapped to 4 bits. We could
- have omitted the length>, col1>,
- and col2> specifications since those have the default values.
+ have omitted the length, col1,
+ and col2 specifications since those have the default values.
@@ -175,7 +175,7 @@ CREATE INDEX
Note the relatively large number of false positives: 2439 rows were
selected to be visited in the heap, but none actually matched the
query. We could reduce that by specifying a larger signature length.
- In this example, creating the index with length=200>
+ In this example, creating the index with length=200
reduced the number of false positives to 55; but it doubled the index size
(to 306 MB) and ended up being slower for this query (125 ms overall).
@@ -213,7 +213,7 @@ CREATE INDEX
An 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 text> data type:
+ shows the operator class definition for the text data type:
@@ -230,7 +230,7 @@ DEFAULT FOR TYPE text USING bloom AS
- Only operator classes for int4> and text> are
+ Only operator classes for int4 and text are
included with the module.
diff --git a/doc/src/sgml/brin.sgml b/doc/src/sgml/brin.sgml
index 8dcc29925bc..91c01700ed5 100644
--- a/doc/src/sgml/brin.sgml
+++ b/doc/src/sgml/brin.sgml
@@ -16,7 +16,7 @@
BRIN is designed for handling very large tables
in which certain columns have some natural correlation with their
physical location within the table.
- A block range> is a group of pages that are physically
+ A block range is a group of pages that are physically
adjacent in the table; for each block range, some summary info is stored
by the index.
For example, a table storing a store's sale orders might have
@@ -29,7 +29,7 @@
BRIN indexes can satisfy queries via regular bitmap
index scans, and will return all tuples in all pages within each range if
- the summary info stored by the index is consistent> with the
+ the summary info stored by the index is consistent with the
query conditions.
The query executor is in charge of rechecking these tuples and discarding
those that do not match the query conditions — in other words, these
@@ -51,9 +51,9 @@
The size of the block range is determined at index creation time by
- the pages_per_range> storage parameter. The number of index
+ the pages_per_range storage parameter. The number of index
entries will be equal to the size of the relation in pages divided by
- the selected value for pages_per_range>. Therefore, the smaller
+ the selected value for pages_per_range. Therefore, the smaller
the number, the larger the index becomes (because of the need to
store more index entries), but at the same time the summary data stored can
be more precise and more data blocks can be skipped during an index scan.
@@ -99,9 +99,9 @@
- The minmax>
+ The minmax
operator classes store the minimum and the maximum values appearing
- in the indexed column within the range. The inclusion>
+ in the indexed column within the range. The inclusion
operator classes store a value which includes the values in the indexed
column within the range.
@@ -162,21 +162,21 @@
- box_inclusion_ops>
+ box_inclusion_opsbox
- <<>
- &<>
- &&>
- &>>
- >>>
- ~=>
- @>>
- <@>
- &<|>
- <<|>
+ <<
+ &<
+ &&
+ &>
+ >>
+ ~=
+ @>
+ <@
+ &<|
+ <<||>>
- |&>>
+ |&>
@@ -249,11 +249,11 @@
network_inclusion_opsinet
- &&>
- >>=>
+ &&
+ >>=<<==
- >>>
+ >><<
@@ -346,18 +346,18 @@
- range_inclusion_ops>
+ range_inclusion_opsany range type
- <<>
- &<>
- &&>
- &>>
- >>>
- @>>
- <@>
- -|->
- =>
+ <<
+ &<
+ &&
+ &>
+ >>
+ @>
+ <@
+ -|-
+ =<<==
@@ -505,11 +505,11 @@
- BrinOpcInfo *opcInfo(Oid type_oid)>
+ BrinOpcInfo *opcInfo(Oid type_oid)
Returns internal information about the indexed columns' summary data.
- The return value must point to a palloc'd BrinOpcInfo>,
+ The return value must point to a palloc'd BrinOpcInfo,
which has this definition:
typedef struct BrinOpcInfo
@@ -524,7 +524,7 @@ typedef struct BrinOpcInfo
TypeCacheEntry *oi_typcache[FLEXIBLE_ARRAY_MEMBER];
} BrinOpcInfo;
- BrinOpcInfo>.oi_opaque> can be used by the
+ BrinOpcInfo.oi_opaque can be used by the
operator class routines to pass information between support procedures
during an index scan.
@@ -797,8 +797,8 @@ typedef struct BrinOpcInfo
It should accept two arguments with the same data type as the operator class,
and return the union of them. The inclusion operator class can store union
values with different data types if it is defined with the
- STORAGE> parameter. The return value of the union
- function should match the STORAGE> data type.
+ STORAGE parameter. The return value of the union
+ function should match the STORAGE data type.
@@ -823,11 +823,11 @@ typedef struct BrinOpcInfo
on another operator strategy as shown in
, or the same
operator strategy as themselves. They require the dependency
- operator to be defined with the STORAGE> data type as the
+ operator to be defined with the STORAGE data type as the
left-hand-side argument and the other supported data type to be the
right-hand-side argument of the supported operator. See
- float4_minmax_ops> as an example of minmax, and
- box_inclusion_ops> as an example of inclusion.
+ float4_minmax_ops as an example of minmax, and
+ box_inclusion_ops as an example of inclusion.
diff --git a/doc/src/sgml/btree-gin.sgml b/doc/src/sgml/btree-gin.sgml
index 375e7ec4be6..e491fa76e7d 100644
--- a/doc/src/sgml/btree-gin.sgml
+++ b/doc/src/sgml/btree-gin.sgml
@@ -8,16 +8,16 @@
- btree_gin> provides sample GIN operator classes that
+ btree_gin provides sample GIN operator classes that
implement B-tree equivalent behavior for the data types
- int2>, int4>, int8>, float4>,
- float8>, timestamp with time zone>,
- timestamp without time zone>, time with time zone>,
- time without time zone>, date>, interval>,
- oid>, money>, "char">,
- varchar>, text>, bytea>, bit>,
- varbit>, macaddr>, macaddr8>, inet>,
- cidr>, and all enum> types.
+ int2, int4, int8, float4,
+ float8, timestamp with time zone,
+ timestamp without time zone, time with time zone,
+ time without time zone, date, interval,
+ oid, money, "char",
+ varchar, text, bytea, bit,
+ varbit, macaddr, macaddr8, inet,
+ cidr, and all enum types.
diff --git a/doc/src/sgml/btree-gist.sgml b/doc/src/sgml/btree-gist.sgml
index f3c639c2f3b..dcb939f1fbf 100644
--- a/doc/src/sgml/btree-gist.sgml
+++ b/doc/src/sgml/btree-gist.sgml
@@ -8,16 +8,16 @@
- btree_gist> provides GiST index operator classes that
+ btree_gist provides GiST index operator classes that
implement B-tree equivalent behavior for the data types
- int2>, int4>, int8>, float4>,
- float8>, numeric>, timestamp with time zone>,
- timestamp without time zone>, time with time zone>,
- time without time zone>, date>, interval>,
- oid>, money>, char>,
- varchar>, text>, bytea>, bit>,
- varbit>, macaddr>, macaddr8>, inet>,
- cidr>, uuid>, and all enum> types.
+ int2, int4, int8, float4,
+ float8, numeric, timestamp with time zone,
+ timestamp without time zone, time with time zone,
+ time without time zone, date, interval,
+ oid, money, char,
+ varchar, text, bytea, bit,
+ varbit, macaddr, macaddr8, inet,
+ cidr, uuid, and all enum types.
@@ -33,7 +33,7 @@
- In addition to the typical B-tree search operators, btree_gist>
+ In addition to the typical B-tree search operators, btree_gist
also provides index support for <> (not
equals). This may be useful in combination with an
exclusion constraint,
@@ -42,14 +42,14 @@
Also, for data types for which there is a natural distance metric,
- btree_gist> defines a distance operator <->>,
+ btree_gist defines a distance operator <->,
and provides GiST index support for nearest-neighbor searches using
this operator. Distance operators are provided for
- int2>, int4>, int8>, float4>,
- float8>, timestamp with time zone>,
- timestamp without time zone>,
- time without time zone>, date>, interval>,
- oid>, and money>.
+ int2, int4, int8, float4,
+ float8, timestamp with time zone,
+ timestamp without time zone,
+ time without time zone, date, interval,
+ oid, and money.
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index cfec2465d26..ef60a58631a 100644
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -387,7 +387,7 @@
- pg_aggregate> Columns
+ pg_aggregate Columns
@@ -410,9 +410,9 @@
charAggregate kind:
- n for normal> aggregates,
- o for ordered-set> aggregates, or
- h for hypothetical-set> aggregates
+ n for normal aggregates,
+ o for ordered-set aggregates, or
+ h for hypothetical-set aggregates
@@ -421,7 +421,7 @@
Number of direct (non-aggregated) arguments of an ordered-set or
hypothetical-set aggregate, counting a variadic array as one argument.
- If equal to pronargs>, the aggregate must be variadic
+ If equal to pronargs, the aggregate must be variadic
and the variadic array describes the aggregated arguments as well as
the final direct arguments.
Always zero for normal aggregates.
@@ -592,7 +592,7 @@
- pg_am> Columns
+ pg_am Columns
@@ -644,7 +644,7 @@
- Before PostgreSQL> 9.6, pg_am
+ Before PostgreSQL 9.6, pg_am
contained many additional columns representing properties of index access
methods. That data is now only directly visible at the C code level.
However, pg_index_column_has_property() and related
@@ -667,8 +667,8 @@
The catalog pg_amop stores information about
operators associated with access method operator families. There is one
row for each operator that is a member of an operator family. A family
- member can be either a search> operator or an
- ordering> operator. An operator
+ member can be either a search operator or an
+ ordering operator. An operator
can appear in more than one family, but cannot appear in more than one
search position nor more than one ordering position within a family.
(It is allowed, though unlikely, for an operator to be used for both
@@ -676,7 +676,7 @@
- pg_amop> Columns
+ pg_amop Columns
@@ -728,8 +728,8 @@
amoppurposechar
- Operator purpose, either s> for search or
- o> for ordering
+ Operator purpose, either s for search or
+ o for ordering
@@ -759,26 +759,26 @@
- A search> operator entry indicates that an index of this operator
+ A search operator entry indicates that an index of this operator
family can be searched to find all rows satisfying
- WHERE>
- indexed_column>
- operator>
- constant>.
+ WHERE
+ indexed_column
+ operator
+ constant.
Obviously, such an operator must return boolean, and its left-hand input
type must match the index's column data type.
- An ordering> operator entry indicates that an index of this
+ An ordering operator entry indicates that an index of this
operator family can be scanned to return rows in the order represented by
- ORDER BY>
- indexed_column>
- operator>
- constant>.
+ ORDER BY
+ indexed_column
+ operator
+ constant.
Such an operator could return any sortable data type, though again
its left-hand input type must match the index's column data type.
- The exact semantics of the ORDER BY> are specified by the
+ The exact semantics of the ORDER BY are specified by the
amopsortfamily column, which must reference
a B-tree operator family for the operator's result type.
@@ -787,19 +787,19 @@
At present, it's assumed that the sort order for an ordering operator
is the default for the referenced operator family, i.e., ASC NULLS
- LAST>. This might someday be relaxed by adding additional columns
+ LAST. This might someday be relaxed by adding additional columns
to specify sort options explicitly.
- An entry's amopmethod> must match the
- opfmethod> of its containing operator family (including
- amopmethod> here is an intentional denormalization of the
+ An entry's amopmethod must match the
+ opfmethod of its containing operator family (including
+ amopmethod here is an intentional denormalization of the
catalog structure for performance reasons). Also,
- amoplefttype> and amoprighttype> must match
- the oprleft> and oprright> fields of the
- referenced pg_operator> entry.
+ amoplefttype and amoprighttype must match
+ the oprleft and oprright fields of the
+ referenced pg_operator entry.
@@ -880,14 +880,14 @@
The usual interpretation of the
- amproclefttype> and amprocrighttype> fields
+ amproclefttype and amprocrighttype fields
is that they identify the left and right input types of the operator(s)
that a particular support procedure supports. For some access methods
these match the input data type(s) of the support procedure itself, for
- others not. There is a notion of default> support procedures for
- an index, which are those with amproclefttype> and
- amprocrighttype> both equal to the index operator class's
- opcintype>.
+ others not. There is a notion of default support procedures for
+ an index, which are those with amproclefttype and
+ amprocrighttype both equal to the index operator class's
+ opcintype.
@@ -909,7 +909,7 @@
- pg_attrdef> Columns
+ pg_attrdef Columns
@@ -964,7 +964,7 @@
The adsrc field is historical, and is best
not used, because it does not track outside changes that might affect
the representation of the default value. Reverse-compiling the
- adbin field (with pg_get_expr> for
+ adbin field (with pg_get_expr for
example) is a better way to display the default value.
@@ -993,7 +993,7 @@
- pg_attribute> Columns
+ pg_attribute Columns
@@ -1072,7 +1072,7 @@
Number of dimensions, if the column is an array type; otherwise 0.
(Presently, the number of dimensions of an array is not enforced,
- so any nonzero value effectively means it's an array>.)
+ so any nonzero value effectively means it's an array.)
@@ -1096,7 +1096,7 @@
supplied at table creation time (for example, the maximum
length of a varchar column). It is passed to
type-specific input functions and length coercion functions.
- The value will generally be -1 for types that do not need atttypmod>.
+ The value will generally be -1 for types that do not need atttypmod.
@@ -1105,7 +1105,7 @@
bool
- A copy of pg_type.typbyval> of this column's type
+ A copy of pg_type.typbyval of this column's type
@@ -1114,7 +1114,7 @@
char
- Normally a copy of pg_type.typstorage> of this
+ Normally a copy of pg_type.typstorage of this
column's type. For TOAST-able data types, this can be altered
after column creation to control storage policy.
@@ -1125,7 +1125,7 @@
char
- A copy of pg_type.typalign> of this column's type
+ A copy of pg_type.typalign of this column's type
@@ -1216,7 +1216,7 @@
text[]
- Attribute-level options, as keyword=value> strings
+ Attribute-level options, as keyword=value strings
@@ -1225,7 +1225,7 @@
text[]
- Attribute-level foreign data wrapper options, as keyword=value> strings
+ Attribute-level foreign data wrapper options, as keyword=value strings
@@ -1237,9 +1237,9 @@
In a dropped column's pg_attribute entry,
atttypid is reset to zero, but
attlen and the other fields copied from
- pg_type> are still valid. This arrangement is needed
+ pg_type are still valid. This arrangement is needed
to cope with the situation where the dropped column's data type was
- later dropped, and so there is no pg_type> row anymore.
+ later dropped, and so there is no pg_type row anymore.
attlen and the other fields can be used
to interpret the contents of a row of the table.
@@ -1256,9 +1256,9 @@
The catalog pg_authid contains information about
database authorization identifiers (roles). A role subsumes the concepts
- of users> and groups>. A user is essentially just a
- role with the rolcanlogin> flag set. Any role (with or
- without rolcanlogin>) can have other roles as members; see
+ of users and groups. A user is essentially just a
+ role with the rolcanlogin flag set. Any role (with or
+ without rolcanlogin) can have other roles as members; see
pg_auth_members.
@@ -1283,7 +1283,7 @@
- pg_authid> Columns
+ pg_authid Columns
@@ -1390,20 +1390,20 @@
For an MD5 encrypted password, rolpassword
- column will begin with the string md5> followed by a
+ column will begin with the string md5 followed by a
32-character hexadecimal MD5 hash. The MD5 hash will be of the user's
password concatenated to their user name. For example, if user
- joe> has password xyzzy>, PostgreSQL>
- will store the md5 hash of xyzzyjoe>.
+ joe has password xyzzy, PostgreSQL
+ will store the md5 hash of xyzzyjoe.
If the password is encrypted with SCRAM-SHA-256, it has the format:
-SCRAM-SHA-256$<iteration count>>:<salt>>$<StoredKey>>:<ServerKey>>
+SCRAM-SHA-256$<iteration count>:<salt>$<StoredKey>:<ServerKey>
- where salt>, StoredKey> and
- ServerKey> are in Base64 encoded format. This format is
+ where salt, StoredKey and
+ ServerKey are in Base64 encoded format. This format is
the same as that specified by RFC 5803.
@@ -1435,7 +1435,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_auth_members> Columns
+ pg_auth_members Columns
@@ -1459,7 +1459,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
memberoidpg_authid.oid
- ID of a role that is a member of roleid>
+ ID of a role that is a member of roleid
@@ -1473,8 +1473,8 @@ SCRAM-SHA-256$<iteration count>>:<salt><
admin_optionbool
- True if member> can grant membership in
- roleid> to others
+ True if member can grant membership in
+ roleid to others
@@ -1501,14 +1501,14 @@ SCRAM-SHA-256$<iteration count>>:<salt><
cannot be deduced from some generic rule. For example, casting between a
domain and its base type is not explicitly represented in
pg_cast. Another important exception is that
- automatic I/O conversion casts>, those performed using a data
- type's own I/O functions to convert to or from text> or other
+ automatic I/O conversion casts, those performed using a data
+ type's own I/O functions to convert to or from text or other
string types, are not explicitly represented in
pg_cast.
- pg_cast> Columns
+ pg_cast Columns
@@ -1558,11 +1558,11 @@ SCRAM-SHA-256$<iteration count>>:<salt><
Indicates what contexts the cast can be invoked in.
- e> means only as an explicit cast (using
- CAST> or ::> syntax).
- a> means implicitly in assignment
+ e means only as an explicit cast (using
+ CAST or :: syntax).
+ a means implicitly in assignment
to a target column, as well as explicitly.
- i> means implicitly in expressions, as well as the
+ i means implicitly in expressions, as well as the
other cases.
@@ -1572,9 +1572,9 @@ SCRAM-SHA-256$<iteration count>>:<salt><
Indicates how the cast is performed.
- f> means that the function specified in the castfunc> field is used.
- i> means that the input/output functions are used.
- b> means that the types are binary-coercible, thus no conversion is required.
+ f means that the function specified in the castfunc field is used.
+ i means that the input/output functions are used.
+ b means that the types are binary-coercible, thus no conversion is required.
@@ -1586,18 +1586,18 @@ SCRAM-SHA-256$<iteration count>>:<salt><
always take the cast source type as their first argument type, and
return the cast destination type as their result type. A cast
function can have up to three arguments. The second argument,
- if present, must be type integer>; it receives the type
+ if present, must be type integer; it receives the type
modifier associated with the destination type, or -1
if there is none. The third argument,
- if present, must be type boolean>; it receives true>
- if the cast is an explicit cast, false> otherwise.
+ if present, must be type boolean; it receives true
+ if the cast is an explicit cast, false otherwise.
It is legitimate to create a pg_cast entry
in which the source and target types are the same, if the associated
function takes more than one argument. Such entries represent
- length coercion functions> that coerce values of the type
+ length coercion functions that coerce values of the type
to be legal for a particular type modifier value.
@@ -1624,14 +1624,14 @@ SCRAM-SHA-256$<iteration count>>:<salt><
table. This includes indexes (but see also
pg_index), sequences (but see also
pg_sequence), views, materialized
- views, composite types, and TOAST tables; see relkind>.
+ views, composite types, and TOAST tables; see relkind.
Below, when we mean all of these
kinds of objects we speak of relations. Not all
columns are meaningful for all relation types.
- pg_class> Columns
+ pg_class Columns
@@ -1673,7 +1673,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
pg_type.oid
The OID of the data type that corresponds to this table's row type,
- if any (zero for indexes, which have no pg_type> entry)
+ if any (zero for indexes, which have no pg_type entry)
@@ -1706,7 +1706,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
oidName of the on-disk file of this relation; zero means this
- is a mapped> relation whose disk file name is determined
+ is a mapped relation whose disk file name is determined
by low-level state
@@ -1795,8 +1795,8 @@ SCRAM-SHA-256$<iteration count>>:<salt><
char
- p> = permanent table, u> = unlogged table,
- t> = temporary table
+ p = permanent table, u = unlogged table,
+ t = temporary table
@@ -1805,15 +1805,15 @@ SCRAM-SHA-256$<iteration count>>:<salt><
char
- r> = ordinary table,
- i> = index,
- S> = sequence,
- t> = TOAST table,
- v> = view,
- m> = materialized view,
- c> = composite type,
- f> = foreign table,
- p> = partitioned table
+ r = ordinary table,
+ i = index,
+ S = sequence,
+ t = TOAST table,
+ v = view,
+ m = materialized view,
+ c = composite type,
+ f = foreign table,
+ p = partitioned table
@@ -1834,7 +1834,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
int2
- Number of CHECK> constraints on the table; see
+ Number of CHECK constraints on the table; see
pg_constraint catalog
@@ -1917,11 +1917,11 @@ SCRAM-SHA-256$<iteration count>>:<salt><
char
- Columns used to form replica identity> for rows:
- d> = default (primary key, if any),
- n> = nothing,
- f> = all columns
- i> = index with indisreplident set, or default
+ Columns used to form replica identity for rows:
+ d = default (primary key, if any),
+ n = nothing,
+ f = all columns
+ i = index with indisreplident set, or default
@@ -1938,9 +1938,9 @@ SCRAM-SHA-256$<iteration count>>:<salt><
All transaction IDs before this one have been replaced with a permanent
- (frozen>) transaction ID in this table. This is used to track
+ (frozen) transaction ID in this table. This is used to track
whether the table needs to be vacuumed in order to prevent transaction
- ID wraparound or to allow pg_xact> to be shrunk. Zero
+ ID wraparound or to allow pg_xact to be shrunk. Zero
(InvalidTransactionId) if the relation is not a table.
@@ -1953,7 +1953,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
All multixact IDs before this one have been replaced by a
transaction ID in this table. This is used to track
whether the table needs to be vacuumed in order to prevent multixact ID
- wraparound or to allow pg_multixact> to be shrunk. Zero
+ wraparound or to allow pg_multixact to be shrunk. Zero
(InvalidMultiXactId) if the relation is not a table.
@@ -1975,7 +1975,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
text[]
- Access-method-specific options, as keyword=value> strings
+ Access-method-specific options, as keyword=value strings
@@ -1993,13 +1993,13 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- Several of the Boolean flags in pg_class> are maintained
+ Several of the Boolean flags in pg_class are maintained
lazily: they are guaranteed to be true if that's the correct state, but
may not be reset to false immediately when the condition is no longer
- true. For example, relhasindex> is set by
+ true. For example, relhasindex is set by
CREATE INDEX, but it is never cleared by
DROP INDEX. Instead, VACUUM clears
- relhasindex> if it finds the table has no indexes. This
+ relhasindex if it finds the table has no indexes. This
arrangement avoids race conditions and improves concurrency.
@@ -2019,7 +2019,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_collation> Columns
+ pg_collation Columns
@@ -2082,14 +2082,14 @@ SCRAM-SHA-256$<iteration count>>:<salt><
collcollatename
- LC_COLLATE> for this collation object
+ LC_COLLATE for this collation objectcollctypename
- LC_CTYPE> for this collation object
+ LC_CTYPE for this collation object
@@ -2107,27 +2107,27 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- Note that the unique key on this catalog is (collname>,
- collencoding>, collnamespace>) not just
- (collname>, collnamespace>).
+ Note that the unique key on this catalog is (collname,
+ collencoding, collnamespace) not just
+ (collname, collnamespace).
PostgreSQL generally ignores all
- collations that do not have collencoding> equal to
+ collations that do not have collencoding equal to
either the current database's encoding or -1, and creation of new entries
- with the same name as an entry with collencoding> = -1
+ with the same name as an entry with collencoding = -1
is forbidden. Therefore it is sufficient to use a qualified SQL name
- (schema>.name>) to identify a collation,
+ (schema.name) to identify a collation,
even though this is not unique according to the catalog definition.
The reason for defining the catalog this way is that
- initdb> fills it in at cluster initialization time with
+ initdb fills it in at cluster initialization time with
entries for all locales available on the system, so it must be able to
hold entries for all encodings that might ever be used in the cluster.
- In the template0> database, it could be useful to create
+ In the template0 database, it could be useful to create
collations whose encoding does not match the database encoding,
since they could match the encodings of databases later cloned from
- template0>. This would currently have to be done manually.
+ template0. This would currently have to be done manually.
@@ -2143,13 +2143,13 @@ SCRAM-SHA-256$<iteration count>>:<salt><
key, unique, foreign key, and exclusion constraints on tables.
(Column constraints are not treated specially. Every column constraint is
equivalent to some table constraint.)
- Not-null constraints are represented in the pg_attribute>
+ Not-null constraints are represented in the pg_attribute
catalog, not here.
User-defined constraint triggers (created with CREATE CONSTRAINT
- TRIGGER>) also give rise to an entry in this table.
+ TRIGGER) also give rise to an entry in this table.
@@ -2157,7 +2157,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_constraint> Columns
+ pg_constraint Columns
@@ -2198,12 +2198,12 @@ SCRAM-SHA-256$<iteration count>>:<salt><
char
- c> = check constraint,
- f> = foreign key constraint,
- p> = primary key constraint,
- u> = unique constraint,
- t> = constraint trigger,
- x> = exclusion constraint
+ c = check constraint,
+ f = foreign key constraint,
+ p = primary key constraint,
+ u = unique constraint,
+ t = constraint trigger,
+ x = exclusion constraint
@@ -2263,11 +2263,11 @@ SCRAM-SHA-256$<iteration count>>:<salt><
charForeign key update action code:
- a> = no action,
- r> = restrict,
- c> = cascade,
- n> = set null,
- d> = set default
+ a = no action,
+ r = restrict,
+ c = cascade,
+ n = set null,
+ d = set default
@@ -2276,11 +2276,11 @@ SCRAM-SHA-256$<iteration count>>:<salt><
charForeign key deletion action code:
- a> = no action,
- r> = restrict,
- c> = cascade,
- n> = set null,
- d> = set default
+ a = no action,
+ r = restrict,
+ c = cascade,
+ n = set null,
+ d = set default
@@ -2289,9 +2289,9 @@ SCRAM-SHA-256$<iteration count>>:<salt><
charForeign key match type:
- f> = full,
- p> = partial,
- s> = simple
+ f = full,
+ p = partial,
+ s = simple
@@ -2329,7 +2329,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
conkeyint2[]
- pg_attribute.attnum>
+ pg_attribute.attnumIf a table constraint (including foreign keys, but not constraint
triggers), list of the constrained columns
@@ -2337,35 +2337,35 @@ SCRAM-SHA-256$<iteration count>>:<salt><
confkeyint2[]
- pg_attribute.attnum>
+ pg_attribute.attnumIf a foreign key, list of the referenced columnsconpfeqopoid[]
- pg_operator.oid>
+ pg_operator.oidIf a foreign key, list of the equality operators for PK = FK comparisonsconppeqopoid[]
- pg_operator.oid>
+ pg_operator.oidIf a foreign key, list of the equality operators for PK = PK comparisonsconffeqopoid[]
- pg_operator.oid>
+ pg_operator.oidIf a foreign key, list of the equality operators for FK = FK comparisonsconexclopoid[]
- pg_operator.oid>
+ pg_operator.oidIf an exclusion constraint, list of the per-column exclusion operators
@@ -2392,7 +2392,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
For other cases, a zero appears in conkey
and the associated index must be consulted to discover the expression
that is constrained. (conkey thus has the
- same contents as pg_index>.indkey> for the
+ same contents as pg_index.indkey for the
index.)
@@ -2400,7 +2400,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
consrc is not updated when referenced objects
change; for example, it won't track renaming of columns. Rather than
- relying on this field, it's best to use pg_get_constraintdef()>
+ relying on this field, it's best to use pg_get_constraintdef()
to extract the definition of a check constraint.
@@ -2429,7 +2429,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_database> Columns
+ pg_database Columns
@@ -2592,7 +2592,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
If true, then this database can be cloned by
- any user with CREATEDB> privileges;
+ any user with CREATEDB privileges;
if false, then only superusers or the owner of
the database can clone it.
@@ -2604,7 +2604,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
If false then no one can connect to this database. This is
- used to protect the template0> database from being altered.
+ used to protect the template0 database from being altered.
@@ -2634,11 +2634,11 @@ SCRAM-SHA-256$<iteration count>>:<salt><
All transaction IDs before this one have been replaced with a permanent
- (frozen>) transaction ID in this database. This is used to
+ (frozen) transaction ID in this database. This is used to
track whether the database needs to be vacuumed in order to prevent
- transaction ID wraparound or to allow pg_xact> to be shrunk.
+ transaction ID wraparound or to allow pg_xact to be shrunk.
It is the minimum of the per-table
- pg_class>.relfrozenxid> values.
+ pg_class.relfrozenxid values.
@@ -2650,9 +2650,9 @@ SCRAM-SHA-256$<iteration count>>:<salt><
All multixact IDs before this one have been replaced with a
transaction ID in this database. This is used to
track whether the database needs to be vacuumed in order to prevent
- multixact ID wraparound or to allow pg_multixact> to be shrunk.
+ multixact ID wraparound or to allow pg_multixact to be shrunk.
It is the minimum of the per-table
- pg_class>.relminmxid> values.
+ pg_class.relminmxid values.
@@ -2663,7 +2663,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
The default tablespace for the database.
Within this database, all tables for which
- pg_class>.reltablespace> is zero
+ pg_class.reltablespace is zero
will be stored in this tablespace; in particular, all the non-shared
system catalogs will be there.
@@ -2707,7 +2707,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_db_role_setting> Columns
+ pg_db_role_setting Columns
@@ -2754,12 +2754,12 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- The catalog pg_default_acl> stores initial
+ The catalog pg_default_acl stores initial
privileges to be assigned to newly created objects.
- pg_default_acl> Columns
+ pg_default_acl Columns
@@ -2800,10 +2800,10 @@ SCRAM-SHA-256$<iteration count>>:<salt><
Type of object this entry is for:
- r> = relation (table, view),
- S> = sequence,
- f> = function,
- T> = type
+ r = relation (table, view),
+ S = sequence,
+ f = function,
+ T = type
@@ -2820,21 +2820,21 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- A pg_default_acl> entry shows the initial privileges to
+ A pg_default_acl entry shows the initial privileges to
be assigned to an object belonging to the indicated user. There are
- currently two types of entry: global> entries with
- defaclnamespace> = 0, and per-schema> entries
+ currently two types of entry: global entries with
+ defaclnamespace = 0, and per-schema entries
that reference a particular schema. If a global entry is present then
- it overrides> the normal hard-wired default privileges
+ it overrides the normal hard-wired default privileges
for the object type. A per-schema entry, if present, represents privileges
- to be added to> the global or hard-wired default privileges.
+ to be added to the global or hard-wired default privileges.
Note that when an ACL entry in another catalog is null, it is taken
to represent the hard-wired default privileges for its object,
- not> whatever might be in pg_default_acl>
- at the moment. pg_default_acl> is only consulted during
+ not whatever might be in pg_default_acl
+ at the moment. pg_default_acl is only consulted during
object creation.
@@ -2851,9 +2851,9 @@ SCRAM-SHA-256$<iteration count>>:<salt><
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 DROP CASCADE> or prevent dropping in the DROP
- RESTRICT> case.
+ DROP commands to find which other objects must be dropped
+ by DROP CASCADE or prevent dropping in the DROP
+ RESTRICT case.
@@ -2863,7 +2863,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_depend> Columns
+ pg_depend Columns
@@ -2896,7 +2896,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
For a table column, this is the column number (the
- objid> and classid> refer to the
+ objid and classid refer to the
table itself). For all other object types, this column is
zero.
@@ -2922,7 +2922,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
For a table column, this is the column number (the
- refobjid> and refclassid> refer
+ refobjid and refclassid refer
to the table itself). For all other object types, this column
is zero.
@@ -2945,17 +2945,17 @@ SCRAM-SHA-256$<iteration count>>:<salt><
In all cases, a pg_depend entry indicates that the
referenced object cannot be dropped without also dropping the dependent
object. However, there are several subflavors identified by
- deptype>:
+ deptype:
- DEPENDENCY_NORMAL> (n>)
+ DEPENDENCY_NORMAL (n)
A normal relationship between separately-created objects. The
dependent object can be dropped without affecting the
referenced object. The referenced object can only be dropped
- by specifying CASCADE>, in which case the dependent
+ by specifying CASCADE, in which case the dependent
object is dropped, too. Example: a table column has a normal
dependency on its data type.
@@ -2963,12 +2963,12 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- DEPENDENCY_AUTO> (a>)
+ DEPENDENCY_AUTO (a)
The dependent object can be dropped separately from the
referenced object, and should be automatically dropped
- (regardless of RESTRICT> or CASCADE>
+ (regardless of RESTRICT or CASCADE
mode) if the referenced object is dropped. Example: a named
constraint on a table is made autodependent on the table, so
that it will go away if the table is dropped.
@@ -2977,41 +2977,41 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- DEPENDENCY_INTERNAL> (i>)
+ DEPENDENCY_INTERNAL (i)
The dependent object was created as part of creation of the
referenced object, and is really just a part of its internal
- implementation. A DROP> of the dependent object
+ implementation. A DROP of the dependent object
will be disallowed outright (we'll tell the user to issue a
- DROP> against the referenced object, instead). A
- DROP> of the referenced object will be propagated
+ DROP against the referenced object, instead). A
+ DROP of the referenced object will be propagated
through to drop the dependent object whether
- CASCADE> is specified or not. Example: a trigger
+ CASCADE is specified or not. Example: a trigger
that's created to enforce a foreign-key constraint is made
internally dependent on the constraint's
- pg_constraint> entry.
+ pg_constraint entry.
- DEPENDENCY_EXTENSION> (e>)
+ DEPENDENCY_EXTENSION (e)
- The dependent object is a member of the extension> that is
+ The dependent object is a member of the extension that is
the referenced object (see
pg_extension).
The dependent object can be dropped only via
- DROP EXTENSION> on the referenced object. Functionally
+ DROP EXTENSION on the referenced object. Functionally
this dependency type acts the same as an internal dependency, but
- it's kept separate for clarity and to simplify pg_dump>.
+ it's kept separate for clarity and to simplify pg_dump.
- DEPENDENCY_AUTO_EXTENSION> (x>)
+ DEPENDENCY_AUTO_EXTENSION (x)
The dependent object is not a member of the extension that is the
@@ -3024,7 +3024,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- DEPENDENCY_PIN> (p>)
+ DEPENDENCY_PIN (p)
There is no dependent object; this type of entry is a signal
@@ -3051,7 +3051,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- The catalog pg_description> stores optional descriptions
+ The catalog pg_description stores optional descriptions
(comments) for each database object. Descriptions can be manipulated
with the command and viewed with
psql's \d commands.
@@ -3066,7 +3066,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_description> Columns
+ pg_description Columns
@@ -3099,7 +3099,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
For a comment on a table column, this is the column number (the
- objoid> and classoid> refer to
+ objoid and classoid refer to
the table itself). For all other object types, this column is
zero.
@@ -3133,7 +3133,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_enum> Columns
+ pg_enum Columns
@@ -3157,7 +3157,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
enumtypidoidpg_type.oid
- The OID of the pg_type> entry owning this enum value
+ The OID of the pg_type entry owning this enum value
@@ -3191,7 +3191,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
When an enum type is created, its members are assigned sort-order
- positions 1..n>. But members added later might be given
+ positions 1..n. But members added later might be given
negative or fractional values of enumsortorder.
The only requirement on these values is that they be correctly
ordered and unique within each enum type.
@@ -3212,7 +3212,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_event_trigger> Columns
+ pg_event_trigger Columns
@@ -3260,10 +3260,10 @@ SCRAM-SHA-256$<iteration count>>:<salt><
Controls in which modes
the event trigger fires.
- O> = trigger fires in origin> and local> modes,
- D> = trigger is disabled,
- R> = trigger fires in replica> mode,
- A> = trigger fires always.
+ O = trigger fires in origin and local modes,
+ D = trigger is disabled,
+ R = trigger fires in replica mode,
+ A = trigger fires always.
@@ -3296,7 +3296,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_extension> Columns
+ pg_extension Columns
@@ -3355,16 +3355,16 @@ SCRAM-SHA-256$<iteration count>>:<salt><
extconfigoid[]pg_class.oid
- Array of regclass> OIDs for the extension's configuration
- table(s), or NULL> if none
+ Array of regclass OIDs for the extension's configuration
+ table(s), or NULL if noneextconditiontext[]
- Array of WHERE>-clause filter conditions for the
- extension's configuration table(s), or NULL> if none
+ Array of WHERE-clause filter conditions for the
+ extension's configuration table(s), or NULL if none
@@ -3372,7 +3372,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- Note that unlike most catalogs with a namespace> column,
+ Note that unlike most catalogs with a namespace column,
extnamespace is not meant to imply
that the extension belongs to that schema. Extension names are never
schema-qualified. Rather, extnamespace
@@ -3399,7 +3399,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_foreign_data_wrapper> Columns
+ pg_foreign_data_wrapper Columns
@@ -3474,7 +3474,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
text[]
- Foreign-data wrapper specific options, as keyword=value> strings
+ Foreign-data wrapper specific options, as keyword=value strings
@@ -3498,7 +3498,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_foreign_server> Columns
+ pg_foreign_server Columns
@@ -3570,7 +3570,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
text[]
- Foreign server specific options, as keyword=value> strings
+ Foreign server specific options, as keyword=value strings
@@ -3596,7 +3596,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_foreign_table> Columns
+ pg_foreign_table Columns
@@ -3613,7 +3613,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
ftrelidoidpg_class.oid
- OID of the pg_class> entry for this foreign table
+ OID of the pg_class entry for this foreign table
@@ -3628,7 +3628,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
text[]
- Foreign table options, as keyword=value> strings
+ Foreign table options, as keyword=value strings
@@ -3651,7 +3651,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_index> Columns
+ pg_index Columns
@@ -3668,14 +3668,14 @@ SCRAM-SHA-256$<iteration count>>:<salt><
indexrelidoidpg_class.oid
- The OID of the pg_class> entry for this index
+ The OID of the pg_class entry for this indexindrelidoidpg_class.oid
- The OID of the pg_class> entry for the table this index is for
+ The OID of the pg_class entry for the table this index is for
@@ -3698,7 +3698,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
boolIf true, this index represents the primary key of the table
- (indisunique> should always be true when this is true)
+ (indisunique should always be true when this is true)
@@ -3714,7 +3714,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
If true, the uniqueness check is enforced immediately on
insertion
- (irrelevant if indisunique> is not true)
+ (irrelevant if indisunique is not true)
@@ -3731,7 +3731,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
If true, the index is currently valid for queries. False means the
index is possibly incomplete: it must still be modified by
- INSERT>/UPDATE> operations, but it cannot safely
+ INSERT/UPDATE operations, but it cannot safely
be used for queries. If it is unique, the uniqueness property is not
guaranteed true either.
@@ -3742,8 +3742,8 @@ SCRAM-SHA-256$<iteration count>>:<salt><
bool
- If true, queries must not use the index until the xmin>
- of this pg_index> row is below their TransactionXmin
+ If true, queries must not use the index until the xmin
+ of this pg_index row is below their TransactionXmin
event horizon, because the table may contain broken HOT chains with
incompatible rows that they can see
@@ -3755,7 +3755,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
If true, the index is currently ready for inserts. False means the
- index must be ignored by INSERT>/UPDATE>
+ index must be ignored by INSERT/UPDATE
operations.
@@ -3775,9 +3775,9 @@ SCRAM-SHA-256$<iteration count>>:<salt><
bool
- If true this index has been chosen as replica identity>
+ If true this index has been chosen as replica identity
using ALTER TABLE ... REPLICA IDENTITY USING INDEX
- ...>
+ ...
@@ -3836,7 +3836,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
Expression trees (in nodeToString()
representation) for index attributes that are not simple column
references. This is a list with one element for each zero
- entry in indkey>. Null if all index attributes
+ entry in indkey. Null if all index attributes
are simple references.
@@ -3866,14 +3866,14 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- The catalog pg_inherits> records information about
+ The catalog pg_inherits records information about
table inheritance hierarchies. There is one entry for each direct
parent-child table relationship in the database. (Indirect inheritance can be determined
by following chains of entries.)
- pg_inherits> Columns
+ pg_inherits Columns
@@ -3928,7 +3928,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- The catalog pg_init_privs> records information about
+ 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-default (non-NULL)
initial set of privileges.
@@ -3936,7 +3936,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
Objects can have initial privileges either by having those privileges set
- when the system is initialized (by initdb>) or when the
+ when the system is initialized (by initdb) or when the
object is created during a CREATE EXTENSION and the
extension script sets initial privileges using the GRANT
system. Note that the system will automatically handle recording of the
@@ -3944,12 +3944,12 @@ SCRAM-SHA-256$<iteration count>>:<salt><
only use the GRANT and REVOKE
statements in their script to have the privileges recorded. The
privtype column indicates if the initial privilege was
- set by initdb> or during a
+ set by initdb or during a
CREATE EXTENSION command.
- Objects which have initial privileges set by initdb> will
+ Objects which have initial privileges set by initdb will
have entries where privtype is
'i', while objects which have initial privileges set
by CREATE EXTENSION will have entries where
@@ -3957,7 +3957,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_init_privs> Columns
+ pg_init_privs Columns
@@ -3990,7 +3990,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
For a table column, this is the column number (the
- objoid> and classoid> refer to the
+ objoid and classoid refer to the
table itself). For all other object types, this column is
zero.
@@ -4039,7 +4039,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- pg_language> Columns
+ pg_language Columns
@@ -4116,7 +4116,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
pg_proc.oid
This references a function that is responsible for executing
- inline> anonymous code blocks
+ inline anonymous code blocks
( blocks).
Zero if inline blocks are not supported.
@@ -4162,24 +4162,24 @@ SCRAM-SHA-256$<iteration count>>:<salt><
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 into
- segments or pages> small enough to be conveniently stored as rows
+ segments or pages small enough to be conveniently stored as rows
in pg_largeobject.
- The amount of data per page is defined to be LOBLKSIZE> (which is currently
- BLCKSZ/4>, or typically 2 kB).
+ The amount of data per page is defined to be LOBLKSIZE (which is currently
+ BLCKSZ/4, or typically 2 kB).
- Prior to PostgreSQL> 9.0, there was no permission structure
+ Prior to PostgreSQL 9.0, there was no permission structure
associated with large objects. As a result,
pg_largeobject was publicly readable and could be
used to obtain the OIDs (and contents) of all large objects in the system.
This is no longer the case; use
- pg_largeobject_metadata>
+ pg_largeobject_metadata
to obtain a list of large object OIDs.
- pg_largeobject> Columns
+ pg_largeobject Columns
@@ -4213,7 +4213,7 @@ SCRAM-SHA-256$<iteration count>>:<salt><
Actual data stored in the large object.
- This will never be more than LOBLKSIZE> bytes and might be less.
+ This will never be more than LOBLKSIZE bytes and might be less.
@@ -4223,9 +4223,9 @@ SCRAM-SHA-256$<iteration count>>:<salt><
Each row of pg_largeobject holds data
for one page of a large object, beginning at
- byte offset (pageno * LOBLKSIZE>) within the object. The implementation
+ byte offset (pageno * LOBLKSIZE) within the object. The implementation
allows sparse storage: pages might be missing, and might be shorter than
- LOBLKSIZE> bytes even if they are not the last page of the object.
+ LOBLKSIZE bytes even if they are not the last page of the object.
Missing regions within a large object read as zeroes.
@@ -4242,11 +4242,11 @@ SCRAM-SHA-256$<iteration count>>:<salt><
The catalog pg_largeobject_metadata
holds metadata associated with large objects. The actual large object
data is stored in
- pg_largeobject>.
+ pg_largeobject.
- pg_largeobject_metadata> Columns
+ pg_largeobject_metadata Columns
@@ -4299,14 +4299,14 @@ SCRAM-SHA-256$<iteration count>>:<salt><
- The catalog pg_namespace> stores namespaces.
+ The catalog pg_namespace stores namespaces.
A namespace is the structure underlying SQL schemas: each namespace
can have a separate collection of relations, types, etc. without name
conflicts.