1
0
mirror of https://github.com/postgres/postgres.git synced 2025-07-27 12:41:57 +03:00

Rename user-facing tools with "xlog" in the name to say "wal".

This means pg_receivexlog because pg_receivewal, pg_resetxlog
becomes pg_resetwal, and pg_xlogdump becomes pg_waldump.
This commit is contained in:
Robert Haas
2017-02-09 16:23:46 -05:00
parent 5d2adf0f81
commit 85c11324ca
58 changed files with 191 additions and 189 deletions

View File

@ -1321,7 +1321,7 @@ the connection to be used for logical replication from that database.
psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
</programlisting>
However, it is often more useful to use
<xref linkend="app-pgreceivexlog"> (for physical replication) or
<xref linkend="app-pgreceivewal"> (for physical replication) or
<xref linkend="app-pgrecvlogical"> (for logical replication).
</para>

View File

@ -198,15 +198,15 @@ Complete list of usable sgml source files in this directory.
<!ENTITY pgDump SYSTEM "pg_dump.sgml">
<!ENTITY pgDumpall SYSTEM "pg_dumpall.sgml">
<!ENTITY pgIsready SYSTEM "pg_isready.sgml">
<!ENTITY pgReceivexlog SYSTEM "pg_receivexlog.sgml">
<!ENTITY pgReceivewal SYSTEM "pg_receivewal.sgml">
<!ENTITY pgRecvlogical SYSTEM "pg_recvlogical.sgml">
<!ENTITY pgResetxlog SYSTEM "pg_resetxlog.sgml">
<!ENTITY pgResetwal SYSTEM "pg_resetwal.sgml">
<!ENTITY pgRestore SYSTEM "pg_restore.sgml">
<!ENTITY pgRewind SYSTEM "pg_rewind.sgml">
<!ENTITY pgtestfsync SYSTEM "pgtestfsync.sgml">
<!ENTITY pgtesttiming SYSTEM "pgtesttiming.sgml">
<!ENTITY pgupgrade SYSTEM "pgupgrade.sgml">
<!ENTITY pgxlogdump SYSTEM "pg_xlogdump.sgml">
<!ENTITY pgwaldump SYSTEM "pg_waldump.sgml">
<!ENTITY postgres SYSTEM "postgres-ref.sgml">
<!ENTITY postmaster SYSTEM "postmaster.sgml">
<!ENTITY psqlRef SYSTEM "psql-ref.sgml">

View File

