diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/ref/allfiles.sgml | 2 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_basebackup.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_verifybackup.sgml (renamed from doc/src/sgml/ref/pg_validatebackup.sgml) | 56 | ||||
| -rw-r--r-- | doc/src/sgml/reference.sgml | 2 |
4 files changed, 32 insertions, 32 deletions
diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml index ab71176cdf3..0f0064150c4 100644 --- a/doc/src/sgml/ref/allfiles.sgml +++ b/doc/src/sgml/ref/allfiles.sgml @@ -211,7 +211,7 @@ Complete list of usable sgml source files in this directory. <!ENTITY pgResetwal SYSTEM "pg_resetwal.sgml"> <!ENTITY pgRestore SYSTEM "pg_restore.sgml"> <!ENTITY pgRewind SYSTEM "pg_rewind.sgml"> -<!ENTITY pgValidateBackup SYSTEM "pg_validatebackup.sgml"> +<!ENTITY pgVerifyBackup SYSTEM "pg_verifybackup.sgml"> <!ENTITY pgtestfsync SYSTEM "pgtestfsync.sgml"> <!ENTITY pgtesttiming SYSTEM "pgtesttiming.sgml"> <!ENTITY pgupgrade SYSTEM "pgupgrade.sgml"> diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml index d9c981cebb9..01ce44ee220 100644 --- a/doc/src/sgml/ref/pg_basebackup.sgml +++ b/doc/src/sgml/ref/pg_basebackup.sgml @@ -568,7 +568,7 @@ PostgreSQL documentation <para> Disables generation of a backup manifest. If this option is not specified, the server will generate and send a backup manifest - which can be verified using <xref linkend="app-pgvalidatebackup" />. + which can be verified using <xref linkend="app-pgverifybackup" />. The manifest is a list of every file present in the backup with the exception of any WAL files that may be included. It also stores the size, last modification time, and an optional checksum for each file. @@ -620,7 +620,7 @@ PostgreSQL documentation verified not to have been modified since the backup was taken. </para> <para> - <xref linkend="app-pgvalidatebackup" /> can be used to check the + <xref linkend="app-pgverifybackup" /> can be used to check the integrity of a backup against the backup manifest. </para> </listitem> diff --git a/doc/src/sgml/ref/pg_validatebackup.sgml b/doc/src/sgml/ref/pg_verifybackup.sgml index 5c626200f68..0ab92b38f7b 100644 --- a/doc/src/sgml/ref/pg_validatebackup.sgml +++ b/doc/src/sgml/ref/pg_verifybackup.sgml @@ -1,28 +1,28 @@ <!-- -doc/src/sgml/ref/pg_validatebackup.sgml +doc/src/sgml/ref/pg_verifybackup.sgml PostgreSQL documentation --> -<refentry id="app-pgvalidatebackup"> - <indexterm zone="app-pgvalidatebackup"> - <primary>pg_validatebackup</primary> +<refentry id="app-pgverifybackup"> + <indexterm zone="app-pgverifybackup"> + <primary>pg_verifybackup</primary> </indexterm> <refmeta> - <refentrytitle>pg_validatebackup</refentrytitle> + <refentrytitle>pg_verifybackup</refentrytitle> <manvolnum>1</manvolnum> <refmiscinfo>Application</refmiscinfo> </refmeta> <refnamediv> - <refname>pg_validatebackup</refname> + <refname>pg_verifybackup</refname> <refpurpose>verify the integrity of a base backup of a <productname>PostgreSQL</productname> cluster</refpurpose> </refnamediv> <refsynopsisdiv> <cmdsynopsis> - <command>pg_validatebackup</command> + <command>pg_verifybackup</command> <arg rep="repeat"><replaceable>option</replaceable></arg> </cmdsynopsis> </refsynopsisdiv> @@ -32,7 +32,7 @@ PostgreSQL documentation Description </title> <para> - <application>pg_validatebackup</application> is used to check the + <application>pg_verifybackup</application> is used to check the integrity of a database cluster backup taken using <command>pg_basebackup</command> against a <literal>backup_manifest</literal> generated by the server at the time @@ -41,27 +41,27 @@ PostgreSQL documentation </para> <para> - It is important to note that the validation which is performed by - <application>pg_validatebackup</application> does not and can not include + It is important to note that that the validation which is performed by + <application>pg_verifybackup</application> does not and can not include every check which will be performed by a running server when attempting to make use of the backup. Even if you use this tool, you should still perform test restores and verify that the resulting databases work as expected and that they appear to contain the correct data. However, - <application>pg_validatebackup</application> can detect many problems + <application>pg_verifybackup</application> can detect many problems that commonly occur due to storage problems or user error. </para> <para> Backup verification proceeds in four stages. First, - <literal>pg_validatebackup</literal> reads the + <literal>pg_verifybackup</literal> reads the <literal>backup_manifest</literal> file. If that file does not exist, cannot be read, is malformed, or fails verification - against its own internal checksum, <literal>pg_validatebackup</literal> + against its own internal checksum, <literal>pg_verifybackup</literal> will terminate with a fatal error. </para> <para> - Second, <literal>pg_validatebackup</literal> will attempt to verify that + Second, <literal>pg_verifybackup</literal> will attempt to verify that the data files currently stored on disk are exactly the same as the data files which the server intended to send, with some exceptions that are described below. Extra and missing files will be detected, with a few @@ -79,7 +79,7 @@ PostgreSQL documentation </para> <para> - Next, <literal>pg_validatebackup</literal> will checksum all the files, + Next, <literal>pg_verifybackup</literal> will checksum all the files, compare the checksums against the values in the manifest, and emit errors for any files for which the computed checksum does not match the checksum stored in the manifest. This step is not performed for any files @@ -89,12 +89,12 @@ PostgreSQL documentation </para> <para> - Finally, <literal>pg_validatebackup</literal> will use the manifest to + Finally, <literal>pg_verifybackup</literal> will use the manifest to verify that the write-ahead log records which will be needed to recover the backup are present and that they can be read and parsed. The <literal>backup_manifest</literal> contains information about which write-ahead log records will be needed, and - <literal>pg_validatebackup</literal> will use that information to + <literal>pg_verifybackup</literal> will use that information to invoke <literal>pg_waldump</literal> to parse those write-ahed log records. The <literal>--quiet</literal> flag will be used, so that <literal>pg_waldump</literal> will only report errors, without producing @@ -112,7 +112,7 @@ PostgreSQL documentation are present, they will not be checked by this tool, although a separate invocation of <literal>pg_waldump</literal> could be used for that purpose. Also note that WAL verification is version-specific: you - must use the version of <literal>pg_validatebackup</literal>, and thus of + must use the version of <literal>pg_verifybackup</literal>, and thus of <literal>pg_waldump</literal>, which pertains to the backup being checked. In contrast, the data file integrity checks should work with any version of the server that generates a <literal>backup_manifest</literal> file. @@ -184,7 +184,7 @@ PostgreSQL documentation <term><option>--quiet</option></term> <listitem> <para> - Don't print anything when a backup is successfully validated. + Don't print anything when a backup is successfully verified. </para> </listitem> </varlistentry> @@ -194,7 +194,7 @@ PostgreSQL documentation <term><option>--skip-checksums</option></term> <listitem> <para> - Do not validate data file checksums. The presence or absence of + Do not verify data file checksums. The presence or absence of files and the sizes of those files will still be checked. This is much faster, because the files themselves do not need to be read. </para> @@ -224,7 +224,7 @@ PostgreSQL documentation <term><option>--version</option></term> <listitem> <para> - Print the <application>pg_validatebackup</application> version and exit. + Print the <application>pg_verifybackup</application> version and exit. </para> </listitem> </varlistentry> @@ -234,7 +234,7 @@ PostgreSQL documentation <term><option>--help</option></term> <listitem> <para> - Show help about <application>pg_validatebackup</application> command + Show help about <application>pg_verifybackup</application> command line arguments, and exit. </para> </listitem> @@ -250,31 +250,31 @@ PostgreSQL documentation <para> To create a base backup of the server at <literal>mydbserver</literal> and - validate the integrity of the backup: + verify the integrity of the backup: <screen> <prompt>$</prompt> <userinput>pg_basebackup -h mydbserver -D /usr/local/pgsql/data</userinput> -<prompt>$</prompt> <userinput>pg_validatebackup /usr/local/pgsql/data</userinput> +<prompt>$</prompt> <userinput>pg_verifybackup /usr/local/pgsql/data</userinput> </screen> </para> <para> To create a base backup of the server at <literal>mydbserver</literal>, move - the manifest somewhere outside the backup directory, and validate the + the manifest somewhere outside the backup directory, and verify the backup: <screen> <prompt>$</prompt> <userinput>pg_basebackup -h mydbserver -D /usr/local/pgsql/backup1234</userinput> <prompt>$</prompt> <userinput>mv /usr/local/pgsql/backup1234/backup_manifest /my/secure/location/backup_manifest.1234</userinput> -<prompt>$</prompt> <userinput>pg_validatebackup -m /my/secure/location/backup_manifest.1234 /usr/local/pgsql/backup1234</userinput> +<prompt>$</prompt> <userinput>pg_verifybackup -m /my/secure/location/backup_manifest.1234 /usr/local/pgsql/backup1234</userinput> </screen> </para> <para> - To validate a backup while ignoring a file that was added manually to the + To verify a backup while ignoring a file that was added manually to the backup directory, and also skipping checksum verification: <screen> <prompt>$</prompt> <userinput>pg_basebackup -h mydbserver -D /usr/local/pgsql/data</userinput> <prompt>$</prompt> <userinput>edit /usr/local/pgsql/data/note.to.self</userinput> -<prompt>$</prompt> <userinput>pg_validatebackup --ignore=note.to.self --skip-checksums /usr/local/pgsql/data</userinput> +<prompt>$</prompt> <userinput>pg_verifybackup --ignore=note.to.self --skip-checksums /usr/local/pgsql/data</userinput> </screen> </para> diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml index d25a77b13c8..dd2bddab8c4 100644 --- a/doc/src/sgml/reference.sgml +++ b/doc/src/sgml/reference.sgml @@ -255,7 +255,7 @@ &pgReceivewal; &pgRecvlogical; &pgRestore; - &pgValidateBackup; + &pgVerifyBackup; &psqlRef; &reindexdb; &vacuumdb; |