Skip to content

Commit 7c29b63

Browse files
indrupspostgres-dev
authored andcommitted
[DOC] [PGPRO-7104] Remove outdated options and PostgreSQL versions from documentation [skip travis]
1 parent 623b659 commit 7c29b63

File tree

1 file changed

+4
-168
lines changed

1 file changed

+4
-168
lines changed

doc/pgprobackup.xml

+4-168
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ doc/src/sgml/pgprobackup.sgml
164164
recovery of <productname>PostgreSQL</productname> database clusters.
165165
It is designed to perform periodic backups of the <productname>PostgreSQL</productname>
166166
instance that enable you to restore the server in case of a failure.
167-
<application>pg_probackup</application> supports PostgreSQL 9.5 or higher.
167+
<application>pg_probackup</application> supports PostgreSQL 10 or higher.
168168
</para>
169169

170170
<itemizedlist spacing="compact">
@@ -416,7 +416,7 @@ doc/src/sgml/pgprobackup.sgml
416416
</listitem>
417417
<listitem>
418418
<para>
419-
On Unix systems, for <productname>PostgreSQL</productname> 10 or lower,
419+
On Unix systems, for <productname>PostgreSQL</productname> 10,
420420
a backup can be made only by the same OS user that has started the <productname>PostgreSQL</productname>
421421
server. For example, if <productname>PostgreSQL</productname> server is started by
422422
user <literal>postgres</literal>, the <literal>backup</literal> command must also be run
@@ -821,49 +821,6 @@ pg_probackup add-instance -B <replaceable>backup_dir</replaceable> -D <replaceab
821821
only in the database <emphasis role="strong">used for
822822
connection</emphasis> to the <productname>PostgreSQL</productname> server:
823823
</para>
824-
<para>
825-
For <productname>PostgreSQL</productname> 9.5:
826-
</para>
827-
<programlisting>
828-
BEGIN;
829-
CREATE ROLE backup WITH LOGIN;
830-
GRANT USAGE ON SCHEMA pg_catalog TO backup;
831-
GRANT EXECUTE ON FUNCTION pg_catalog.current_setting(text) TO backup;
832-
GRANT EXECUTE ON FUNCTION pg_catalog.set_config(text, text, boolean) TO backup;
833-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_is_in_recovery() TO backup;
834-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_start_backup(text, boolean) TO backup;
835-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_stop_backup() TO backup;
836-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_create_restore_point(text) TO backup;
837-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_switch_xlog() TO backup;
838-
GRANT EXECUTE ON FUNCTION pg_catalog.txid_current() TO backup;
839-
GRANT EXECUTE ON FUNCTION pg_catalog.txid_current_snapshot() TO backup;
840-
GRANT EXECUTE ON FUNCTION pg_catalog.txid_snapshot_xmax(txid_snapshot) TO backup;
841-
COMMIT;
842-
</programlisting>
843-
<para>
844-
For <productname>PostgreSQL</productname> 9.6:
845-
</para>
846-
<programlisting>
847-
BEGIN;
848-
CREATE ROLE backup WITH LOGIN;
849-
GRANT USAGE ON SCHEMA pg_catalog TO backup;
850-
GRANT EXECUTE ON FUNCTION pg_catalog.current_setting(text) TO backup;
851-
GRANT EXECUTE ON FUNCTION pg_catalog.set_config(text, text, boolean) TO backup;
852-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_is_in_recovery() TO backup;
853-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_start_backup(text, boolean, boolean) TO backup;
854-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_stop_backup(boolean) TO backup;
855-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_create_restore_point(text) TO backup;
856-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_switch_xlog() TO backup;
857-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_last_xlog_replay_location() TO backup;
858-
GRANT EXECUTE ON FUNCTION pg_catalog.txid_current() TO backup;
859-
GRANT EXECUTE ON FUNCTION pg_catalog.txid_current_snapshot() TO backup;
860-
GRANT EXECUTE ON FUNCTION pg_catalog.txid_snapshot_xmax(txid_snapshot) TO backup;
861-
GRANT EXECUTE ON FUNCTION pg_catalog.pg_control_checkpoint() TO backup;
862-
COMMIT;
863-
</programlisting>
864-
<para>
865-
For <productname>PostgreSQL</productname> versions 10 &mdash; 14:
866-
</para>
867824
<programlisting>
868825
BEGIN;
869826
CREATE ROLE backup WITH LOGIN;
@@ -1110,7 +1067,7 @@ archive_command = '"<replaceable>install_dir</replaceable>/pg_probackup" archive
11101067
<refsect2 id="pbk-setting-up-backup-from-standby">
11111068
<title>Setting up Backup from Standby</title>
11121069
<para>
1113-
For <productname>PostgreSQL</productname> 9.6 or higher, <application>pg_probackup</application> can take backups from
1070+
<application>pg_probackup</application> can take backups from
11141071
a standby server. This requires the following additional setup:
11151072
</para>
11161073
<itemizedlist spacing="compact">
@@ -5013,8 +4970,7 @@ pg_probackup catchup -b <replaceable>catchup_mode</replaceable>
50134970
<listitem>
50144971
<para>
50154972
Specifies the LSN of the write-ahead log location up to which
5016-
recovery will proceed. Can be used only when restoring
5017-
a database cluster of major version 10 or higher.
4973+
recovery will proceed.
50184974
</para>
50194975
</listitem>
50204976
</varlistentry>
@@ -5976,124 +5932,6 @@ pg_probackup catchup -b <replaceable>catchup_mode</replaceable>
59765932
</variablelist>
59775933
</para>
59785934
</refsect3>
5979-
<refsect3 id="pbk-replica-options">
5980-
<title>Replica Options</title>
5981-
<para>
5982-
This section describes the options related to taking a backup
5983-
from standby.
5984-
</para>
5985-
<note>
5986-
<para>
5987-
Starting from <application>pg_probackup</application> 2.0.24, backups can be
5988-
taken from standby without connecting to the master server,
5989-
so these options are no longer required. In lower versions,
5990-
<application>pg_probackup</application> had to connect to the master to determine
5991-
recovery time — the earliest moment for which you can
5992-
restore a consistent state of the database cluster.
5993-
</para>
5994-
</note>
5995-
<para>
5996-
<variablelist>
5997-
<varlistentry>
5998-
<term><option>--master-db=<replaceable>dbname</replaceable></option></term>
5999-
<listitem>
6000-
<para>
6001-
Deprecated. Specifies the name of the database on the master
6002-
server to connect to. The connection is used only for managing
6003-
the backup process, so you can connect to any existing
6004-
database. Can be set in the <filename>pg_probackup.conf</filename> using the
6005-
<xref linkend="pbk-set-config"/> command.
6006-
</para>
6007-
<para>
6008-
Default: <literal>postgres</literal>, the default <productname>PostgreSQL</productname> database
6009-
</para>
6010-
</listitem>
6011-
</varlistentry>
6012-
6013-
<varlistentry>
6014-
<term><option>--master-host=<replaceable>host</replaceable></option></term>
6015-
<listitem>
6016-
<para>
6017-
Deprecated. Specifies the host name of the system on which the
6018-
master server is running.
6019-
</para>
6020-
</listitem>
6021-
</varlistentry>
6022-
6023-
<varlistentry>
6024-
<term><option>--master-port=<replaceable>port</replaceable></option></term>
6025-
<listitem>
6026-
<para>
6027-
Deprecated. Specifies the TCP port or the local Unix domain
6028-
socket file extension on which the master server is listening
6029-
for connections.
6030-
</para>
6031-
<para>
6032-
Default: <literal>5432</literal>, the <productname>PostgreSQL</productname> default port
6033-
</para>
6034-
</listitem>
6035-
</varlistentry>
6036-
6037-
<varlistentry>
6038-
<term><option>--master-user=<replaceable>username</replaceable></option></term>
6039-
<listitem>
6040-
<para>
6041-
Deprecated. User name to connect as.
6042-
</para>
6043-
<para>
6044-
Default: <literal>postgres</literal>,
6045-
the <productname>PostgreSQL</productname> default user name
6046-
</para>
6047-
</listitem>
6048-
</varlistentry>
6049-
6050-
<varlistentry>
6051-
<term><option>--replica-timeout=<replaceable>timeout</replaceable></option></term>
6052-
<term><option></option></term>
6053-
<listitem>
6054-
<para>
6055-
Deprecated. Wait time for WAL segment streaming via
6056-
replication, in seconds. By default, <application>pg_probackup</application> waits 300
6057-
seconds. You can also define this parameter in the
6058-
<filename>pg_probackup.conf</filename> configuration file using the
6059-
<xref linkend="pbk-set-config"/> command.
6060-
</para>
6061-
<para>
6062-
Default: <literal>300 sec</literal>
6063-
</para>
6064-
</listitem>
6065-
</varlistentry>
6066-
</variablelist>
6067-
</para>
6068-
</refsect3>
6069-
6070-
<refsect3 id="pbk-test-options">
6071-
<title>Testing and Debugging Options</title>
6072-
<para>
6073-
This section describes options useful only in a test or development environment.
6074-
</para>
6075-
<para>
6076-
<variablelist>
6077-
<varlistentry>
6078-
<term><option>--destroy-all-other-dbs</option></term>
6079-
<listitem>
6080-
<para>
6081-
By default, <application>pg_probackup</application> exits with an
6082-
error if an attempt is made to perform a partial incremental restore
6083-
since this destroys databases not included in the restore set. This
6084-
flag allows you to suppress the error and proceed with the partial
6085-
incremental restore (e.g., to keep a development database snapshot
6086-
up-to-date with a production one). This option can be used with the
6087-
<xref linkend="pbk-restore"/> command.
6088-
</para>
6089-
<important>
6090-
<para>Never use this flag in a production cluster.</para>
6091-
</important>
6092-
</listitem>
6093-
</varlistentry>
6094-
</variablelist>
6095-
</para>
6096-
</refsect3>
60975935
</refsect2>
60985936
</refsect1>
60995937

@@ -6305,8 +6143,6 @@ xlog-seg-size = 16777216
63056143
pgdatabase = backupdb
63066144
pghost = postgres_host
63076145
pguser = backup
6308-
# Replica parameters
6309-
replica-timeout = 5min
63106146
# Archive parameters
63116147
archive-timeout = 5min
63126148
# Logging parameters

0 commit comments

Comments
 (0)