Stress that backup_label file is critical in the docs.

It is surprisingly common mistake to leave out backup_label file from a base
backup. Say more explicitly that it must be included.

Jeff Janes, with minor rewording by me.
This commit is contained in:
Heikki Linnakangas 2013-05-07 16:55:04 +03:00
parent 817a89423f
commit 7f03a791fa
1 changed files with 7 additions and 4 deletions

View File

@ -826,7 +826,8 @@ SELECT pg_start_backup('label');
<function>pg_start_backup</> creates a <firstterm>backup label</> file,
called <filename>backup_label</>, in the cluster directory with
information about your backup, including the start time and label
string.
string. The file is critical to the integrity of the backup, should
you need to restore from it.
</para>
<para>
@ -945,9 +946,11 @@ SELECT pg_stop_backup();
The backup label file includes the label string you gave to
<function>pg_start_backup</>, as well as the time at which
<function>pg_start_backup</> was run, and the name of the starting WAL
file. In case of confusion it is
therefore possible to look inside a backup dump file and determine
exactly which backup session the dump file came from.
file. In case of confusion it is therefore possible to look inside a
backup dump file and determine exactly which backup session the dump file
came from. However, this file is not merely for your information; its
presence and contents are critical to the proper operation of the system's
recovery process.
</para>
<para>