@ -1,27 +1,27 @@
<!--
doc/src/sgml/ref/pg_receivexlog.sgml
doc/src/sgml/ref/pg_receivewal.sgml
PostgreSQL documentation
-->
<refentry id="app-pgreceivexlog">
<indexterm zone="app-pgreceivexlog">
<primary>pg_receivexlog</primary>
<refentry id="app-pgreceivewal">
<indexterm zone="app-pgreceivewal">
<primary>pg_receivewal</primary>
</indexterm>
<refmeta>
<refentrytitle>pg_receivexlog</refentrytitle>
<refentrytitle>pg_receivewal</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
<refname>pg_receivexlog</refname>
<refname>pg_receivewal</refname>
<refpurpose>stream transaction logs from a <productname>PostgreSQL</productname> server</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_receivexlog</command>
<command>pg_receivewal</command>
<arg rep="repeat"><replaceable>option</></arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -31,7 +31,7 @@ PostgreSQL documentation
Description
</title>
<para>
<application>pg_receivexlog</application> is used to stream the transaction log
<application>pg_receivewal</application> is used to stream the transaction log
from a running <productname>PostgreSQL</productname> cluster. The transaction
log is streamed using the streaming replication protocol, and is written
to a local directory of files. This directory can be used as the archive
@ -40,16 +40,16 @@ PostgreSQL documentation
</para>
<para>
<application>pg_receivexlog</application> streams the transaction
<application>pg_receivewal</application> streams the transaction
log in real time as it's being generated on the server, and does not wait
for segments to complete like <xref linkend="guc-archive-command"> does.
For this reason, it is not necessary to set
<xref linkend="guc-archive-timeout"> when using
<application>pg_receivexlog</application>.
<application>pg_receivewal</application>.
</para>
<para>
Unlike the WAL receiver of a PostgreSQL standby server, <application>pg_receivexlog</>
Unlike the WAL receiver of a PostgreSQL standby server, <application>pg_receivewal</>
by default flushes WAL data only when a WAL file is closed.
The option <option>--synchronous</> must be specified to flush WAL data
in real time.
@ -68,7 +68,7 @@ PostgreSQL documentation
<para>
If the connection is lost, or if it cannot be initially established,
with a non-fatal error, <application>pg_receivexlog</application> will
with a non-fatal error, <application>pg_receivewal</application> will
retry the connection indefinitely, and reestablish streaming as soon
as possible. To avoid this behavior, use the <literal>-n</literal>
parameter.
@ -132,9 +132,9 @@ PostgreSQL documentation
<term><option>--slot=<replaceable class="parameter">slotname</replaceable></option></term>
<listitem>
<para>
Require <application>pg_receivexlog</application> to use an existing
Require <application>pg_receivewal</application> to use an existing
replication slot (see <xref linkend="streaming-replication-slots">).
When this option is used, <application>pg_receivexlog</> will report
When this option is used, <application>pg_receivewal</> will report
a flush position to the server, indicating when each segment has been
synchronized to disk so that the server can remove that segment if it
is not otherwise needed.
@ -142,7 +142,7 @@ PostgreSQL documentation
<para>
When the replication client
of <application>pg_receivexlog</application> is configured on the
of <application>pg_receivewal</application> is configured on the
server as a synchronous standby, then using a replication slot will
report the flush position to the server, but only when a WAL file is
closed. Therefore, that configuration will cause transactions on the
@ -164,7 +164,7 @@ PostgreSQL documentation
<para>
This option should be specified if the replication client
of <application>pg_receivexlog</application> is configured on the
of <application>pg_receivewal</application> is configured on the
server as a synchronous standby, to ensure that timely feedback is
sent to the server.
</para>
@ -209,7 +209,7 @@ PostgreSQL documentation
</para>
<para>
The option is called <literal>--dbname</> for consistency with other
client applications, but because <application>pg_receivexlog</application>
client applications, but because <application>pg_receivewal</application>
doesn't connect to any particular database in the cluster, database
name in the connection string will be ignored.
</para>
@ -273,15 +273,15 @@ PostgreSQL documentation
<term><option>--password</option></term>
<listitem>
<para>
Force <application>pg_receivexlog</application> to prompt for a
Force <application>pg_receivewal</application> to prompt for a
password before connecting to a database.
</para>
<para>
This option is never essential, since
<application>pg_receivexlog</application> will automatically prompt
<application>pg_receivewal</application> will automatically prompt
for a password if the server demands password authentication.
However, <application>pg_receivexlog</application> will waste a
However, <application>pg_receivewal</application> will waste a
connection attempt finding out that the server wants a password.
In some cases it is worth typing <option>-W</> to avoid the extra
connection attempt.
@ -292,7 +292,7 @@ PostgreSQL documentation
</para>
<para>
<application>pg_receivexlog</application> can perform one of the two
<application>pg_receivewal</application> can perform one of the two
following actions in order to control physical replication slots:
<variablelist>
@ -327,7 +327,7 @@ PostgreSQL documentation
<term><option>--version</></term>
<listitem>
<para>
Print the <application>pg_receivexlog</application> version and exit.
Print the <application>pg_receivewal</application> version and exit.
</para>
</listitem>
</varlistentry>
@ -337,7 +337,7 @@ PostgreSQL documentation
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>pg_receivexlog</application> command line
Show help about <application>pg_receivewal</application> command line
arguments, and exit.
</para>
</listitem>
@ -363,7 +363,7 @@ PostgreSQL documentation
<title>Notes</title>
<para>
When using <application>pg_receivexlog</application> instead of
When using <application>pg_receivewal</application> instead of
<xref linkend="guc-archive-command"> as the main WAL backup method, it is
strongly recommended to use replication slots. Otherwise, the server is
free to recycle or remove transaction log files before they are backed up,
@ -384,7 +384,7 @@ PostgreSQL documentation
<literal>mydbserver</literal> and store it in the local directory
<filename>/usr/local/pgsql/archive</filename>:
<screen>
<prompt>$</prompt> <userinput>pg_receivexlog -h mydbserver -D /usr/local/pgsql/archive</userinput>
<prompt>$</prompt> <userinput>pg_receivewal -h mydbserver -D /usr/local/pgsql/archive</userinput>
</screen></para>
</refsect1>

View File

@ -35,7 +35,7 @@ PostgreSQL documentation
<para>
It creates a replication-mode connection, so it is subject to the same
constraints as <xref linkend="app-pgreceivexlog">, plus those for logical
constraints as <xref linkend="app-pgreceivewal">, plus those for logical
replication (see <xref linkend="logicaldecoding">).
</para>
@ -238,7 +238,7 @@ PostgreSQL documentation
<listitem>
<para>
This option has the same effect as the option of the same name
in <xref linkend="app-pgreceivexlog">. See the description there.
in <xref linkend="app-pgreceivewal">. See the description there.
</para>
</listitem>
</varlistentry>
@ -411,7 +411,7 @@ PostgreSQL documentation
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="app-pgreceivexlog"></member>
<member><xref linkend="app-pgreceivewal"></member>
</simplelist>
</refsect1>
</refentry>

