mirror of
https://github.com/postgres/postgres.git
synced 2025-07-27 12:41:57 +03:00
doc: Missing markup, punctuation and wordsmithing
Various improvements to the documentation like adding missing markup, improving punctuation, ensuring consistent spelling of words and minor wordsmithing. Author: Oleg Sibiryakov <o.sibiryakov@postgrespro.ru> Discussion: https://postgr.es/m/b7d0a03c-107e-48c7-a5c9-2c6f73cdf78f@postgrespro.ru
This commit is contained in:
@ -8041,7 +8041,7 @@ SCRAM-SHA-256$<replaceable><iteration count></replaceable>:<replaceable>&l
|
|||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
If true, the associated replication slots (i.e. the main slot and the
|
If true, the associated replication slots (i.e. the main slot and the
|
||||||
table sync slots) in the upstream database are enabled to be
|
table synchronization slots) in the upstream database are enabled to be
|
||||||
synchronized to the standbys
|
synchronized to the standbys
|
||||||
</para></entry>
|
</para></entry>
|
||||||
</row>
|
</row>
|
||||||
|
@ -862,7 +862,7 @@ SELECT * FROM test1 ORDER BY a || b COLLATE "fr_FR";
|
|||||||
This SQL standard collation sorts using the Unicode Collation
|
This SQL standard collation sorts using the Unicode Collation
|
||||||
Algorithm with the Default Unicode Collation Element Table. It is
|
Algorithm with the Default Unicode Collation Element Table. It is
|
||||||
available in all encodings. ICU support is required to use this
|
available in all encodings. ICU support is required to use this
|
||||||
collation, and behavior may change if Postgres is built with a
|
collation, and behavior may change if <productname>PostgreSQL</productname> is built with a
|
||||||
different version of ICU. (This collation has the same behavior as
|
different version of ICU. (This collation has the same behavior as
|
||||||
the ICU root locale; see <xref
|
the ICU root locale; see <xref
|
||||||
linkend="collation-managing-predefined-icu-und-x-icu"/>.)
|
linkend="collation-managing-predefined-icu-und-x-icu"/>.)
|
||||||
@ -897,7 +897,7 @@ SELECT * FROM test1 ORDER BY a || b COLLATE "fr_FR";
|
|||||||
expressions), it uses the POSIX Compatible variant of Unicode <ulink
|
expressions), it uses the POSIX Compatible variant of Unicode <ulink
|
||||||
url="https://www.unicode.org/reports/tr18/#Compatibility_Properties">Compatibility
|
url="https://www.unicode.org/reports/tr18/#Compatibility_Properties">Compatibility
|
||||||
Properties</ulink>. Behavior is efficient and stable within a
|
Properties</ulink>. Behavior is efficient and stable within a
|
||||||
<productname>Postgres</productname> major version. This collation is
|
<productname>PostgreSQL</productname> major version. This collation is
|
||||||
only available for encoding <literal>UTF8</literal>.
|
only available for encoding <literal>UTF8</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -708,7 +708,7 @@ include_dir 'conf.d'
|
|||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
PostgreSQL sizes certain resources based directly on the value of
|
<productname>PostgreSQL</productname> sizes certain resources based directly on the value of
|
||||||
<varname>max_connections</varname>. Increasing its value leads to
|
<varname>max_connections</varname>. Increasing its value leads to
|
||||||
higher allocation of those resources, including shared memory.
|
higher allocation of those resources, including shared memory.
|
||||||
</para>
|
</para>
|
||||||
@ -6422,7 +6422,7 @@ SELECT * FROM parent WHERE key = 2400;
|
|||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
If <systemitem>csvlog</systemitem> is included in <varname>log_destination</varname>,
|
If <systemitem>csvlog</systemitem> is included in <varname>log_destination</varname>,
|
||||||
log entries are output in <quote>comma separated
|
log entries are output in <quote>comma-separated
|
||||||
value</quote> (<acronym>CSV</acronym>) format, which is convenient for
|
value</quote> (<acronym>CSV</acronym>) format, which is convenient for
|
||||||
loading logs into programs.
|
loading logs into programs.
|
||||||
See <xref linkend="runtime-config-logging-csvlog"/> for details.
|
See <xref linkend="runtime-config-logging-csvlog"/> for details.
|
||||||
@ -10838,7 +10838,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
|
|||||||
Turning this setting off is intended for environments where the
|
Turning this setting off is intended for environments where the
|
||||||
configuration of <productname>PostgreSQL</productname> is managed by
|
configuration of <productname>PostgreSQL</productname> is managed by
|
||||||
some external tool.
|
some external tool.
|
||||||
In such environments, a well intentioned superuser might
|
In such environments, a well-intentioned superuser might
|
||||||
<emphasis>mistakenly</emphasis> use <command>ALTER SYSTEM</command>
|
<emphasis>mistakenly</emphasis> use <command>ALTER SYSTEM</command>
|
||||||
to change the configuration instead of using the external tool.
|
to change the configuration instead of using the external tool.
|
||||||
This might result in unintended behavior, such as the external tool
|
This might result in unintended behavior, such as the external tool
|
||||||
|
@ -21437,7 +21437,7 @@ SELECT NULLIF(value, '(none)') ...
|
|||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
Extracts the lower bound of the multirange (<literal>NULL</literal> if the
|
Extracts the lower bound of the multirange (<literal>NULL</literal> if the
|
||||||
multirange is empty has no lower bound).
|
multirange is empty or has no lower bound).
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
<literal>lower('{[1.1,2.2)}'::nummultirange)</literal>
|
<literal>lower('{[1.1,2.2)}'::nummultirange)</literal>
|
||||||
|
@ -545,9 +545,9 @@ int PQsocketPoll(int sock, int forRead, int forWrite,
|
|||||||
the Unix epoch (that is, <type>time_t</type> times 1 million).
|
the Unix epoch (that is, <type>time_t</type> times 1 million).
|
||||||
Timeout is infinite if <parameter>end_time</parameter>
|
Timeout is infinite if <parameter>end_time</parameter>
|
||||||
is <literal>-1</literal>. Timeout is immediate (no blocking) if
|
is <literal>-1</literal>. Timeout is immediate (no blocking) if
|
||||||
end_time is <literal>0</literal> (or indeed, any time before now).
|
<parameter>end_time</parameter> is <literal>0</literal> (or indeed, any
|
||||||
Timeout values can be calculated conveniently by adding the desired
|
time before now). Timeout values can be calculated conveniently by
|
||||||
number of microseconds to the result of
|
adding the desired number of microseconds to the result of
|
||||||
<xref linkend="libpq-PQgetCurrentTimeUSec"/>.
|
<xref linkend="libpq-PQgetCurrentTimeUSec"/>.
|
||||||
Note that the underlying system calls may have less than microsecond
|
Note that the underlying system calls may have less than microsecond
|
||||||
precision, so that the actual delay may be imprecise.
|
precision, so that the actual delay may be imprecise.
|
||||||
@ -1831,10 +1831,11 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
|
|||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
start SSL handshake directly after establishing the TCP/IP
|
start SSL handshake directly after establishing the TCP/IP
|
||||||
connection. This is only allowed with sslmode=require or higher,
|
connection. This is only allowed with
|
||||||
because the weaker settings could lead to unintended fallback to
|
<literal>sslmode=require</literal> or higher, because the weaker
|
||||||
plaintext authentication when the server does not support direct
|
settings could lead to unintended fallback to plaintext
|
||||||
SSL handshake.
|
authentication when the server does not support direct SSL
|
||||||
|
handshake.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
@ -9582,7 +9583,7 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*)
|
|||||||
<para>
|
<para>
|
||||||
For backwards compatibility with earlier versions of PostgreSQL, if a
|
For backwards compatibility with earlier versions of PostgreSQL, if a
|
||||||
root CA file exists, the behavior of
|
root CA file exists, the behavior of
|
||||||
<literal>sslmode</literal>=<literal>require</literal> will be the same
|
<literal>sslmode=require</literal> will be the same
|
||||||
as that of <literal>verify-ca</literal>, meaning the server certificate
|
as that of <literal>verify-ca</literal>, meaning the server certificate
|
||||||
is validated against the CA. Relying on this behavior is discouraged,
|
is validated against the CA. Relying on this behavior is discouraged,
|
||||||
and applications that need certificate validation should always use
|
and applications that need certificate validation should always use
|
||||||
|
@ -3265,7 +3265,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
|
|||||||
</term>
|
</term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Comma separated list of publication names for which to subscribe
|
Comma-separated list of publication names for which to subscribe
|
||||||
(receive changes). The individual publication names are treated
|
(receive changes). The individual publication names are treated
|
||||||
as standard objects names and can be quoted the same as needed.
|
as standard objects names and can be quoted the same as needed.
|
||||||
At least one publication name is required.
|
At least one publication name is required.
|
||||||
@ -3330,8 +3330,9 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
|
|||||||
</term>
|
</term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Option to send changes by their origin. Possible values are "none"
|
Option to send changes by their origin. Possible values are
|
||||||
to only send the changes that have no origin associated, or "any"
|
<literal>none</literal> to only send the changes that have no origin
|
||||||
|
associated, or <literal>any</literal>
|
||||||
to send the changes regardless of their origin. This can be used
|
to send the changes regardless of their origin. This can be used
|
||||||
to avoid loops (infinite replication of the same data) among
|
to avoid loops (infinite replication of the same data) among
|
||||||
replication nodes.
|
replication nodes.
|
||||||
|
@ -1123,8 +1123,8 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
|
|||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
All the forms of ALTER TABLE that act on a single table, except
|
All the forms of <command>ALTER TABLE</command> that act on a single table,
|
||||||
<literal>RENAME</literal>, <literal>SET SCHEMA</literal>,
|
except <literal>RENAME</literal>, <literal>SET SCHEMA</literal>,
|
||||||
<literal>ATTACH PARTITION</literal>, and
|
<literal>ATTACH PARTITION</literal>, and
|
||||||
<literal>DETACH PARTITION</literal> can be combined into
|
<literal>DETACH PARTITION</literal> can be combined into
|
||||||
a list of multiple alterations to be applied together. For example, it
|
a list of multiple alterations to be applied together. For example, it
|
||||||
|
@ -427,7 +427,7 @@ COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable
|
|||||||
<term><literal>LOG_VERBOSITY</literal></term>
|
<term><literal>LOG_VERBOSITY</literal></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specify the amount of messages emitted by a <command>COPY</command>
|
Specifies the amount of messages emitted by a <command>COPY</command>
|
||||||
command: <literal>default</literal> or <literal>verbose</literal>. If
|
command: <literal>default</literal> or <literal>verbose</literal>. If
|
||||||
<literal>verbose</literal> is specified, additional messages are emitted
|
<literal>verbose</literal> is specified, additional messages are emitted
|
||||||
during processing.
|
during processing.
|
||||||
@ -779,7 +779,7 @@ COPY <replaceable class="parameter">count</replaceable>
|
|||||||
<title>CSV Format</title>
|
<title>CSV Format</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
This format option is used for importing and exporting the Comma
|
This format option is used for importing and exporting the Comma-
|
||||||
Separated Value (<literal>CSV</literal>) file format used by many other
|
Separated Value (<literal>CSV</literal>) file format used by many other
|
||||||
programs, such as spreadsheets. Instead of the escaping rules used by
|
programs, such as spreadsheets. Instead of the escaping rules used by
|
||||||
<productname>PostgreSQL</productname>'s standard text format, it
|
<productname>PostgreSQL</productname>'s standard text format, it
|
||||||
|
@ -185,7 +185,7 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
When setting <literal>slot_name</literal> to a valid name and
|
When setting <literal>slot_name</literal> to a valid name and
|
||||||
<literal>create_slot</literal> to false, the
|
<literal>create_slot</literal> to <literal>false</literal>, the
|
||||||
<literal>failover</literal> property value of the named slot may
|
<literal>failover</literal> property value of the named slot may
|
||||||
differ from the counterpart <literal>failover</literal> parameter
|
differ from the counterpart <literal>failover</literal> parameter
|
||||||
specified in the subscription. Always ensure the slot property
|
specified in the subscription. Always ensure the slot property
|
||||||
@ -474,7 +474,8 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
|
|||||||
<para>
|
<para>
|
||||||
If any table in the publication has a <literal>WHERE</literal> clause, rows
|
If any table in the publication has a <literal>WHERE</literal> clause, rows
|
||||||
for which the <replaceable class="parameter">expression</replaceable>
|
for which the <replaceable class="parameter">expression</replaceable>
|
||||||
evaluates to false or null will not be published. If the subscription has
|
evaluates to <literal>false</literal> or <literal>NULL</literal> will not be
|
||||||
|
published. If the subscription has
|
||||||
several publications in which the same table has been published with
|
several publications in which the same table has been published with
|
||||||
different <literal>WHERE</literal> clauses, a row will be published if any
|
different <literal>WHERE</literal> clauses, a row will be published if any
|
||||||
of the expressions (referring to that publish operation) are satisfied. In
|
of the expressions (referring to that publish operation) are satisfied. In
|
||||||
|
@ -67,7 +67,7 @@ PostgreSQL documentation
|
|||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
pg_upgrade supports upgrades from 9.2.X and later to the current
|
<application>pg_upgrade</application> supports upgrades from 9.2.X and later to the current
|
||||||
major release of <productname>PostgreSQL</productname>, including snapshot and beta releases.
|
major release of <productname>PostgreSQL</productname>, including snapshot and beta releases.
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
@ -87,7 +87,7 @@ Policy from config file: targeted
|
|||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
To build this module specify <xref
|
To build this module, specify <xref
|
||||||
linkend="configure-option-with-sepgsql"/> (when using <link
|
linkend="configure-option-with-sepgsql"/> (when using <link
|
||||||
linkend="install-make">make and autoconf</link> ) or <xref
|
linkend="install-make">make and autoconf</link> ) or <xref
|
||||||
linkend="configure-with-sepgsql-meson"/> (when using <link
|
linkend="configure-with-sepgsql-meson"/> (when using <link
|
||||||
|
@ -2496,7 +2496,7 @@ SELECT getf1(CAST(ROW(11,'this is a test',2.5) AS myrowtype));
|
|||||||
linkend="functions-comparison"/>, to compare one row against another
|
linkend="functions-comparison"/>, to compare one row against another
|
||||||
as described in <xref linkend="functions-comparisons"/>, and to
|
as described in <xref linkend="functions-comparisons"/>, and to
|
||||||
use them in connection with subqueries, as discussed in <xref
|
use them in connection with subqueries, as discussed in <xref
|
||||||
linkend="functions-subquery"/>,
|
linkend="functions-subquery"/>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
</sect2>
|
</sect2>
|
||||||
|
@ -2586,7 +2586,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
|
|||||||
True if this logical slot conflicted with recovery (and so is now
|
True if this logical slot conflicted with recovery (and so is now
|
||||||
invalidated). When this column is true, check
|
invalidated). When this column is true, check
|
||||||
<structfield>invalidation_reason</structfield> column for the conflict
|
<structfield>invalidation_reason</structfield> column for the conflict
|
||||||
reason. Always NULL for physical slots.
|
reason. Always <literal>NULL</literal> for physical slots.
|
||||||
</para></entry>
|
</para></entry>
|
||||||
</row>
|
</row>
|
||||||
|
|
||||||
@ -3945,7 +3945,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
|
|||||||
range type column. (Null for non-range types.)
|
range type column. (Null for non-range types.)
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
This histogram is calculated using the <literal>subtype_diff</literal>
|
This histogram is calculated using the <function>subtype_diff</function>
|
||||||
range function regardless of whether range bounds are inclusive.
|
range function regardless of whether range bounds are inclusive.
|
||||||
</para></entry>
|
</para></entry>
|
||||||
</row>
|
</row>
|
||||||
|
@ -357,7 +357,8 @@
|
|||||||
<para>
|
<para>
|
||||||
If a foreign key constraint specifies referential actions (that
|
If a foreign key constraint specifies referential actions (that
|
||||||
is, cascading updates or deletes), those actions are performed via
|
is, cascading updates or deletes), those actions are performed via
|
||||||
ordinary SQL update or delete commands on the referencing table.
|
ordinary SQL <command>UPDATE</command> or <command>DELETE</command>
|
||||||
|
commands on the referencing table.
|
||||||
In particular, any triggers that exist on the referencing table
|
In particular, any triggers that exist on the referencing table
|
||||||
will be fired for those changes. If such a trigger modifies or
|
will be fired for those changes. If such a trigger modifies or
|
||||||
blocks the effect of one of these commands, the end result could
|
blocks the effect of one of these commands, the end result could
|
||||||
|
@ -407,7 +407,7 @@ REVOKE <replaceable>group_role</replaceable> FROM <replaceable>role1</replaceabl
|
|||||||
temporarily <quote>become</quote> the group role. In this state, the
|
temporarily <quote>become</quote> the group role. In this state, the
|
||||||
database session has access to the privileges of the group role rather
|
database session has access to the privileges of the group role rather
|
||||||
than the original login role, and any database objects created are
|
than the original login role, and any database objects created are
|
||||||
considered owned by the group role not the login role. Second, member
|
considered owned by the group role, not the login role. Second, member
|
||||||
roles that have been granted membership with the
|
roles that have been granted membership with the
|
||||||
<literal>INHERIT</literal> option automatically have use of the
|
<literal>INHERIT</literal> option automatically have use of the
|
||||||
privileges of those directly or indirectly a member of, though the
|
privileges of those directly or indirectly a member of, though the
|
||||||
|
@ -679,11 +679,11 @@
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
In some cases, when the WAL size on the primary increases quickly,
|
In some cases, when the WAL size on the primary increases quickly,
|
||||||
for instance during massive INSERT,
|
for instance during massive <command>INSERT</command>,
|
||||||
the <structfield>restartpoints_req</structfield> counter on the standby
|
the <structfield>restartpoints_req</structfield> counter on the standby
|
||||||
may demonstrate a peak growth.
|
may demonstrate a peak growth.
|
||||||
This occurs because requests to create a new restartpoint due to increased
|
This occurs because requests to create a new restartpoint due to increased
|
||||||
XLOG consumption cannot be performed because the safe checkpoint record
|
WAL consumption cannot be performed because the safe checkpoint record
|
||||||
since the last restartpoint has not yet been replayed on the standby.
|
since the last restartpoint has not yet been replayed on the standby.
|
||||||
This behavior is normal and does not lead to an increase in system resource
|
This behavior is normal and does not lead to an increase in system resource
|
||||||
consumption.
|
consumption.
|
||||||
|
Reference in New Issue
Block a user