tables. You can drop and recreate the tables, add columns, insert
and update values, and severely mess up your system that way.
Normally, one should not change the system catalogs by hand, there
- are always SQL commands to do that. (For example, <command>CREATE
+ are normally SQL commands to do that. (For example, <command>CREATE
DATABASE</command> inserts a row into the
<structname>pg_database</structname> catalog — and actually
creates the database on disk.) There are some exceptions for
- particularly esoteric operations, such as adding index access methods.
+ particularly esoteric operations, but many of those have been made
+ available as SQL commands over time, and so the need for direct manipulation
+ of the system catalogs is ever decreasing.
</para>
<sect1 id="catalogs-overview">
<entry>table inheritance hierarchy</entry>
</row>
+ <row>
+ <entry><link linkend="catalog-pg-init-privs"><structname>pg_init_privs</structname></link></entry>
+ <entry>object initial privileges</entry>
+ </row>
+
<row>
<entry><link linkend="catalog-pg-language"><structname>pg_language</structname></link></entry>
<entry>languages for writing functions</entry>
<entry>access method operator families</entry>
</row>
+ <row>
+ <entry><link linkend="catalog-pg-partitioned-table"><structname>pg_partitioned_table</structname></link></entry>
+ <entry>information about partition key of tables</entry>
+ </row>
+
<row>
<entry><link linkend="catalog-pg-pltemplate"><structname>pg_pltemplate</structname></link></entry>
<entry>template data for procedural languages</entry>
</row>
<row>
- <entry><link linkend="catalog-pg-range"><structname>pg_range</structname></link></entry>
- <entry>information about range types</entry>
+ <entry><link linkend="catalog-pg-publication"><structname>pg_publication</structname></link></entry>
+ <entry>publications for logical replication</entry>
</row>
<row>
- <entry><link linkend="catalog-pg-rewrite"><structname>pg_rewrite</structname></link></entry>
- <entry>query rewrite rules</entry>
+ <entry><link linkend="catalog-pg-publication-rel"><structname>pg_publication_rel</structname></link></entry>
+ <entry>relation to publication mapping</entry>
</row>
<row>
- <entry><link linkend="catalog-pg-replication-origin"><structname>pg_replication_origin</structname></link></entry>
- <entry>registered replication origins</entry>
+ <entry><link linkend="catalog-pg-range"><structname>pg_range</structname></link></entry>
+ <entry>information about range types</entry>
</row>
<row>
- <entry><link linkend="catalog-pg-replication-origin-status"><structname>pg_replication_origin_status</structname></link></entry>
- <entry>information about replication origins, including replication progress</entry>
+ <entry><link linkend="catalog-pg-replication-origin"><structname>pg_replication_origin</structname></link></entry>
+ <entry>registered replication origins</entry>
</row>
<row>
- <entry><link linkend="catalog-pg-replication-slots"><structname>pg_replication_slots</structname></link></entry>
- <entry>replication slot information</entry>
+ <entry><link linkend="catalog-pg-rewrite"><structname>pg_rewrite</structname></link></entry>
+ <entry>query rewrite rules</entry>
</row>
<row>
<entry>security labels on database objects</entry>
</row>
+ <row>
+ <entry><link linkend="catalog-pg-sequence"><structname>pg_sequence</structname></link></entry>
+ <entry>information about sequences</entry>
+ </row>
+
<row>
<entry><link linkend="catalog-pg-shdepend"><structname>pg_shdepend</structname></link></entry>
<entry>dependencies on shared objects</entry>
</row>
<row>
- <entry><link linkend="catalog-pg-tablesample-method"><structname>pg_tablesample_method</structname></link></entry>
- <entry>table sampling methods</entry>
+ <entry><link linkend="catalog-pg-statistic-ext"><structname>pg_statistic_ext</structname></link></entry>
+ <entry>extended planner statistics</entry>
+ </row>
+
+ <row>
+ <entry><link linkend="catalog-pg-subscription"><structname>pg_subscription</structname></link></entry>
+ <entry>logical replication subscriptions</entry>
+ </row>
+
+ <row>
+ <entry><link linkend="catalog-pg-subscription-rel"><structname>pg_subscription_rel</structname></link></entry>
+ <entry>relation state for subscriptions</entry>
</row>
<row>
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
<entry>Final function (zero if none)</entry>
</row>
+ <row>
+ <entry><structfield>aggcombinefn</structfield></entry>
+ <entry><type>regproc</type></entry>
+ <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
+ <entry>Combine function (zero if none)</entry>
+ </row>
+ <row>
+ <entry><structfield>aggserialfn</structfield></entry>
+ <entry><type>regproc</type></entry>
+ <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
+ <entry>Serialization function (zero if none)</entry>
+ </row>
+ <row>
+ <entry><structfield>aggdeserialfn</structfield></entry>
+ <entry><type>regproc</type></entry>
+ <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
+ <entry>Deserialization function (zero if none)</entry>
+ </row>
<row>
<entry><structfield>aggmtransfn</structfield></entry>
<entry><type>regproc</type></entry>
</indexterm>
<para>
- The catalog <structname>pg_am</structname> stores information about index
- access methods. There is one row for each index access method supported by
- the system. The contents of this catalog are discussed in detail in
- <xref linkend="indexam">.
+ The catalog <structname>pg_am</structname> stores information about
+ relation access methods. There is one row for each access method supported
+ by the system.
+ Currently, only indexes have access methods. The requirements for index
+ access methods are discussed in detail in <xref linkend="indexam">.
</para>
<table>
</row>
<row>
- <entry><structfield>amstrategies</structfield></entry>
- <entry><type>int2</type></entry>
- <entry></entry>
- <entry>Number of operator strategies for this access method,
- or zero if access method does not have a fixed set of operator
- strategies</entry>
- </row>
-
- <row>
- <entry><structfield>amsupport</structfield></entry>
- <entry><type>int2</type></entry>
- <entry></entry>
- <entry>Number of support routines for this access method</entry>
- </row>
-
- <row>
- <entry><structfield>amcanorder</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Does the access method support ordered scans sorted by the
- indexed column's value?</entry>
- </row>
-
- <row>
- <entry><structfield>amcanorderbyop</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Does the access method support ordered scans sorted by the result
- of an operator on the indexed column?</entry>
- </row>
-
- <row>
- <entry><structfield>amcanbackward</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Does the access method support backward scanning?</entry>
- </row>
-
- <row>
- <entry><structfield>amcanunique</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Does the access method support unique indexes?</entry>
- </row>
-
- <row>
- <entry><structfield>amcanmulticol</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Does the access method support multicolumn indexes?</entry>
- </row>
-
- <row>
- <entry><structfield>amoptionalkey</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Does the access method support a scan without any constraint
- for the first index column?</entry>
- </row>
-
- <row>
- <entry><structfield>amsearcharray</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Does the access method support <literal>ScalarArrayOpExpr</> searches?</entry>
- </row>
-
- <row>
- <entry><structfield>amsearchnulls</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Does the access method support <literal>IS NULL</>/<literal>NOT NULL</> searches?</entry>
- </row>
-
- <row>
- <entry><structfield>amstorage</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Can index storage data type differ from column data type?</entry>
- </row>
-
- <row>
- <entry><structfield>amclusterable</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Can an index of this type be clustered on?</entry>
- </row>
-
- <row>
- <entry><structfield>ampredlocks</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>Does an index of this type manage fine-grained predicate locks?</entry>
- </row>
-
- <row>
- <entry><structfield>amkeytype</structfield></entry>
- <entry><type>oid</type></entry>
- <entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
- <entry>Type of data stored in index, or zero if not a fixed type</entry>
- </row>
-
- <row>
- <entry><structfield>aminsert</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Insert this tuple</quote> function</entry>
- </row>
-
- <row>
- <entry><structfield>ambeginscan</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Prepare for index scan</quote> function</entry>
- </row>
-
- <row>
- <entry><structfield>amgettuple</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Next valid tuple</quote> function, or zero if none</entry>
- </row>
-
- <row>
- <entry><structfield>amgetbitmap</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Fetch all valid tuples</quote> function, or zero if none</entry>
- </row>
-
- <row>
- <entry><structfield>amrescan</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>(Re)start index scan</quote> function</entry>
- </row>
-
- <row>
- <entry><structfield>amendscan</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Clean up after index scan</quote> function</entry>
- </row>
-
- <row>
- <entry><structfield>ammarkpos</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Mark current scan position</quote> function</entry>
- </row>
-
- <row>
- <entry><structfield>amrestrpos</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Restore marked scan position</quote> function</entry>
- </row>
-
- <row>
- <entry><structfield>ambuild</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Build new index</quote> function</entry>
- </row>
-
- <row>
- <entry><structfield>ambuildempty</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Build empty index</quote> function</entry>
- </row>
-
- <row>
- <entry><structfield>ambulkdelete</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry>Bulk-delete function</entry>
- </row>
-
- <row>
- <entry><structfield>amvacuumcleanup</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry>Post-<command>VACUUM</command> cleanup function</entry>
- </row>
-
- <row>
- <entry><structfield>amcanreturn</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry>Function to check whether an index column supports index-only
- scans. Can be zero if index-only scans are never supported.</entry>
- </row>
-
- <row>
- <entry><structfield>amcostestimate</structfield></entry>
+ <entry><structfield>amhandler</structfield></entry>
<entry><type>regproc</type></entry>
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry>Function to estimate cost of an index scan</entry>
+ <entry>
+ OID of a handler function that is responsible for supplying information
+ about the access method
+ </entry>
</row>
<row>
- <entry><structfield>amoptions</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry>Function to parse and validate <structfield>reloptions</> for an index</entry>
+ <entry><structfield>amtype</structfield></entry>
+ <entry><type>char</type></entry>
+ <entry></entry>
+ <entry>
+ Currently always <literal>i</literal> to indicate an index access
+ method; other values may be allowed in future
+ </entry>
</row>
-
</tbody>
</tgroup>
</table>
+ <note>
+ <para>
+ Before <productname>PostgreSQL</> 9.6, <structname>pg_am</structname>
+ contained many additional columns representing properties of index access
+ methods. That data is now only directly visible at the C code level.
+ However, <function>pg_index_column_has_property()</function> and related
+ functions have been added to allow SQL queries to inspect index access
+ method properties; see <xref linkend="functions-info-catalog-table">.
+ </para>
+ </note>
+
</sect1>
</entry>
</row>
+ <row>
+ <entry><structfield>attidentity</structfield></entry>
+ <entry><type>char</type></entry>
+ <entry></entry>
+ <entry>
+ If a zero byte (<literal>''</literal>), then not an identity column.
+ Otherwise, <literal>a</literal> = generated
+ always, <literal>d</literal> = generated by default.
+ </entry>
+ </row>
+
<row>
<entry><structfield>attisdropped</structfield></entry>
<entry><type>bool</type></entry>
<entry><structfield>rolbypassrls</structfield></entry>
<entry><type>bool</type></entry>
<entry>
- Role can bypass row level security policies, see
+ Role bypasses every row level security policy, see
<xref linkend="ddl-rowsecurity"> for more information.
</entry>
</row>
<entry><structfield>rolpassword</structfield></entry>
<entry><type>text</type></entry>
<entry>
- Password (possibly encrypted); null if none. If the password
- is encrypted, this column will begin with the string <literal>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 <literal>joe</> has password <literal>xyzzy</>,
- <productname>PostgreSQL</> will store the md5 hash of
- <literal>xyzzyjoe</>. A password that does not follow that
- format is assumed to be unencrypted.
+ Password (possibly encrypted); null if none. The format depends
+ on the form of encryption used.
</entry>
</row>
</tgroup>
</table>
+ <para>
+ For an MD5 encrypted password, <structfield>rolpassword</structfield>
+ column will begin with the string <literal>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
+ <literal>joe</> has password <literal>xyzzy</>, <productname>PostgreSQL</>
+ will store the md5 hash of <literal>xyzzyjoe</>.
+ </para>
+
+ <para>
+ If the password is encrypted with SCRAM-SHA-256, it has the format:
+<synopsis>
+SCRAM-SHA-256$<replaceable><iteration count></>:<replaceable><salt></>$<replaceable><StoredKey></>:<replaceable><ServerKey></>
+</synopsis>
+ where <replaceable>salt</>, <replaceable>StoredKey</> and
+ <replaceable>ServerKey</> are in Base64 encoded format. This format is
+ the same as that specified by RFC 5803.
+ </para>
+
+ <para>
+ A password that does not follow either of those formats is assumed to be
+ unencrypted.
+ </para>
</sect1>
The catalog <structname>pg_class</structname> catalogs tables and most
everything else that has columns or is otherwise similar to a
table. This includes indexes (but see also
- <structname>pg_index</structname>), sequences, views, materialized
+ <structname>pg_index</structname>), sequences (but see also
+ <structname>pg_sequence</structname>), views, materialized
views, composite types, and TOAST tables; see <structfield>relkind</>.
Below, when we mean all of these
kinds of objects we speak of <quote>relations</quote>. Not all
<entry><type>char</type></entry>
<entry></entry>
<entry>
- <literal>r</> = ordinary table, <literal>i</> = index,
- <literal>S</> = sequence, <literal>v</> = view,
+ <literal>r</> = ordinary table,
+ <literal>i</> = index,
+ <literal>S</> = sequence,
+ <literal>t</> = TOAST table,
+ <literal>v</> = view,
<literal>m</> = materialized view,
- <literal>c</> = composite type, <literal>t</> = TOAST table,
- <literal>f</> = foreign table
+ <literal>c</> = composite type,
+ <literal>f</> = foreign table,
+ <literal>p</> = partitioned table
</entry>
</row>
</entry>
</row>
+ <row>
+ <entry><structfield>relforcerowsecurity</structfield></entry>
+ <entry><type>bool</type></entry>
+ <entry></entry>
+ <entry>
+ True if row level security (when enabled) will also apply to table owner; see
+ <link linkend="catalog-pg-policy"><structname>pg_policy</structname></link> catalog
+ </entry>
+ </row>
+
<row>
<entry><structfield>relispopulated</structfield></entry>
<entry><type>bool</type></entry>
</entry>
</row>
+ <row>
+ <entry><structfield>relispartition</structfield></entry>
+ <entry><type>bool</type></entry>
+ <entry></entry>
+ <entry>True if table is a partition</entry>
+ </row>
+
<row>
<entry><structfield>relfrozenxid</structfield></entry>
<entry><type>xid</type></entry>
All transaction IDs before this one have been replaced with a permanent
(<quote>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 <literal>pg_clog</> to be shrunk. Zero
+ ID wraparound or to allow <literal>pg_xact</> to be shrunk. Zero
(<symbol>InvalidTransactionId</symbol>) if the relation is not a table.
</entry>
</row>
<entry><type>xid</type></entry>
<entry></entry>
<entry>
- All multitransaction IDs before this one have been replaced by a
+ 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 multitransaction ID
- ID wraparound or to allow <literal>pg_clog</> to be shrunk. Zero
- (<symbol>InvalidTransactionId</symbol>) if the relation is not a table.
+ whether the table needs to be vacuumed in order to prevent multixact ID
+ wraparound or to allow <literal>pg_multixact</> to be shrunk. Zero
+ (<symbol>InvalidMultiXactId</symbol>) if the relation is not a table.
</entry>
</row>
Access-method-specific options, as <quote>keyword=value</> strings
</entry>
</row>
+
+ <row>
+ <entry><structfield>relpartbound</structfield></entry>
+ <entry><type>pg_node_tree</type></entry>
+ <entry></entry>
+ <entry>
+ If table is a partition (see <structfield>relispartition</structfield>),
+ internal representation of the partition bound
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
<entry>Owner of the collation</entry>
</row>
+ <row>
+ <entry><structfield>collprovider</structfield></entry>
+ <entry><type>char</type></entry>
+ <entry></entry>
+ <entry>Provider of the collation: <literal>d</literal> = database
+ default, <literal>c</literal> = libc, <literal>i</literal> = icu</entry>
+ </row>
+
<row>
<entry><structfield>collencoding</structfield></entry>
<entry><type>int4</type></entry>
<entry></entry>
<entry><symbol>LC_CTYPE</> for this collation object</entry>
</row>
+
+ <row>
+ <entry><structfield>collversion</structfield></entry>
+ <entry><type>text</type></entry>
+ <entry></entry>
+ <entry>
+ Provider-specific version of the collation. This is recorded when the
+ collation is created and then checked when it is used, to detect
+ changes in the collation definition that could lead to data corruption.
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
All transaction IDs before this one have been replaced with a permanent
(<quote>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 <literal>pg_clog</> to be shrunk.
+ transaction ID wraparound or to allow <literal>pg_xact</> to be shrunk.
It is the minimum of the per-table
<structname>pg_class</>.<structfield>relfrozenxid</> values.
</entry>
<entry><type>xid</type></entry>
<entry></entry>
<entry>
- All multitransaction IDs before this one have been replaced with a
+ 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
- transaction ID wraparound or to allow <literal>pg_clog</> to be shrunk.
+ multixact ID wraparound or to allow <literal>pg_multixact</> to be shrunk.
It is the minimum of the per-table
<structname>pg_class</>.<structfield>relminmxid</> values.
</entry>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><symbol>DEPENDENCY_AUTO_EXTENSION</> (<literal>x</>)</term>
+ <listitem>
+ <para>
+ The dependent object is not a member of the extension that is the
+ referenced object (and so should not be ignored by pg_dump), but
+ cannot function without it and should be dropped when the
+ extension itself is. The dependent object may be dropped on its
+ own as well.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><symbol>DEPENDENCY_PIN</> (<literal>p</>)</term>
<listitem>
<entry><literal><link linkend="catalog-pg-collation"><structname>pg_collation</structname></link>.oid</literal></entry>
<entry>
For each column in the index key, this contains the OID of the
- collation to use for the index.
+ collation to use for the index, or zero if the column is not
+ of a collatable data type.
</entry>
</row>
</sect1>
+ <sect1 id="catalog-pg-init-privs">
+ <title><structname>pg_init_privs</structname></title>
- <sect1 id="catalog-pg-language">
- <title><structname>pg_language</structname></title>
-
- <indexterm zone="catalog-pg-language">
- <primary>pg_language</primary>
+ <indexterm zone="catalog-pg-init-privs">
+ <primary>pg_init_privs</primary>
</indexterm>
<para>
- The catalog <structname>pg_language</structname> registers
- languages in which you can write functions or stored procedures.
- See <xref linkend="sql-createlanguage">
- and <xref linkend="xplang"> for more information about language handlers.
+ The catalog <structname>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.
</para>
- <table>
+ <para>
+ Objects can have initial privileges either by having those privileges set
+ when the system is initialized (by <application>initdb</>) or when the
+ object is created during a <command>CREATE EXTENSION</command> and the
+ extension script sets initial privileges using the <command>GRANT</command>
+ system. Note that the system will automatically handle recording of the
+ privileges during the extension script and that extension authors need
+ only use the <command>GRANT</command> and <command>REVOKE</command>
+ statements in their script to have the privileges recorded. The
+ <literal>privtype</literal> column indicates if the initial privilege was
+ set by <application>initdb</> or during a
+ <command>CREATE EXTENSION</command> command.
+ </para>
+
+ <para>
+ Objects which have initial privileges set by <application>initdb</> will
+ have entries where <literal>privtype</literal> is
+ <literal>'i'</literal>, while objects which have initial privileges set
+ by <command>CREATE EXTENSION</command> will have entries where
+ <literal>privtype</literal> is <literal>'e'</literal>.
+ </para>
+
+ <table>
+ <title><structname>pg_init_privs</> Columns</title>
+
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry><structfield>objoid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry>any OID column</entry>
+ <entry>The OID of the specific object</entry>
+ </row>
+
+ <row>
+ <entry><structfield>classoid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
+ <entry>The OID of the system catalog the object is in</entry>
+ </row>
+
+ <row>
+ <entry><structfield>objsubid</structfield></entry>
+ <entry><type>int4</type></entry>
+ <entry></entry>
+ <entry>
+ For a table column, this is the column number (the
+ <structfield>objoid</> and <structfield>classoid</> refer to the
+ table itself). For all other object types, this column is
+ zero.
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>privtype</structfield></entry>
+ <entry><type>char</type></entry>
+ <entry></entry>
+ <entry>
+ A code defining the type of initial privilege of this object; see text
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>initprivs</structfield></entry>
+ <entry><type>aclitem[]</type></entry>
+ <entry></entry>
+ <entry>
+ The initial access privileges; see
+ <xref linkend="sql-grant"> and
+ <xref linkend="sql-revoke">
+ for details
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ </sect1>
+
+
+ <sect1 id="catalog-pg-language">
+ <title><structname>pg_language</structname></title>
+
+ <indexterm zone="catalog-pg-language">
+ <primary>pg_language</primary>
+ </indexterm>
+
+ <para>
+ The catalog <structname>pg_language</structname> registers
+ languages in which you can write functions or stored procedures.
+ See <xref linkend="sql-createlanguage">
+ and <xref linkend="xplang"> for more information about language handlers.
+ </para>
+
+ <table>
<title><structname>pg_language</> Columns</title>
<tgroup cols="4">
</table>
</sect1>
+
<sect1 id="catalog-pg-namespace">
<title><structname>pg_namespace</structname></title>
</sect1>
+ <sect1 id="catalog-pg-partitioned-table">
+ <title><structname>pg_partitioned_table</structname></title>
+
+ <indexterm zone="catalog-pg-partitioned-table">
+ <primary>pg_partitioned_table</primary>
+ </indexterm>
+
+ <para>
+ The catalog <structname>pg_partitioned_table</structname> stores
+ information about how tables are partitioned.
+ </para>
+
+ <table>
+ <title><structname>pg_partitioned_table</> Columns</title>
+
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry><structfield>partrelid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
+ <entry>The OID of the <structname>pg_class</> entry for this partitioned table</entry>
+ </row>
+
+ <row>
+ <entry><structfield>partstrat</structfield></entry>
+ <entry><type>char</type></entry>
+ <entry></entry>
+ <entry>
+ Partitioning strategy; <literal>l</> = list partitioned table,
+ <literal>r</> = range partitioned table
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>partnatts</structfield></entry>
+ <entry><type>int2</type></entry>
+ <entry></entry>
+ <entry>The number of columns in partition key</entry>
+ </row>
+
+ <row>
+ <entry><structfield>partattrs</structfield></entry>
+ <entry><type>int2vector</type></entry>
+ <entry><literal><link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.attnum</literal></entry>
+ <entry>
+ This is an array of <structfield>partnatts</structfield> values that
+ indicate which table columns are part of the partition key. For
+ example, a value of <literal>1 3</literal> would mean that the first
+ and the third table columns make up the partition key. A zero in this
+ array indicates that the corresponding partition key column is an
+ expression, rather than a simple column reference.
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>partclass</structfield></entry>
+ <entry><type>oidvector</type></entry>
+ <entry><literal><link linkend="catalog-pg-opclass"><structname>pg_opclass</structname></link>.oid</literal></entry>
+ <entry>
+ For each column in the partition key, this contains the OID of the
+ operator class to use. See
+ <link linkend="catalog-pg-opclass"><structname>pg_opclass</structname></link> for details.
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>partcollation</structfield></entry>
+ <entry><type>oidvector</type></entry>
+ <entry><literal><link linkend="catalog-pg-opclass"><structname>pg_opclass</structname></link>.oid</literal></entry>
+ <entry>
+ For each column in the partition key, this contains the OID of the
+ collation to use for partitioning, or zero if the column is not
+ of a collatable data type.
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>partexprs</structfield></entry>
+ <entry><type>pg_node_tree</type></entry>
+ <entry></entry>
+ <entry>
+ Expression trees (in <function>nodeToString()</function>
+ representation) for partition key columns that are not simple column
+ references. This is a list with one element for each zero
+ entry in <structfield>partattrs</>. Null if all partition key columns
+ are simple references.
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </sect1>
+
+
<sect1 id="catalog-pg-pltemplate">
<title><structname>pg_pltemplate</structname></title>
</sect1>
+
<sect1 id="catalog-pg-policy">
<title><structname>pg_policy</structname></title>
or <literal>*</> for all</entry>
</row>
+ <row>
+ <entry><structfield>polpermissive</structfield></entry>
+ <entry><type>boolean</type></entry>
+ <entry></entry>
+ <entry>Is the policy permissive or restrictive?</entry>
+ </row>
+
<row>
<entry><structfield>polroles</structfield></entry>
<entry><type>oid[]</type></entry>
</entry>
</row>
+ <row>
+ <entry><structfield>proparallel</structfield></entry>
+ <entry><type>char</type></entry>
+ <entry></entry>
+ <entry>
+ <structfield>proparallel</structfield> tells whether the function
+ can be safely run in parallel mode.
+ It is <literal>s</literal> for functions which are safe to run in
+ parallel mode without restriction.
+ It is <literal>r</literal> for functions which can be run in parallel
+ mode, but their execution is restricted to the parallel group leader;
+ parallel worker processes cannot invoke these functions.
+ It is <literal>u</literal> for functions which are unsafe in parallel
+ mode; the presence of such a function forces a serial execution plan.
+ </entry>
+ </row>
+
<row>
<entry><structfield>pronargs</structfield></entry>
<entry><type>int2</type></entry>
</sect1>
- <sect1 id="catalog-pg-range">
- <title><structname>pg_range</structname></title>
+ <sect1 id="catalog-pg-publication">
+ <title><structname>pg_publication</structname></title>
- <indexterm zone="catalog-pg-range">
- <primary>pg_range</primary>
+ <indexterm zone="catalog-pg-publication">
+ <primary>pg_publication</primary>
</indexterm>
<para>
- The catalog <structname>pg_range</structname> stores information about
- range types. This is in addition to the types' entries in
- <link linkend="catalog-pg-type"><structname>pg_type</structname></link>.
+ The catalog <structname>pg_publication</structname> contains all
+ publications created in the database. For more on publications see
+ <xref linkend="logical-replication-publication">.
</para>
<table>
- <title><structname>pg_range</> Columns</title>
+ <title><structname>pg_publication</structname> Columns</title>
<tgroup cols="4">
<thead>
<tbody>
<row>
- <entry><structfield>rngtypid</structfield></entry>
+ <entry><structfield>oid</structfield></entry>
<entry><type>oid</type></entry>
- <entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
- <entry>OID of the range type</entry>
+ <entry></entry>
+ <entry>Row identifier (hidden attribute; must be explicitly selected)</entry>
</row>
<row>
- <entry><structfield>rngsubtype</structfield></entry>
- <entry><type>oid</type></entry>
- <entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
- <entry>OID of the element type (subtype) of this range type</entry>
+ <entry><structfield>pubname</structfield></entry>
+ <entry><type>Name</type></entry>
+ <entry></entry>
+ <entry>Name of the publication</entry>
</row>
<row>
- <entry><structfield>rngcollation</structfield></entry>
+ <entry><structfield>pubowner</structfield></entry>
<entry><type>oid</type></entry>
- <entry><literal><link linkend="catalog-pg-collation"><structname>pg_collation</structname></link>.oid</literal></entry>
- <entry>OID of the collation used for range comparisons, or 0 if none</entry>
+ <entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
+ <entry>Owner of the publication</entry>
</row>
<row>
- <entry><structfield>rngsubopc</structfield></entry>
- <entry><type>oid</type></entry>
- <entry><literal><link linkend="catalog-pg-opclass"><structname>pg_opclass</structname></link>.oid</literal></entry>
- <entry>OID of the subtype's operator class used for range comparisons</entry>
+ <entry><structfield>puballtables</structfield></entry>
+ <entry><type>bool</type></entry>
+ <entry></entry>
+ <entry>If true, this publication automatically includes all tables
+ in the database, including any that will be created in the future.
+ </entry>
</row>
<row>
- <entry><structfield>rngcanonical</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry>OID of the function to convert a range value into canonical form,
- or 0 if none</entry>
+ <entry><structfield>pubinsert</structfield></entry>
+ <entry><type>bool</type></entry>
+ <entry></entry>
+ <entry>If true, <command>INSERT</command> operations are replicated for
+ tables in the publication.</entry>
</row>
<row>
- <entry><structfield>rngsubdiff</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry>OID of the function to return the difference between two element
- values as <type>double precision</type>, or 0 if none</entry>
+ <entry><structfield>pubupdate</structfield></entry>
+ <entry><type>bool</type></entry>
+ <entry></entry>
+ <entry>If true, <command>UPDATE</command> operations are replicated for
+ tables in the publication.</entry>
+ </row>
+
+ <row>
+ <entry><structfield>pubdelete</structfield></entry>
+ <entry><type>bool</type></entry>
+ <entry></entry>
+ <entry>If true, <command>DELETE</command> operations are replicated for
+ tables in the publication.</entry>
</row>
</tbody>
</tgroup>
</table>
-
- <para>
- <structfield>rngsubopc</> (plus <structfield>rngcollation</>, if the
- element type is collatable) determines the sort ordering used by the range
- type. <structfield>rngcanonical</> is used when the element type is
- discrete. <structfield>rngsubdiff</> is optional but should be supplied to
- improve performance of GiST indexes on the range type.
- </para>
-
</sect1>
- <sect1 id="catalog-pg-rewrite">
- <title><structname>pg_rewrite</structname></title>
+ <sect1 id="catalog-pg-publication-rel">
+ <title><structname>pg_publication_rel</structname></title>
- <indexterm zone="catalog-pg-rewrite">
- <primary>pg_rewrite</primary>
+ <indexterm zone="catalog-pg-publication-rel">
+ <primary>pg_publication_rel</primary>
</indexterm>
<para>
- The catalog <structname>pg_rewrite</structname> stores rewrite rules for tables and views.
+ The catalog <structname>pg_publication_rel</structname> contains the
+ mapping between relations and publications in the database. This is a
+ many-to-many mapping. See also <xref linkend="view-pg-publication-tables">
+ for a more user-friendly view of this information.
</para>
<table>
- <title><structname>pg_rewrite</> Columns</title>
+ <title><structname>pg_publication_rel</structname> Columns</title>
<tgroup cols="4">
<thead>
<tbody>
<row>
- <entry><structfield>oid</structfield></entry>
+ <entry><structfield>prpubid</structfield></entry>
<entry><type>oid</type></entry>
- <entry></entry>
- <entry>Row identifier (hidden attribute; must be explicitly selected)</entry>
- </row>
-
- <row>
- <entry><structfield>rulename</structfield></entry>
- <entry><type>name</type></entry>
- <entry></entry>
- <entry>Rule name</entry>
+ <entry><literal><link linkend="catalog-pg-publication"><structname>pg_publication</structname></link>.oid</literal></entry>
+ <entry>Reference to publication</entry>
</row>
<row>
- <entry><structfield>ev_class</structfield></entry>
+ <entry><structfield>prrelid</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
- <entry>The table this rule is for</entry>
+ <entry>Reference to relation</entry>
</row>
+ </tbody>
+ </tgroup>
+ </table>
+ </sect1>
- <row>
- <entry><structfield>ev_type</structfield></entry>
- <entry><type>char</type></entry>
- <entry></entry>
- <entry>
- Event type that the rule is for: 1 = <command>SELECT</>, 2 =
- <command>UPDATE</>, 3 = <command>INSERT</>, 4 =
- <command>DELETE</>
- </entry>
+ <sect1 id="catalog-pg-range">
+ <title><structname>pg_range</structname></title>
+
+ <indexterm zone="catalog-pg-range">
+ <primary>pg_range</primary>
+ </indexterm>
+
+ <para>
+ The catalog <structname>pg_range</structname> stores information about
+ range types. This is in addition to the types' entries in
+ <link linkend="catalog-pg-type"><structname>pg_type</structname></link>.
+ </para>
+
+ <table>
+ <title><structname>pg_range</> Columns</title>
+
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
</row>
+ </thead>
+ <tbody>
<row>
- <entry><structfield>ev_enabled</structfield></entry>
- <entry><type>char</type></entry>
- <entry></entry>
- <entry>
- Controls in which <xref linkend="guc-session-replication-role"> modes
- the rule fires.
- <literal>O</> = rule fires in <quote>origin</> and <quote>local</> modes,
- <literal>D</> = rule is disabled,
- <literal>R</> = rule fires in <quote>replica</> mode,
- <literal>A</> = rule fires always.
- </entry>
+ <entry><structfield>rngtypid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
+ <entry>OID of the range type</entry>
</row>
<row>
- <entry><structfield>is_instead</structfield></entry>
- <entry><type>bool</type></entry>
- <entry></entry>
- <entry>True if the rule is an <literal>INSTEAD</literal> rule</entry>
+ <entry><structfield>rngsubtype</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
+ <entry>OID of the element type (subtype) of this range type</entry>
</row>
<row>
- <entry><structfield>ev_qual</structfield></entry>
- <entry><type>pg_node_tree</type></entry>
- <entry></entry>
- <entry>
- Expression tree (in the form of a
- <function>nodeToString()</function> representation) for the
- rule's qualifying condition
- </entry>
+ <entry><structfield>rngcollation</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-collation"><structname>pg_collation</structname></link>.oid</literal></entry>
+ <entry>OID of the collation used for range comparisons, or 0 if none</entry>
</row>
<row>
- <entry><structfield>ev_action</structfield></entry>
- <entry><type>pg_node_tree</type></entry>
- <entry></entry>
- <entry>
- Query tree (in the form of a
- <function>nodeToString()</function> representation) for the
- rule's action
- </entry>
+ <entry><structfield>rngsubopc</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-opclass"><structname>pg_opclass</structname></link>.oid</literal></entry>
+ <entry>OID of the subtype's operator class used for range comparisons</entry>
+ </row>
+
+ <row>
+ <entry><structfield>rngcanonical</structfield></entry>
+ <entry><type>regproc</type></entry>
+ <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
+ <entry>OID of the function to convert a range value into canonical form,
+ or 0 if none</entry>
+ </row>
+
+ <row>
+ <entry><structfield>rngsubdiff</structfield></entry>
+ <entry><type>regproc</type></entry>
+ <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
+ <entry>OID of the function to return the difference between two element
+ values as <type>double precision</type>, or 0 if none</entry>
</row>
</tbody>
</tgroup>
</table>
- <note>
- <para>
- <literal>pg_class.relhasrules</literal>
- must be true if a table has any rules in this catalog.
- </para>
- </note>
+ <para>
+ <structfield>rngsubopc</> (plus <structfield>rngcollation</>, if the
+ element type is collatable) determines the sort ordering used by the range
+ type. <structfield>rngcanonical</> is used when the element type is
+ discrete. <structfield>rngsubdiff</> is optional but should be supplied to
+ improve performance of GiST indexes on the range type.
+ </para>
</sect1>
</table>
</sect1>
- <sect1 id="catalog-pg-replication-origin-status">
- <title><structname>pg_replication_origin_status</structname></title>
-
- <indexterm zone="catalog-pg-replication-origin-status">
- <primary>pg_replication_origin_status</primary>
- </indexterm>
-
- <para>
- The <structname>pg_replication_origin_status</structname> view
- contains information about how far replay for a certain origin has
- progressed. For more on replication origins
- see <xref linkend="replication-origins">.
- </para>
-
- <table>
-
- <title><structname>pg_replication_origin_status</structname> Columns</title>
-
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>References</entry>
- <entry>Description</entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry><structfield>local_id</structfield></entry>
- <entry><type>Oid</type></entry>
- <entry><literal><link linkend="catalog-pg-replication-origin"><structname>pg_replication_origin</structname></link>.roident</literal></entry>
- <entry>internal node identifier</entry>
- </row>
-
- <row>
- <entry><structfield>external_id</structfield></entry>
- <entry><type>text</type></entry>
- <entry><literal><link linkend="catalog-pg-replication-origin"><structname>pg_replication_origin</structname></link>.roname</literal></entry>
- <entry>external node identifier</entry>
- </row>
-
- <row>
- <entry><structfield>remote_lsn</structfield></entry>
- <entry><type>pg_lsn</type></entry>
- <entry></entry>
- <entry>The origin node's LSN up to which data has been replicated.</entry>
- </row>
-
-
- <row>
- <entry><structfield>local_lsn</structfield></entry>
- <entry><type>pg_lsn</type></entry>
- <entry></entry>
- <entry>This node's LSN that at
- which <literal>remote_lsn</literal> has been replicated. Used to
- flush commit records before persisting data to disk when using
- asynchronous commits.</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </sect1>
-
- <sect1 id="catalog-pg-replication-slots">
- <title><structname>pg_replication_slots</structname></title>
+ <sect1 id="catalog-pg-rewrite">
+ <title><structname>pg_rewrite</structname></title>
- <indexterm zone="catalog-pg-replication-slots">
- <primary>pg_replication_slots</primary>
+ <indexterm zone="catalog-pg-rewrite">
+ <primary>pg_rewrite</primary>
</indexterm>
<para>
- The <structname>pg_replication_slots</structname> view provides a listing
- of all replication slots that currently exist on the database cluster,
- along with their current state.
- </para>
-
- <para>
- For more on replication slots,
- see <xref linkend="streaming-replication-slots"> and <xref linkend="logicaldecoding">.
+ The catalog <structname>pg_rewrite</structname> stores rewrite rules for tables and views.
</para>
<table>
-
- <title><structname>pg_replication_slots</structname> Columns</title>
+ <title><structname>pg_rewrite</> Columns</title>
<tgroup cols="4">
<thead>
<tbody>
<row>
- <entry><structfield>slot_name</structfield></entry>
- <entry><type>name</type></entry>
+ <entry><structfield>oid</structfield></entry>
+ <entry><type>oid</type></entry>
<entry></entry>
- <entry>A unique, cluster-wide identifier for the replication slot</entry>
+ <entry>Row identifier (hidden attribute; must be explicitly selected)</entry>
</row>
<row>
- <entry><structfield>plugin</structfield></entry>
+ <entry><structfield>rulename</structfield></entry>
<entry><type>name</type></entry>
<entry></entry>
- <entry>The base name of the shared object containing the output plugin this logical slot is using, or null for physical slots.</entry>
- </row>
-
- <row>
- <entry><structfield>slot_type</structfield></entry>
- <entry><type>text</type></entry>
- <entry></entry>
- <entry>The slot type - <literal>physical</> or <literal>logical</></entry>
+ <entry>Rule name</entry>
</row>
<row>
- <entry><structfield>datoid</structfield></entry>
+ <entry><structfield>ev_class</structfield></entry>
<entry><type>oid</type></entry>
- <entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.oid</literal></entry>
- <entry>The OID of the database this slot is associated with, or
- null. Only logical slots have an associated database.</entry>
- </row>
-
- <row>
- <entry><structfield>database</structfield></entry>
- <entry><type>text</type></entry>
- <entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.datname</literal></entry>
- <entry>The name of the database this slot is associated with, or
- null. Only logical slots have an associated database.</entry>
+ <entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
+ <entry>The table this rule is for</entry>
</row>
<row>
- <entry><structfield>active</structfield></entry>
- <entry><type>boolean</type></entry>
+ <entry><structfield>ev_type</structfield></entry>
+ <entry><type>char</type></entry>
<entry></entry>
- <entry>True if this slot is currently actively being used</entry>
+ <entry>
+ Event type that the rule is for: 1 = <command>SELECT</>, 2 =
+ <command>UPDATE</>, 3 = <command>INSERT</>, 4 =
+ <command>DELETE</>
+ </entry>
</row>
<row>
- <entry><structfield>active_pid</structfield></entry>
- <entry><type>integer</type></entry>
+ <entry><structfield>ev_enabled</structfield></entry>
+ <entry><type>char</type></entry>
<entry></entry>
- <entry>The process ID of the session using this slot if the slot
- is currently actively being used. <literal>NULL</literal> if
- inactive.
+ <entry>
+ Controls in which <xref linkend="guc-session-replication-role"> modes
+ the rule fires.
+ <literal>O</> = rule fires in <quote>origin</> and <quote>local</> modes,
+ <literal>D</> = rule is disabled,
+ <literal>R</> = rule fires in <quote>replica</> mode,
+ <literal>A</> = rule fires always.
</entry>
</row>
<row>
- <entry><structfield>xmin</structfield></entry>
- <entry><type>xid</type></entry>
+ <entry><structfield>is_instead</structfield></entry>
+ <entry><type>bool</type></entry>
<entry></entry>
- <entry>The oldest transaction that this slot needs the database to
- retain. <literal>VACUUM</literal> cannot remove tuples deleted
- by any later transaction.
- </entry>
+ <entry>True if the rule is an <literal>INSTEAD</literal> rule</entry>
</row>
<row>
- <entry><structfield>catalog_xmin</structfield></entry>
- <entry><type>xid</type></entry>
+ <entry><structfield>ev_qual</structfield></entry>
+ <entry><type>pg_node_tree</type></entry>
<entry></entry>
- <entry>The oldest transaction affecting the system catalogs that this
- slot needs the database to retain. <literal>VACUUM</literal> cannot
- remove catalog tuples deleted by any later transaction.
+ <entry>
+ Expression tree (in the form of a
+ <function>nodeToString()</function> representation) for the
+ rule's qualifying condition
</entry>
</row>
<row>
- <entry><structfield>restart_lsn</structfield></entry>
- <entry><type>pg_lsn</type></entry>
+ <entry><structfield>ev_action</structfield></entry>
+ <entry><type>pg_node_tree</type></entry>
<entry></entry>
- <entry>The address (<literal>LSN</literal>) of oldest WAL which still
- might be required by the consumer of this slot and thus won't be
- automatically removed during checkpoints.
+ <entry>
+ Query tree (in the form of a
+ <function>nodeToString()</function> representation) for the
+ rule's action
</entry>
</row>
</tbody>
</tgroup>
</table>
+
+ <note>
+ <para>
+ <literal>pg_class.relhasrules</literal>
+ must be true if a table has any rules in this catalog.
+ </para>
+ </note>
+
</sect1>
<sect1 id="catalog-pg-seclabel">
</table>
</sect1>
+ <sect1 id="catalog-pg-sequence">
+ <title><structname>pg_sequence</structname></title>
+
+ <indexterm zone="catalog-pg-sequence">
+ <primary>pg_sequence</primary>
+ </indexterm>
+
+ <para>
+ The catalog <structname>pg_sequence</structname> contains information about
+ sequences. Some of the information about sequences, such as the name and
+ the schema, is in <structname>pg_class</structname>.
+ </para>
+
+ <table>
+ <title><structname>pg_sequence</> Columns</title>
+
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry><structfield>seqrelid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
+ <entry>The OID of the <structname>pg_class</> entry for this sequence</entry>
+ </row>
+
+ <row>
+ <entry><structfield>seqtypid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
+ <entry>Data type of the sequence</entry>
+ </row>
+
+ <row>
+ <entry><structfield>seqstart</structfield></entry>
+ <entry><type>int8</type></entry>
+ <entry></entry>
+ <entry>Start value of the sequence</entry>
+ </row>
+
+ <row>
+ <entry><structfield>seqincrement</structfield></entry>
+ <entry><type>int8</type></entry>
+ <entry></entry>
+ <entry>Increment value of the sequence</entry>
+ </row>
+
+ <row>
+ <entry><structfield>seqmax</structfield></entry>
+ <entry><type>int8</type></entry>
+ <entry></entry>
+ <entry>Maximum value of the sequence</entry>
+ </row>
+
+ <row>
+ <entry><structfield>seqmin</structfield></entry>
+ <entry><type>int8</type></entry>
+ <entry></entry>
+ <entry>Minimum value of the sequence</entry>
+ </row>
+
+ <row>
+ <entry><structfield>seqcache</structfield></entry>
+ <entry><type>int8</type></entry>
+ <entry></entry>
+ <entry>Cache size of the sequence</entry>
+ </row>
+
+ <row>
+ <entry><structfield>seqcycle</structfield></entry>
+ <entry><type>bool</type></entry>
+ <entry></entry>
+ <entry>Whether the sequence cycles</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </sect1>
+
<sect1 id="catalog-pg-shdepend">
<title><structname>pg_shdepend</structname></title>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><symbol>SHARED_DEPENDENCY_POLICY</> (<literal>r</>)</term>
+ <listitem>
+ <para>
+ The referenced object (which must be a role) is mentioned as the
+ target of a dependent policy object.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><symbol>SHARED_DEPENDENCY_PIN</> (<literal>p</>)</term>
<listitem>
<entry>The number of distinct nonnull data values in the column.
A value greater than zero is the actual number of distinct values.
A value less than zero is the negative of a multiplier for the number
- of rows in the table; for example, a column in which values appear about
- twice on the average could be represented by
- <structfield>stadistinct</> = -0.5.
+ of rows in the table; for example, a column in which about 80% of the
+ values are nonnull and each nonnull value appears about twice on
+ average could be represented by <structfield>stadistinct</> = -0.4.
A zero value means the number of distinct values is unknown.
</entry>
</row>
<row>
- <entry><structfield>stakind<replaceable>N</></structfield></entry>
- <entry><type>int2</type></entry>
- <entry></entry>
+ <entry><structfield>stakind<replaceable>N</></structfield></entry>
+ <entry><type>int2</type></entry>
+ <entry></entry>
+ <entry>
+ A code number indicating the kind of statistics stored in the
+ <replaceable>N</>th <quote>slot</quote> of the
+ <structname>pg_statistic</structname> row.
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>staop<replaceable>N</></structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
+ <entry>
+ An operator used to derive the statistics stored in the
+ <replaceable>N</>th <quote>slot</quote>. For example, a
+ histogram slot would show the <literal><</literal> operator
+ that defines the sort order of the data.
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>stanumbers<replaceable>N</></structfield></entry>
+ <entry><type>float4[]</type></entry>
+ <entry></entry>
+ <entry>
+ Numerical statistics of the appropriate kind for the
+ <replaceable>N</>th <quote>slot</quote>, or null if the slot
+ kind does not involve numerical values
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>stavalues<replaceable>N</></structfield></entry>
+ <entry><type>anyarray</type></entry>
+ <entry></entry>
+ <entry>
+ Column data values of the appropriate kind for the
+ <replaceable>N</>th <quote>slot</quote>, or null if the slot
+ kind does not store any data values. Each array's element
+ values are actually of the specific column's data type, or a related
+ type such as an array's element type, so there is no way to define
+ these columns' type more specifically than <type>anyarray</>.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </sect1>
+
+ <sect1 id="catalog-pg-statistic-ext">
+ <title><structname>pg_statistic_ext</structname></title>
+
+ <indexterm zone="catalog-pg-statistic-ext">
+ <primary>pg_statistic_ext</primary>
+ </indexterm>
+
+ <para>
+ The catalog <structname>pg_statistic_ext</structname>
+ holds extended planner statistics.
+ Each row in this catalog corresponds to a <firstterm>statistics object</>
+ created with <xref linkend="sql-createstatistics">.
+ </para>
+
+ <table>
+ <title><structname>pg_statistic_ext</> Columns</title>
+
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry><structfield>stxrelid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
+ <entry>Table containing the columns described by this object</entry>
+ </row>
+
+ <row>
+ <entry><structfield>stxname</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry></entry>
+ <entry>Name of the statistics object</entry>
+ </row>
+
+ <row>
+ <entry><structfield>stxnamespace</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.oid</literal></entry>
+ <entry>
+ The OID of the namespace that contains this statistics object
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>stxowner</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
+ <entry>Owner of the statistics object</entry>
+ </row>
+
+ <row>
+ <entry><structfield>stxkeys</structfield></entry>
+ <entry><type>int2vector</type></entry>
+ <entry><literal><link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.attnum</literal></entry>
<entry>
- A code number indicating the kind of statistics stored in the
- <replaceable>N</>th <quote>slot</quote> of the
- <structname>pg_statistic</structname> row.
+ An array of attribute numbers, indicating which table columns are
+ covered by this statistics object;
+ for example a value of <literal>1 3</literal> would
+ mean that the first and the third table columns are covered
</entry>
</row>
<row>
- <entry><structfield>staop<replaceable>N</></structfield></entry>
- <entry><type>oid</type></entry>
- <entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
+ <entry><structfield>stxkind</structfield></entry>
+ <entry><type>char[]</type></entry>
+ <entry></entry>
<entry>
- An operator used to derive the statistics stored in the
- <replaceable>N</>th <quote>slot</quote>. For example, a
- histogram slot would show the <literal><</literal> operator
- that defines the sort order of the data.
+ An array containing codes for the enabled statistic types;
+ valid values are:
+ <literal>d</literal> for n-distinct statistics,
+ <literal>f</literal> for functional dependency statistics
</entry>
</row>
<row>
- <entry><structfield>stanumbers<replaceable>N</></structfield></entry>
- <entry><type>float4[]</type></entry>
+ <entry><structfield>stxndistinct</structfield></entry>
+ <entry><type>pg_ndistinct</type></entry>
<entry></entry>
<entry>
- Numerical statistics of the appropriate kind for the
- <replaceable>N</>th <quote>slot</quote>, or null if the slot
- kind does not involve numerical values
+ N-distinct counts, serialized as <structname>pg_ndistinct</> type
</entry>
</row>
<row>
- <entry><structfield>stavalues<replaceable>N</></structfield></entry>
- <entry><type>anyarray</type></entry>
+ <entry><structfield>stxdependencies</structfield></entry>
+ <entry><type>pg_dependencies</type></entry>
<entry></entry>
<entry>
- Column data values of the appropriate kind for the
- <replaceable>N</>th <quote>slot</quote>, or null if the slot
- kind does not store any data values. Each array's element
- values are actually of the specific column's data type, or a related
- type such as an array's element type, so there is no way to define
- these columns' type more specifically than <type>anyarray</>.
+ Functional dependency statistics, serialized
+ as <structname>pg_dependencies</> type
</entry>
</row>
+
</tbody>
</tgroup>
</table>
+ <para>
+ The <structfield>stxkind</structfield> field is filled at creation of the
+ statistics object, indicating which statistic type(s) are desired.
+ The fields after it are initially NULL and are filled only when the
+ corresponding statistic has been computed by <command>ANALYZE</>.
+ </para>
</sect1>
+ <sect1 id="catalog-pg-subscription">
+ <title><structname>pg_subscription</structname></title>
- <sect1 id="catalog-pg-tablesample-method">
- <title><structname>pg_tabesample_method</structname></title>
-
- <indexterm zone="catalog-pg-tablesample-method">
- <primary>pg_am</primary>
+ <indexterm zone="catalog-pg-subscription">
+ <primary>pg_subscription</primary>
</indexterm>
<para>
- The catalog <structname>pg_tablesample_method</structname> stores
- information about table sampling methods which can be used in
- <command>TABLESAMPLE</command> clause of a <command>SELECT</command>
- statement.
+ The catalog <structname>pg_subscription</structname> contains all existing
+ logical replication subscriptions. For more information about logical
+ replication see <xref linkend="logical-replication">.
+ </para>
+
+ <para>
+ Unlike most system catalogs, <structname>pg_subscription</structname> is
+ shared across all databases of a cluster: There is only one copy
+ of <structname>pg_subscription</structname> per cluster, not one per
+ database.
+ </para>
+
+ <para>
+ Access to the column <structfield>subconninfo</structfield> is revoked from
+ normal users, because it could contain plain-text passwords.
</para>
<table>
- <title><structname>pg_tablesample_method</> Columns</title>
+ <title><structname>pg_subscription</structname> Columns</title>
<tgroup cols="4">
<thead>
<entry>Description</entry>
</row>
</thead>
- <tbody>
+ <tbody>
<row>
<entry><structfield>oid</structfield></entry>
<entry><type>oid</type></entry>
</row>
<row>
- <entry><structfield>tsmname</structfield></entry>
+ <entry><structfield>subdbid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.oid</literal></entry>
+ <entry>OID of the database which the subscription resides in</entry>
+ </row>
+
+ <row>
+ <entry><structfield>subname</structfield></entry>
<entry><type>name</type></entry>
<entry></entry>
- <entry>Name of the sampling method</entry>
+ <entry>Name of the subscription</entry>
+ </row>
+
+ <row>
+ <entry><structfield>subowner</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
+ <entry>Owner of the subscription</entry>
</row>
<row>
- <entry><structfield>tsmseqscan</structfield></entry>
+ <entry><structfield>subenabled</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
- <entry>If true, the sampling method scans the whole table sequentially.
- </entry>
+ <entry>If true, the subscription is enabled and should be replicating.</entry>
</row>
<row>
- <entry><structfield>tsmpagemode</structfield></entry>
- <entry><type>bool</type></entry>
+ <entry><structfield>subsynccommit</structfield></entry>
+ <entry><type>text</type></entry>
<entry></entry>
- <entry>If true, the sampling method always reads the pages completely.
+ <entry>
+ Contains the value of the <varname>synchronous_commit</varname>
+ setting for the subscription workers.
</entry>
</row>
<row>
- <entry><structfield>tsminit</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Initialize the sampling scan</quote> function</entry>
+ <entry><structfield>subconninfo</structfield></entry>
+ <entry><type>text</type></entry>
+ <entry></entry>
+ <entry>Connection string to the upstream database</entry>
</row>
<row>
- <entry><structfield>tsmnextblock</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Get next block number</quote> function</entry>
+ <entry><structfield>subslotname</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry></entry>
+ <entry>Name of the replication slot in the upstream database. Also used
+ for local replication origin name.</entry>
</row>
<row>
- <entry><structfield>tsmnexttuple</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Get next tuple offset</quote> function</entry>
+ <entry><structfield>subpublications</structfield></entry>
+ <entry><type>text[]</type></entry>
+ <entry></entry>
+ <entry>Array of subscribed publication names. These reference the
+ publications on the publisher server. For more on publications
+ see <xref linkend="logical-replication-publication">.
+ </entry>
</row>
+ </tbody>
+ </tgroup>
+ </table>
+ </sect1>
+
+ <sect1 id="catalog-pg-subscription-rel">
+ <title><structname>pg_subscription_rel</structname></title>
+
+ <indexterm zone="catalog-pg-subscription-rel">
+ <primary>pg_subscription_rel</primary>
+ </indexterm>
+
+ <para>
+ The catalog <structname>pg_subscription_rel</structname> contains the
+ state for each replicated relation in each subscription. This is a
+ many-to-many mapping.
+ </para>
+
+ <para>
+ This catalog only contains tables known to the subscription after running
+ either <command>CREATE SUBSCRIPTION</command> or
+ <command>ALTER SUBSCRIPTION ... REFRESH PUBLICATION</command>.
+ </para>
+
+ <table>
+ <title><structname>pg_subscription_rel</structname> Columns</title>
+ <tgroup cols="4">
+ <thead>
<row>
- <entry><structfield>tsmexaminetuple</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry>Function which examines the tuple contents and decides if to
- return it, or zero if none</entry>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
</row>
+ </thead>
+ <tbody>
<row>
- <entry><structfield>tsmend</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>End the sampling scan</quote> function</entry>
+ <entry><structfield>srsubid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-subscription"><structname>pg_subscription</structname></link>.oid</literal></entry>
+ <entry>Reference to subscription</entry>
</row>
<row>
- <entry><structfield>tsmreset</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry><quote>Restart the state of sampling scan</quote> function</entry>
+ <entry><structfield>srrelid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
+ <entry>Reference to relation</entry>
</row>
<row>
- <entry><structfield>tsmcost</structfield></entry>
- <entry><type>regproc</type></entry>
- <entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
- <entry>Costing function</entry>
+ <entry><structfield>srsubstate</structfield></entry>
+ <entry><type>char</type></entry>
+ <entry></entry>
+ <entry>
+ State code:
+ <literal>i</> = initialize,
+ <literal>d</> = data is being copied,
+ <literal>s</> = synchronized,
+ <literal>r</> = ready (normal replication)
+ </entry>
</row>
+ <row>
+ <entry><structfield>srsublsn</structfield></entry>
+ <entry><type>pg_lsn</type></entry>
+ <entry></entry>
+ <entry>
+ End LSN for <literal>s</> and <literal>r</> states.
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
-
</sect1>
-
<sect1 id="catalog-pg-tablespace">
<title><structname>pg_tablespace</structname></title>
representation) for the trigger's <literal>WHEN</> condition, or null
if none</entry>
</row>
+
+ <row>
+ <entry><structfield>tgoldtable</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry></entry>
+ <entry><literal>REFERENCING</> clause name for <literal>OLD TABLE</>,
+ or null if none</entry>
+ </row>
+
+ <row>
+ <entry><structfield>tgnewtable</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry></entry>
+ <entry><literal>REFERENCING</> clause name for <literal>NEW TABLE</>,
+ or null if none</entry>
+ </row>
</tbody>
</tgroup>
</table>
<entry>available versions of extensions</entry>
</row>
+ <row>
+ <entry><link linkend="view-pg-config"><structname>pg_config</structname></link></entry>
+ <entry>compile-time configuration parameters</entry>
+ </row>
+
<row>
<entry><link linkend="view-pg-cursors"><structname>pg_cursors</structname></link></entry>
<entry>open cursors</entry>
</row>
+ <row>
+ <entry><link linkend="view-pg-file-settings"><structname>pg_file_settings</structname></link></entry>
+ <entry>summary of configuration file contents</entry>
+ </row>
+
<row>
<entry><link linkend="view-pg-group"><structname>pg_group</structname></link></entry>
<entry>groups of database users</entry>
</row>
+ <row>
+ <entry><link linkend="view-pg-hba-file-rules"><structname>pg_hba_file_rules</structname></link></entry>
+ <entry>summary of client authentication configuration file contents</entry>
+ </row>
+
<row>
<entry><link linkend="view-pg-indexes"><structname>pg_indexes</structname></link></entry>
<entry>indexes</entry>
<row>
<entry><link linkend="view-pg-locks"><structname>pg_locks</structname></link></entry>
- <entry>currently held locks</entry>
+ <entry>locks currently held or awaited</entry>
</row>
<row>
<entry>prepared transactions</entry>
</row>
+ <row>
+ <entry><link linkend="view-pg-publication-tables"><structname>pg_publication_tables</structname></link></entry>
+ <entry>publications and their associated tables</entry>
+ </row>
+
+ <row>
+ <entry><link linkend="view-pg-replication-origin-status"><structname>pg_replication_origin_status</structname></link></entry>
+ <entry>information about replication origins, including replication progress</entry>
+ </row>
+
+ <row>
+ <entry><link linkend="view-pg-replication-slots"><structname>pg_replication_slots</structname></link></entry>
+ <entry>replication slot information</entry>
+ </row>
+
<row>
<entry><link linkend="view-pg-roles"><structname>pg_roles</structname></link></entry>
<entry>database roles</entry>
</row>
<row>
- <entry><link linkend="view-pg-settings"><structname>pg_settings</structname></link></entry>
- <entry>parameter settings</entry>
+ <entry><link linkend="view-pg-sequences"><structname>pg_sequences</structname></link></entry>
+ <entry>sequences</entry>
</row>
<row>
- <entry><link linkend="view-pg-file-settings"><structname>pg_file_settings</structname></link></entry>
- <entry>file location of parameter settings</entry>
+ <entry><link linkend="view-pg-settings"><structname>pg_settings</structname></link></entry>
+ <entry>parameter settings</entry>
</row>
<row>
</para>
</sect1>
+ <sect1 id="view-pg-config">
+ <title><structname>pg_config</structname></title>
+
+ <indexterm zone="view-pg-config">
+ <primary>pg_config</primary>
+ </indexterm>
+
+ <para>
+ The view <structname>pg_config</structname> describes the
+ compile-time configuration parameters of the currently installed
+ version of <productname>PostgreSQL</>. It is intended, for example, to
+ be used by software packages that want to interface to
+ <productname>PostgreSQL</> to facilitate finding the required header
+ files and libraries. It provides the same basic information as the
+ <xref linkend="app-pgconfig"> <productname>PostgreSQL</> client
+ application.
+ </para>
+
+ <para>
+ By default, the <structname>pg_config</structname> view can be read
+ only by superusers.
+ </para>
+
+ <table>
+ <title><structname>pg_config</> Columns</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry><structfield>name</structfield></entry>
+ <entry><type>text</type></entry>
+ <entry>The parameter name</entry>
+ </row>
+
+ <row>
+ <entry><structfield>setting</structfield></entry>
+ <entry><type>text</type></entry>
+ <entry>The parameter value</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </sect1>
+
<sect1 id="view-pg-cursors">
<title><structname>pg_cursors</structname></title>
</sect1>
+ <sect1 id="view-pg-file-settings">
+ <title><structname>pg_file_settings</structname></title>
+
+ <indexterm zone="view-pg-file-settings">
+ <primary>pg_file_settings</primary>
+ </indexterm>
+
+ <para>
+ The view <structname>pg_file_settings</structname> provides a summary of
+ the contents of the server's configuration file(s). A row appears in
+ this view for each <quote>name = value</> entry appearing in the files,
+ with annotations indicating whether the value could be applied
+ successfully. Additional row(s) may appear for problems not linked to
+ a <quote>name = value</> entry, such as syntax errors in the files.
+ </para>
+
+ <para>
+ This view is helpful for checking whether planned changes in the
+ configuration files will work, or for diagnosing a previous failure.
+ Note that this view reports on the <emphasis>current</> contents of the
+ files, not on what was last applied by the server. (The
+ <link linkend="view-pg-settings"><structname>pg_settings</structname></link>
+ view is usually sufficient to determine that.)
+ </para>
+
+ <para>
+ By default, the <structname>pg_file_settings</structname> view can be read
+ only by superusers.
+ </para>
+
+ <table>
+ <title><structname>pg_file_settings</> Columns</title>
+
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><structfield>sourcefile</structfield></entry>
+ <entry><structfield>text</structfield></entry>
+ <entry>Full path name of the configuration file</entry>
+ </row>
+ <row>
+ <entry><structfield>sourceline</structfield></entry>
+ <entry><structfield>integer</structfield></entry>
+ <entry>
+ Line number within the configuration file where the entry appears
+ </entry>
+ </row>
+ <row>
+ <entry><structfield>seqno</structfield></entry>
+ <entry><structfield>integer</structfield></entry>
+ <entry>Order in which the entries are processed (1..<replaceable>n</>)</entry>
+ </row>
+ <row>
+ <entry><structfield>name</structfield></entry>
+ <entry><structfield>text</structfield></entry>
+ <entry>Configuration parameter name</entry>
+ </row>
+ <row>
+ <entry><structfield>setting</structfield></entry>
+ <entry><structfield>text</structfield></entry>
+ <entry>Value to be assigned to the parameter</entry>
+ </row>
+ <row>
+ <entry><structfield>applied</structfield></entry>
+ <entry><structfield>boolean</structfield></entry>
+ <entry>True if the value can be applied successfully</entry>
+ </row>
+ <row>
+ <entry><structfield>error</structfield></entry>
+ <entry><structfield>text</structfield></entry>
+ <entry>If not null, an error message indicating why this entry could
+ not be applied</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ If the configuration file contains syntax errors or invalid parameter
+ names, the server will not attempt to apply any settings from it, and
+ therefore all the <structfield>applied</> fields will read as false.
+ In such a case there will be one or more rows with
+ non-null <structfield>error</structfield> fields indicating the
+ problem(s). Otherwise, individual settings will be applied if possible.
+ If an individual setting cannot be applied (e.g., invalid value, or the
+ setting cannot be changed after server start) it will have an appropriate
+ message in the <structfield>error</structfield> field. Another way that
+ an entry might have <structfield>applied</> = false is that it is
+ overridden by a later entry for the same parameter name; this case is not
+ considered an error so nothing appears in
+ the <structfield>error</structfield> field.
+ </para>
+
+ <para>
+ See <xref linkend="config-setting"> for more information about the various
+ ways to change run-time parameters.
+ </para>
+
+</sect1>
+
<sect1 id="view-pg-group">
<title><structname>pg_group</structname></title>
</sect1>
+ <sect1 id="view-pg-hba-file-rules">
+ <title><structname>pg_hba_file_rules</structname></title>
+
+ <indexterm zone="view-pg-hba-file-rules">
+ <primary>pg_hba_file_rules</primary>
+ </indexterm>
+
+ <para>
+ The view <structname>pg_hba_file_rules</structname> provides a summary of
+ the contents of the client authentication configuration
+ file, <filename>pg_hba.conf</>. A row appears in this view for each
+ non-empty, non-comment line in the file, with annotations indicating
+ whether the rule could be applied successfully.
+ </para>
+
+ <para>
+ This view can be helpful for checking whether planned changes in the
+ authentication configuration file will work, or for diagnosing a previous
+ failure. Note that this view reports on the <emphasis>current</> contents
+ of the file, not on what was last loaded by the server.
+ </para>
+
+ <para>
+ By default, the <structname>pg_hba_file_rules</structname> view can be read
+ only by superusers.
+ </para>
+
+ <table>
+ <title><structname>pg_hba_file_rules</> Columns</title>
+
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><structfield>line_number</structfield></entry>
+ <entry><structfield>integer</structfield></entry>
+ <entry>
+ Line number of this rule in <filename>pg_hba.conf</>
+ </entry>
+ </row>
+ <row>
+ <entry><structfield>type</structfield></entry>
+ <entry><structfield>text</structfield></entry>
+ <entry>Type of connection</entry>
+ </row>
+ <row>
+ <entry><structfield>database</structfield></entry>
+ <entry><structfield>text[]</structfield></entry>
+ <entry>List of database name(s) to which this rule applies</entry>
+ </row>
+ <row>
+ <entry><structfield>user_name</structfield></entry>
+ <entry><structfield>text[]</structfield></entry>
+ <entry>List of user and group name(s) to which this rule applies</entry>
+ </row>
+ <row>
+ <entry><structfield>address</structfield></entry>
+ <entry><structfield>text</structfield></entry>
+ <entry>
+ Host name or IP address, or one
+ of <literal>all</literal>, <literal>samehost</literal>,
+ or <literal>samenet</literal>, or null for local connections
+ </entry>
+ </row>
+ <row>
+ <entry><structfield>netmask</structfield></entry>
+ <entry><structfield>text</structfield></entry>
+ <entry>IP address mask, or null if not applicable</entry>
+ </row>
+ <row>
+ <entry><structfield>auth_method</structfield></entry>
+ <entry><type>text</type></entry>
+ <entry>Authentication method</entry>
+ </row>
+ <row>
+ <entry><structfield>options</structfield></entry>
+ <entry><type>text[]</type></entry>
+ <entry>Options specified for authentication method, if any</entry>
+ </row>
+ <row>
+ <entry><structfield>error</structfield></entry>
+ <entry><structfield>text</structfield></entry>
+ <entry>
+ If not null, an error message indicating why this
+ line could not be processed
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ Usually, a row reflecting an incorrect entry will have values for only
+ the <structfield>line_number</> and <structfield>error</> fields.
+ </para>
+
+ <para>
+ See <xref linkend="client-authentication"> for more information about
+ client authentication configuration.
+ </para>
+ </sect1>
+
<sect1 id="view-pg-indexes">
<title><structname>pg_indexes</structname></title>
<para>
The view <structname>pg_locks</structname> provides access to
- information about the locks held by open transactions within the
+ information about the locks held by active processes within the
database server. See <xref linkend="mvcc"> for more discussion
of locking.
</para>
<para>
<structname>pg_locks</structname> contains one row per active lockable
- object, requested lock mode, and relevant transaction. Thus, the same
+ object, requested lock mode, and relevant process. Thus, the same
lockable object might
- appear many times, if multiple transactions are holding or waiting
+ appear many times, if multiple processes are holding or waiting
for locks on it. However, an object that currently has no locks on it
will not appear at all.
</para>
<para>
<structfield>granted</structfield> is true in a row representing a lock
- held by the indicated transaction. False indicates that this transaction is
- currently waiting to acquire this lock, which implies that some other
- transaction is holding a conflicting lock mode on the same lockable object.
- The waiting transaction will sleep until the other lock is released (or a
- deadlock situation is detected). A single transaction can be waiting to
- acquire at most one lock at a time.
+ held by the indicated process. False indicates that this process is
+ currently waiting to acquire this lock, which implies that at least one
+ other process is holding or waiting for a conflicting lock mode on the same
+ lockable object. The waiting process will sleep until the other lock is
+ released (or a deadlock situation is detected). A single process can be
+ waiting to acquire at most one lock at a time.
</para>
<para>
- Every transaction holds an exclusive lock on its virtual transaction ID for
- its entire duration. If a permanent ID is assigned to the transaction
- (which normally happens only if the transaction changes the state of the
- database), it also holds an exclusive lock on its permanent transaction ID
- until it ends. When one transaction finds it necessary to wait specifically
- for another transaction, it does so by attempting to acquire share lock on
- the other transaction ID (either virtual or permanent ID depending on the
- situation). That will succeed only when the other transaction
- terminates and releases its locks.
+ Throughout running a transaction, a server process holds an exclusive lock
+ on the transaction's virtual transaction ID. If a permanent ID is assigned
+ to the transaction (which normally happens only if the transaction changes
+ the state of the database), it also holds an exclusive lock on the
+ transaction's permanent transaction ID until it ends. When a process finds
+ it necessary to wait specifically for another transaction to end, it does
+ so by attempting to acquire share lock on the other transaction's ID
+ (either virtual or permanent ID depending on the situation). That will
+ succeed only when the other transaction terminates and releases its locks.
</para>
<para>
Although tuples are a lockable type of object,
information about row-level locks is stored on disk, not in memory,
and therefore row-level locks normally do not appear in this view.
- If a transaction is waiting for a
+ If a process is waiting for a
row-level lock, it will usually appear in the view as waiting for the
permanent transaction ID of the current holder of that row lock.
</para>
<structfield>pid</structfield> column of the <link
linkend="pg-stat-activity-view"><structname>pg_stat_activity</structname></link>
view to get more
- information on the session holding or waiting to hold each lock,
+ information on the session holding or awaiting each lock,
for example
<programlisting>
SELECT * FROM pg_locks pl LEFT JOIN pg_stat_activity psa
</programlisting>
</para>
+ <para>
+ While it is possible to obtain information about which processes block
+ which other processes by joining <structname>pg_locks</structname> against
+ itself, this is very difficult to get right in detail. Such a query would
+ have to encode knowledge about which lock modes conflict with which
+ others. Worse, the <structname>pg_locks</structname> view does not expose
+ information about which processes are ahead of which others in lock wait
+ queues, nor information about which processes are parallel workers running
+ on behalf of which other client sessions. It is better to use
+ the <function>pg_blocking_pids()</> function
+ (see <xref linkend="functions-info-session-table">) to identify which
+ process(es) a waiting process is blocked behind.
+ </para>
+
<para>
The <structname>pg_locks</structname> view displays data from both the
regular lock manager and the predicate lock manager, which are
<entry><literal><link linkend="catalog-pg-policy"><structname>pg_policy</structname></link>.polname</literal></entry>
<entry>Name of policy</entry>
</row>
+ <row>
+ <entry><structfield>polpermissive</structfield></entry>
+ <entry><type>text</type></entry>
+ <entry></entry>
+ <entry>Is the policy permissive or restrictive?</entry>
+ </row>
<row>
<entry><structfield>roles</structfield></entry>
<entry><type>name[]</type></entry>
<entry><type>boolean</type></entry>
<entry>
<literal>true</literal> if the prepared statement was created
- via the <command>PREPARE</command> SQL statement;
+ via the <command>PREPARE</command> SQL command;
<literal>false</literal> if the statement was prepared via the
frontend/backend protocol
</entry>
</indexterm>
<para>
- The view <structname>pg_prepared_xacts</structname> displays
- information about transactions that are currently prepared for two-phase
- commit (see <xref linkend="sql-prepare-transaction"> for details).
+ The view <structname>pg_prepared_xacts</structname> displays
+ information about transactions that are currently prepared for two-phase
+ commit (see <xref linkend="sql-prepare-transaction"> for details).
+ </para>
+
+ <para>
+ <structname>pg_prepared_xacts</structname> contains one row per prepared
+ transaction. An entry is removed when the transaction is committed or
+ rolled back.
+ </para>
+
+ <table>
+ <title><structname>pg_prepared_xacts</> Columns</title>
+
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><structfield>transaction</structfield></entry>
+ <entry><type>xid</type></entry>
+ <entry></entry>
+ <entry>
+ Numeric transaction identifier of the prepared transaction
+ </entry>
+ </row>
+ <row>
+ <entry><structfield>gid</structfield></entry>
+ <entry><type>text</type></entry>
+ <entry></entry>
+ <entry>
+ Global transaction identifier that was assigned to the transaction
+ </entry>
+ </row>
+ <row>
+ <entry><structfield>prepared</structfield></entry>
+ <entry><type>timestamp with time zone</type></entry>
+ <entry></entry>
+ <entry>
+ Time at which the transaction was prepared for commit
+ </entry>
+ </row>
+ <row>
+ <entry><structfield>owner</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.rolname</literal></entry>
+ <entry>
+ Name of the user that executed the transaction
+ </entry>
+ </row>
+ <row>
+ <entry><structfield>database</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.datname</literal></entry>
+ <entry>
+ Name of the database in which the transaction was executed
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ When the <structname>pg_prepared_xacts</structname> view is accessed, the
+ internal transaction manager data structures are momentarily locked, and
+ a copy is made for the view to display. This ensures that the
+ view produces a consistent set of results, while not blocking
+ normal operations longer than necessary. Nonetheless
+ there could be some impact on database performance if this view is
+ frequently accessed.
+ </para>
+
+ </sect1>
+
+ <sect1 id="view-pg-publication-tables">
+ <title><structname>pg_publication_tables</structname></title>
+
+ <indexterm zone="view-pg-publication-tables">
+ <primary>pg_publication_tables</primary>
+ </indexterm>
+
+ <para>
+ The view <structname>pg_publication_tables</structname> provides
+ information about the mapping between publications and the tables they
+ contain. Unlike the underlying
+ catalog <structname>pg_publication_rel</structname>, this view expands
+ publications defined as <literal>FOR ALL TABLES</literal>, so for such
+ publications there will be a row for each eligible table.
+ </para>
+
+ <table>
+ <title><structname>pg_publication_tables</structname> Columns</title>
+
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry><structfield>pubname</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry><literal><link linkend="catalog-pg-publication"><structname>pg_publication</structname></link>.pubname</literal></entry>
+ <entry>Name of publication</entry>
+ </row>
+
+ <row>
+ <entry><structfield>schemaname</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.nspname</literal></entry>
+ <entry>Name of schema containing table</entry>
+ </row>
+
+ <row>
+ <entry><structfield>tablename</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.relname</literal></entry>
+ <entry>Name of table</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </sect1>
+
+ <sect1 id="view-pg-replication-origin-status">
+ <title><structname>pg_replication_origin_status</structname></title>
+
+ <indexterm zone="view-pg-replication-origin-status">
+ <primary>pg_replication_origin_status</primary>
+ </indexterm>
+
+ <para>
+ The <structname>pg_replication_origin_status</structname> view
+ contains information about how far replay for a certain origin has
+ progressed. For more on replication origins
+ see <xref linkend="replication-origins">.
+ </para>
+
+ <table>
+
+ <title><structname>pg_replication_origin_status</structname> Columns</title>
+
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry><structfield>local_id</structfield></entry>
+ <entry><type>Oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-replication-origin"><structname>pg_replication_origin</structname></link>.roident</literal></entry>
+ <entry>internal node identifier</entry>
+ </row>
+
+ <row>
+ <entry><structfield>external_id</structfield></entry>
+ <entry><type>text</type></entry>
+ <entry><literal><link linkend="catalog-pg-replication-origin"><structname>pg_replication_origin</structname></link>.roname</literal></entry>
+ <entry>external node identifier</entry>
+ </row>
+
+ <row>
+ <entry><structfield>remote_lsn</structfield></entry>
+ <entry><type>pg_lsn</type></entry>
+ <entry></entry>
+ <entry>The origin node's LSN up to which data has been replicated.</entry>
+ </row>
+
+ <row>
+ <entry><structfield>local_lsn</structfield></entry>
+ <entry><type>pg_lsn</type></entry>
+ <entry></entry>
+ <entry>
+ This node's LSN at which <literal>remote_lsn</literal> has
+ been replicated. Used to flush commit records before persisting
+ data to disk when using asynchronous commits.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </sect1>
+
+ <sect1 id="view-pg-replication-slots">
+ <title><structname>pg_replication_slots</structname></title>
+
+ <indexterm zone="view-pg-replication-slots">
+ <primary>pg_replication_slots</primary>
+ </indexterm>
+
+ <para>
+ The <structname>pg_replication_slots</structname> view provides a listing
+ of all replication slots that currently exist on the database cluster,
+ along with their current state.
</para>
<para>
- <structname>pg_prepared_xacts</structname> contains one row per prepared
- transaction. An entry is removed when the transaction is committed or
- rolled back.
+ For more on replication slots,
+ see <xref linkend="streaming-replication-slots"> and <xref linkend="logicaldecoding">.
</para>
<table>
- <title><structname>pg_prepared_xacts</> Columns</title>
+
+ <title><structname>pg_replication_slots</structname> Columns</title>
<tgroup cols="4">
<thead>
<entry>Description</entry>
</row>
</thead>
+
<tbody>
<row>
- <entry><structfield>transaction</structfield></entry>
- <entry><type>xid</type></entry>
+ <entry><structfield>slot_name</structfield></entry>
+ <entry><type>name</type></entry>
<entry></entry>
- <entry>
- Numeric transaction identifier of the prepared transaction
- </entry>
+ <entry>A unique, cluster-wide identifier for the replication slot</entry>
</row>
+
<row>
- <entry><structfield>gid</structfield></entry>
+ <entry><structfield>plugin</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry></entry>
+ <entry>The base name of the shared object containing the output plugin this logical slot is using, or null for physical slots.</entry>
+ </row>
+
+ <row>
+ <entry><structfield>slot_type</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
- <entry>
- Global transaction identifier that was assigned to the transaction
+ <entry>The slot type - <literal>physical</> or <literal>logical</></entry>
+ </row>
+
+ <row>
+ <entry><structfield>datoid</structfield></entry>
+ <entry><type>oid</type></entry>
+ <entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.oid</literal></entry>
+ <entry>The OID of the database this slot is associated with, or
+ null. Only logical slots have an associated database.</entry>
+ </row>
+
+ <row>
+ <entry><structfield>database</structfield></entry>
+ <entry><type>text</type></entry>
+ <entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.datname</literal></entry>
+ <entry>The name of the database this slot is associated with, or
+ null. Only logical slots have an associated database.</entry>
+ </row>
+
+ <row>
+ <entry><structfield>temporary</structfield></entry>
+ <entry><type>boolean</type></entry>
+ <entry></entry>
+ <entry>True if this is a temporary replication slot. Temporary slots are
+ not saved to disk and are automatically dropped on error or when
+ the session has finished.</entry>
+ </row>
+
+ <row>
+ <entry><structfield>active</structfield></entry>
+ <entry><type>boolean</type></entry>
+ <entry></entry>
+ <entry>True if this slot is currently actively being used</entry>
+ </row>
+
+ <row>
+ <entry><structfield>active_pid</structfield></entry>
+ <entry><type>integer</type></entry>
+ <entry></entry>
+ <entry>The process ID of the session using this slot if the slot
+ is currently actively being used. <literal>NULL</literal> if
+ inactive.
</entry>
</row>
+
<row>
- <entry><structfield>prepared</structfield></entry>
- <entry><type>timestamp with time zone</type></entry>
+ <entry><structfield>xmin</structfield></entry>
+ <entry><type>xid</type></entry>
<entry></entry>
- <entry>
- Time at which the transaction was prepared for commit
+ <entry>The oldest transaction that this slot needs the database to
+ retain. <literal>VACUUM</literal> cannot remove tuples deleted
+ by any later transaction.
</entry>
</row>
+
<row>
- <entry><structfield>owner</structfield></entry>
- <entry><type>name</type></entry>
- <entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.rolname</literal></entry>
- <entry>
- Name of the user that executed the transaction
+ <entry><structfield>catalog_xmin</structfield></entry>
+ <entry><type>xid</type></entry>
+ <entry></entry>
+ <entry>The oldest transaction affecting the system catalogs that this
+ slot needs the database to retain. <literal>VACUUM</literal> cannot
+ remove catalog tuples deleted by any later transaction.
</entry>
</row>
+
<row>
- <entry><structfield>database</structfield></entry>
- <entry><type>name</type></entry>
- <entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.datname</literal></entry>
- <entry>
- Name of the database in which the transaction was executed
+ <entry><structfield>restart_lsn</structfield></entry>
+ <entry><type>pg_lsn</type></entry>
+ <entry></entry>
+ <entry>The address (<literal>LSN</literal>) of oldest WAL which still
+ might be required by the consumer of this slot and thus won't be
+ automatically removed during checkpoints.
+ </entry>
+ </row>
+
+ <row>
+ <entry><structfield>confirmed_flush_lsn</structfield></entry>
+ <entry><type>pg_lsn</type></entry>
+ <entry></entry>
+ <entry>The address (<literal>LSN</literal>) up to which the logical
+ slot's consumer has confirmed receiving data. Data older than this is
+ not available anymore. <literal>NULL</> for physical slots.
</entry>
</row>
+
</tbody>
</tgroup>
</table>
-
- <para>
- When the <structname>pg_prepared_xacts</structname> view is accessed, the
- internal transaction manager data structures are momentarily locked, and
- a copy is made for the view to display. This ensures that the
- view produces a consistent set of results, while not blocking
- normal operations longer than necessary. Nonetheless
- there could be some impact on database performance if this view is
- frequently accessed.
- </para>
-
</sect1>
<sect1 id="view-pg-roles">
null if no expiration</entry>
</row>
+ <row>
+ <entry><structfield>rolbypassrls</structfield></entry>
+ <entry><type>bool</type></entry>
+ <entry></entry>
+ <entry>
+ Role bypasses every row level security policy, see
+ <xref linkend="ddl-rowsecurity"> for more information.
+ </entry>
+ </row>
+
<row>
<entry><structfield>rolconfig</structfield></entry>
<entry><type>text[]</type></entry>
</table>
</sect1>
+ <sect1 id="view-pg-sequences">
+ <title><structname>pg_sequences</structname></title>
+
+ <indexterm zone="view-pg-sequences">
+ <primary>pg_sequences</primary>
+ </indexterm>
+
+ <para>
+ The view <structname>pg_sequences</structname> provides access to
+ useful information about each sequence in the database.
+ </para>
+
+ <table>
+ <title><structname>pg_sequences</> Columns</title>
+
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><structfield>schemaname</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.nspname</literal></entry>
+ <entry>Name of schema containing sequence</entry>
+ </row>
+ <row>
+ <entry><structfield>sequencename</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.relname</literal></entry>
+ <entry>Name of sequence</entry>
+ </row>
+ <row>
+ <entry><structfield>sequenceowner</structfield></entry>
+ <entry><type>name</type></entry>
+ <entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.rolname</literal></entry>
+ <entry>Name of sequence's owner</entry>
+ </row>
+ <row>
+ <entry><structfield>data_type</structfield></entry>
+ <entry><type>regtype</type></entry>
+ <entry><literal><link linkend="catalog-pg-authid"><structname>pg_type</structname></link>.oid</literal></entry>
+ <entry>Data type of the sequence</entry>
+ </row>
+ <row>
+ <entry><structfield>start_value</structfield></entry>
+ <entry><type>bigint</type></entry>
+ <entry></entry>
+ <entry>Start value of the sequence</entry>
+ </row>
+ <row>
+ <entry><structfield>min_value</structfield></entry>
+ <entry><type>bigint</type></entry>
+ <entry></entry>
+ <entry>Minimum value of the sequence</entry>
+ </row>
+ <row>
+ <entry><structfield>max_value</structfield></entry>
+ <entry><type>bigint</type></entry>
+ <entry></entry>
+ <entry>Maximum value of the sequence</entry>
+ </row>
+ <row>
+ <entry><structfield>increment_by</structfield></entry>
+ <entry><type>bigint</type></entry>
+ <entry></entry>
+ <entry>Increment value of the sequence</entry>
+ </row>
+ <row>
+ <entry><structfield>cycle</structfield></entry>
+ <entry><type>boolean</type></entry>
+ <entry></entry>
+ <entry>Whether the sequence cycles</entry>
+ </row>
+ <row>
+ <entry><structfield>cache_size</structfield></entry>
+ <entry><type>bigint</type></entry>
+ <entry></entry>
+ <entry>Cache size of the sequence</entry>
+ </row>
+ <row>
+ <entry><structfield>last_value</structfield></entry>
+ <entry><type>bigint</type></entry>
+ <entry></entry>
+ <entry>The last sequence value written to disk. If caching is used,
+ this value can be greater than the last value handed out from the
+ sequence. Null if the sequence has not been read from yet. Also, if
+ the current user does not have <literal>USAGE</literal>
+ or <literal>SELECT</literal> privilege on the sequence, the value is
+ null.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </sect1>
+
<sect1 id="view-pg-settings">
<title><structname>pg_settings</structname></title>
<entry><type>text</type></entry>
<entry>Configuration file the current value was set in (null for
values set from sources other than configuration files, or when
- examined by a non-superuser);
- helpful when using <literal>include</> directives in configuration files</entry>
+ examined by a user who is neither a superuser or a member of
+ <literal>pg_read_all_settings</literal>); helpful when using
+ <literal>include</> directives in configuration files</entry>
</row>
<row>
<entry><structfield>sourceline</structfield></entry>
<entry><type>integer</type></entry>
<entry>Line number within the configuration file the current value was
set at (null for values set from sources other than configuration files,
- or when examined by a non-superuser)
+ or when examined by a user who is neither a superuser or a member of
+ <literal>pg_read_all_settings</literal>).
</entry>
</row>
<row>
<filename>postgresql.conf</filename> without restarting the server.
They can also be set for a particular session in the connection request
packet (for example, via <application>libpq</>'s <literal>PGOPTIONS</>
- environment variable); any user can make such a change for his session.
+ environment variable); any user can make such a change for their session.
However, these settings never change in a session after it is started.
If you change them in <filename>postgresql.conf</filename>, send a
<systemitem>SIGHUP</systemitem> signal to the postmaster to cause it to
<para>
These settings can be set from <filename>postgresql.conf</filename>,
or within a session via the <command>SET</> command. Any user is
- allowed to change his session-local value. Changes in
+ allowed to change their session-local value. Changes in
<filename>postgresql.conf</filename> will affect existing sessions
only if no session-local value has been established with <command>SET</>.
</para>
</sect1>
- <sect1 id="view-pg-file-settings">
- <title><structname>pg_file_settings</structname></title>
-
- <indexterm zone="view-pg-file-settings">
- <primary>pg_file_settings</primary>
- </indexterm>
-
- <para>
- The view <structname>pg_file_settings</structname> provides the file
- name, line number and value of all parameters which are set through
- configuration files.
- In contrast to <structname>pg_settings</structname>, a row is provided for
- each occurrence of the parameter across all configuration files. This is helpful
- for discovering why one value may have been used in preference to another
- when the parameters were loaded.
- </para>
-
- <table>
- <title><structname>pg_file_settings</> Columns</title>
-
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><structfield>sourcefile</structfield></entry>
- <entry><structfield>text</structfield></entry>
- <entry>Path to and name of the configration file</entry>
- </row>
- <row>
- <entry><structfield>sourceline</structfield></entry>
- <entry><structfield>integer</structfield></entry>
- <entry>
- Line number within the configuration file where the value was set
- </entry>
- </row>
- <row>
- <entry><structfield>seqno</structfield></entry>
- <entry><structfield>integer</structfield></entry>
- <entry>Order in which the setting was loaded</entry>
- </row>
- <row>
- <entry><structfield>name</structfield></entry>
- <entry><structfield>text</structfield></entry>
- <entry>Run-time configuration parameter name</entry>
- </row>
- <row>
- <entry><structfield>setting</structfield></entry>
- <entry><structfield>text</structfield></entry>
- <entry>value of the parameter</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>
- See <xref linkend="config-setting"> for more information about the various
- ways to change these parameters.
- </para>
-
- <para>
- The <structname>pg_file_settings</structname> view cannot be modified
- directly as it represents information, as read in at server start or
- reload time, about all parameter settings across all configuration files.
- </para>
-
-</sect1>
-
<sect1 id="view-pg-shadow">
<title><structname>pg_shadow</structname></title>
<entry><type>bool</type></entry>
<entry></entry>
<entry>
- User can bypass row level security policies, see
+ User bypasses every row level security policy, see
<xref linkend="ddl-rowsecurity"> for more information.
</entry>
</row>
</tgroup>
</table>
+ <para>
+ While most timezone abbreviations represent fixed offsets from UTC,
+ there are some that have historically varied in value
+ (see <xref linkend="datetime-config-files"> for more information).
+ In such cases this view presents their current meaning.
+ </para>
+
</sect1>
<sect1 id="view-pg-timezone-names">
of time zone names that are recognized by <command>SET TIMEZONE</>,
along with their associated abbreviations, UTC offsets,
and daylight-savings status. (Technically,
- <productname>PostgreSQL</productname> uses <acronym>UT1</> rather
- than UTC because leap seconds are not handled.)
+ <productname>PostgreSQL</productname> does not use UTC because leap
+ seconds are not handled.)
Unlike the abbreviations shown in <link
linkend="view-pg-timezone-abbrevs"><structname>pg_timezone_abbrevs</structname></link>, many of these names imply a set of daylight-savings transition
date rules. Therefore, the associated information changes across local DST
<entry><structfield>usebypassrls</structfield></entry>
<entry><type>bool</type></entry>
<entry>
- User can bypass row level security policies, see
+ User bypasses every row level security policy, see
<xref linkend="ddl-rowsecurity"> for more information.
</entry>
</row>
<entry></entry>
<entry>
User mapping specific options, as <quote>keyword=value</>
- strings, if the current user is the owner of the foreign
- server, else null
+ strings. This column will show as null unless the current user
+ is the user being mapped, or the mapping is for
+ <literal>PUBLIC</literal> and the current user is the server
+ owner, or the current user is a superuser. The intent is
+ to protect password information stored as user mapping option.
</entry>
</row>
</tbody>
projects / postgresql / blobdiff