View File

@ -1,27 +1,27 @@
<!--
doc/src/sgml/ref/pg_resetxlog.sgml
doc/src/sgml/ref/pg_resetwal.sgml
PostgreSQL documentation
-->
<refentry id="APP-PGRESETXLOG">
<indexterm zone="app-pgresetxlog">
<primary>pg_resetxlog</primary>
<refentry id="APP-PGRESETWAL">
<indexterm zone="app-pgresetwal">
<primary>pg_resetwal</primary>
</indexterm>
<refmeta>
<refentrytitle><application>pg_resetxlog</application></refentrytitle>
<refentrytitle><application>pg_resetwal</application></refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
<refname>pg_resetxlog</refname>
<refname>pg_resetwal</refname>
<refpurpose>reset the write-ahead log and other control information of a <productname>PostgreSQL</productname> database cluster</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_resetxlog</command>
<command>pg_resetwal</command>
<arg choice="opt"><option>-f</option></arg>
<arg choice="opt"><option>-n</option></arg>
<arg rep="repeat"><replaceable>option</replaceable></arg>
@ -29,10 +29,10 @@ PostgreSQL documentation
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="R1-APP-PGRESETXLOG-1">
<refsect1 id="R1-APP-PGRESETWAL-1">
<title>Description</title>
<para>
<command>pg_resetxlog</command> clears the write-ahead log (WAL) and
<command>pg_resetwal</command> clears the write-ahead log (WAL) and
optionally resets some other control information stored in the
<filename>pg_control</> file. This function is sometimes needed
if these files have become corrupted. It should be used only as a
@ -51,12 +51,12 @@ PostgreSQL documentation
This utility can only be run by the user who installed the server, because
it requires read/write access to the data directory.
For safety reasons, you must specify the data directory on the command line.
<command>pg_resetxlog</command> does not use the environment variable
<command>pg_resetwal</command> does not use the environment variable
<envar>PGDATA</>.
</para>
<para>
If <command>pg_resetxlog</command> complains that it cannot determine
If <command>pg_resetwal</command> complains that it cannot determine
valid data for <filename>pg_control</>, you can force it to proceed anyway
by specifying the <option>-f</> (force) option. In this case plausible
values will be substituted for the missing data. Most of the fields can be
@ -80,7 +80,7 @@ PostgreSQL documentation
<term><option>-f</option></term>
<listitem>
<para>
Force <command>pg_resetxlog</command> to proceed even if it cannot determine
Force <command>pg_resetwal</command> to proceed even if it cannot determine
valid data for <filename>pg_control</>, as explained above.
</para>
</listitem>
@ -91,10 +91,10 @@ PostgreSQL documentation
<listitem>
<para>
The <option>-n</> (no operation) option instructs
<command>pg_resetxlog</command> to print the values reconstructed from
<command>pg_resetwal</command> to print the values reconstructed from
<filename>pg_control</> and values about to be changed, and then exit
without modifying anything. This is mainly a debugging tool, but can be
useful as a sanity check before allowing <command>pg_resetxlog</command>
useful as a sanity check before allowing <command>pg_resetwal</command>
to proceed for real.
</para>
</listitem>
@ -115,7 +115,7 @@ PostgreSQL documentation
<para>
The following options are only needed when
<command>pg_resetxlog</command> is unable to determine appropriate values
<command>pg_resetwal</command> is unable to determine appropriate values
by reading <filename>pg_control</>. Safe values can be determined as
described below. For values that take numeric arguments, hexadecimal
values can be specified by using the prefix <literal>0x</literal>.
@ -152,7 +152,7 @@ PostgreSQL documentation
<para>
The transaction ID epoch is not actually stored anywhere in the database
except in the field that is set by <command>pg_resetxlog</command>,
except in the field that is set by <command>pg_resetwal</command>,
so any value will work so far as the database itself is concerned.
You might need to adjust this value to ensure that replication
systems such as <application>Slony-I</> and
@ -164,7 +164,7 @@ PostgreSQL documentation
</varlistentry>
<varlistentry>
<term><option>-l</option> <replaceable class="parameter">xlogfile</replaceable></term>
<term><option>-l</option> <replaceable class="parameter">walfile</replaceable></term>
<listitem>
<para>
Manually set the WAL starting address.
@ -182,7 +182,7 @@ PostgreSQL documentation
<note>
<para>
<command>pg_resetxlog</command> itself looks at the files in
<command>pg_resetwal</command> itself looks at the files in
<filename>pg_wal</> and chooses a default <option>-l</> setting
beyond the last existing file name. Therefore, manual adjustment of
<option>-l</> should only be needed if you are aware of WAL segment
@ -274,11 +274,11 @@ PostgreSQL documentation
<para>
This command must not be used when the server is
running. <command>pg_resetxlog</command> will refuse to start up if
running. <command>pg_resetwal</command> will refuse to start up if
it finds a server lock file in the data directory. If the
server crashed then a lock file might have been left
behind; in that case you can remove the lock file to allow
<command>pg_resetxlog</command> to run. But before you do
<command>pg_resetwal</command> to run. But before you do
so, make doubly certain that there is no server process still alive.
</para>
</refsect1>

View File

@ -1,27 +1,27 @@
<!--
doc/src/sgml/ref/pg_xlogdump.sgml
doc/src/sgml/ref/pg_waldump.sgml
PostgreSQL documentation
-->
<refentry id="pgxlogdump">
<indexterm zone="pgxlogdump">
<primary>pg_xlogdump</primary>
<refentry id="pgwaldump">
<indexterm zone="pgwaldump">
<primary>pg_waldump</primary>
</indexterm>
<refmeta>
<refentrytitle><application>pg_xlogdump</application></refentrytitle>
<refentrytitle><application>pg_waldump</application></refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
<refname>pg_xlogdump</refname>
<refname>pg_waldump</refname>
<refpurpose>display a human-readable rendering of the write-ahead log of a <productname>PostgreSQL</productname> database cluster</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_xlogdump</command>
<command>pg_waldump</command>
<arg rep="repeat" choice="opt"><option>option</option></arg>
<arg choice="opt"><option>startseg</option>
<arg choice="opt"><option>endseg</option></arg>
@ -29,10 +29,10 @@ PostgreSQL documentation
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="R1-APP-PGXLOGDUMP-1">
<refsect1 id="R1-APP-PGWALDUMP-1">
<title>Description</title>
<para>
<command>pg_xlogdump</command> displays the write-ahead log (WAL) and is mainly
<command>pg_waldump</command> displays the write-ahead log (WAL) and is mainly
useful for debugging or educational purposes.
</para>
@ -167,7 +167,7 @@ PostgreSQL documentation
<term><option>--version</></term>
<listitem>
<para>
Print the <application>pg_xlogdump</application> version and exit.
Print the <application>pg_waldump</application> version and exit.
</para>
</listitem>
</varlistentry>
@ -199,7 +199,7 @@ PostgreSQL documentation
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>pg_xlogdump</application> command line
Show help about <application>pg_waldump</application> command line
arguments, and exit.
</para>
</listitem>
@ -220,7 +220,7 @@ PostgreSQL documentation
</para>
<para>
<application>pg_xlogdump</> cannot read WAL files with suffix
<application>pg_waldump</> cannot read WAL files with suffix
<literal>.partial</>. If those files need to be read, <literal>.partial</>
suffix needs to be removed from the file name.
</para>

View File

@ -245,7 +245,7 @@
&pgDump;
&pgDumpall;
&pgIsready;
&pgReceivexlog;
&pgReceivewal;
&pgRecvlogical;
&pgRestore;
&psqlRef;
@ -271,12 +271,12 @@
&pgarchivecleanup;
&pgControldata;
&pgCtl;
&pgResetxlog;
&pgResetwal;
&pgRewind;
&pgtestfsync;
&pgtesttiming;
&pgupgrade;
&pgxlogdump;
&pgwaldump;
&postgres;
&postmaster;

View File

@ -8069,7 +8069,7 @@ Branch: REL9_2_STABLE [6b700301c] 2015-02-17 16:03:00 +0100
<listitem>
<para>
Add a <link
linkend="app-pgreceivexlog"><application>pg_receivexlog</></link>
linkend="app-pgreceivewal"><application>pg_receivexlog</></link>
tool to archive WAL file changes as they are written
</para>
</listitem>
@ -9231,7 +9231,7 @@ Branch: REL9_2_STABLE [6b700301c] 2015-02-17 16:03:00 +0100
<listitem>
<para>
Add a <link
linkend="app-pgreceivexlog"><application>pg_receivexlog</></link>
linkend="app-pgreceivewal"><application>pg_receivexlog</></link>
tool to archive WAL file changes as they are written, rather
than waiting for completed WAL files (Magnus Hagander)
</para>

View File

@ -10080,7 +10080,7 @@ ALTER EXTENSION hstore UPDATE;
<listitem>
<para>
Allow tools like <link
linkend="app-pgreceivexlog"><application>pg_receivexlog</></link>
linkend="app-pgreceivewal"><application>pg_receivexlog</></link>
to run on computers with different architectures (Heikki
Linnakangas)
</para>
@ -10110,7 +10110,7 @@ ALTER EXTENSION hstore UPDATE;
<listitem>
<para>
Allow <link
linkend="app-pgreceivexlog"><application>pg_receivexlog</></link>
linkend="app-pgreceivewal"><application>pg_receivexlog</></link>
and <link
linkend="app-pgbasebackup"><application>pg_basebackup</></link>
<option>--xlog-method</> to handle streaming timeline switches
@ -10713,7 +10713,7 @@ ALTER EXTENSION hstore UPDATE;
linkend="APP-PG-DUMPALL"><application>pg_dumpall</></link>, <link
linkend="app-pgbasebackup"><application>pg_basebackup</></link>, and
<link
linkend="app-pgreceivexlog"><application>pg_receivexlog</></link>
linkend="app-pgreceivewal"><application>pg_receivexlog</></link>
to allow specifying a connection string (Amit Kapila)
</para>
</listitem>
@ -11250,7 +11250,7 @@ ALTER EXTENSION hstore UPDATE;
<listitem>
<para>
Add <link linkend="pgxlogdump"><application>pg_xlogdump</></link>
Add <link linkend="pgwaldump"><application>pg_xlogdump</></link>
contrib program (Andres Freund)
</para>
</listitem>

View File

@ -8917,8 +8917,9 @@ Branch: REL9_4_STABLE [c2b06ab17] 2015-01-30 22:45:58 -0500
<listitem>
<para>
Make <xref linkend="APP-PGRESETXLOG"> with option <option>-n</>
output current and potentially changed values (Rajeev Rastogi)
Make <link linkend="app-pgresetwal"><application>pg_resetxlog</></>
with option <option>-n</> output current and potentially changed
values (Rajeev Rastogi)
</para>
</listitem>
@ -9518,8 +9519,9 @@ Branch: REL9_4_STABLE [c2b06ab17] 2015-01-30 22:45:58 -0500
<listitem>
<para>
Allow <xref linkend="pgxlogdump"> to report a live log stream
with <option>--follow</> (Heikki Linnakangas)
Allow <link linkend="pgwaldump"><application>pg_xlogdump</></>
to report a live log stream with <option>--follow</>
(Heikki Linnakangas)
</para>
</listitem>

View File

@ -6265,7 +6265,7 @@ Add GUC and storage parameter to set the maximum size of GIN pending list.
linkend="pgarchivecleanup"><application>pg_archivecleanup</></>,
<link linkend="pgtestfsync"><application>pg_test_fsync</></>,
<link linkend="pgtesttiming"><application>pg_test_timing</></>,
and <link linkend="pgxlogdump"><application>pg_xlogdump</></>
and <link linkend="pgwaldump"><application>pg_xlogdump</></>
from <filename>contrib</> to <filename>src/bin</> (Peter Eisentraut)
</para>
@ -6292,7 +6292,7 @@ Add GUC and storage parameter to set the maximum size of GIN pending list.
-->
<para>
Allow <link
linkend="app-pgreceivexlog"><application>pg_receivexlog</></>
linkend="app-pgreceivewal"><application>pg_receivexlog</></>
to manage physical replication slots (Michael Paquier)
</para>
@ -6308,7 +6308,7 @@ Add GUC and storage parameter to set the maximum size of GIN pending list.
-->
<para>
Allow <link
linkend="app-pgreceivexlog"><application>pg_receivexlog</></>
linkend="app-pgreceivewal"><application>pg_receivexlog</></>
to synchronously flush <acronym>WAL</> to storage using new
<option>--synchronous</> option (Furuya Osamu, Fujii Masao)
</para>
@ -6368,7 +6368,7 @@ Add GUC and storage parameter to set the maximum size of GIN pending list.
2014-09-19 [bdd5726] Andres..: Add the capability to display summary statistic..
-->
<para>
Add <link linkend="pgxlogdump"><application>pg_xlogdump</></> option
Add <link linkend="pgwaldump"><application>pg_xlogdump</></> option
<option>--stats</> to display summary statistics (Abhijit Menon-Sen)
</para>
</listitem>