diff options
author | Robert Haas <rhaas@postgresql.org> | 2024-09-27 08:40:24 -0400 |
---|---|---|
committer | Robert Haas <rhaas@postgresql.org> | 2024-09-27 08:40:24 -0400 |
commit | 8dfd3129027969fdd2d9d294220c867d2efd84aa (patch) | |
tree | 9b5866e22d0105d2fb62cde9599be0b281831469 /doc/src | |
parent | 8410f738ad2fd94fc068ce0189e1ae04ef3c12e3 (diff) | |
download | postgresql-8dfd3129027969fdd2d9d294220c867d2efd84aa.tar.gz postgresql-8dfd3129027969fdd2d9d294220c867d2efd84aa.zip |
pg_verifybackup: Verify tar-format backups.
This also works for compressed tar-format backups. However, -n must be
used, because we use pg_waldump to verify WAL, and it doesn't yet know
how to verify WAL that is stored inside of a tarfile.
Amul Sul, reviewed by Sravan Kumar and by me, and revised by me.
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/ref/pg_verifybackup.sgml | 47 |
1 files changed, 45 insertions, 2 deletions
diff --git a/doc/src/sgml/ref/pg_verifybackup.sgml b/doc/src/sgml/ref/pg_verifybackup.sgml index a3f167f9f6e..53341024cd2 100644 --- a/doc/src/sgml/ref/pg_verifybackup.sgml +++ b/doc/src/sgml/ref/pg_verifybackup.sgml @@ -34,8 +34,12 @@ PostgreSQL documentation 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 - of the backup. The backup must be stored in the "plain" - format; a "tar" format backup can be checked after extracting it. + of the backup. The backup may be stored either in the "plain" or the "tar" + format; this includes tar-format backups compressed with any algorithm + supported by <application>pg_basebackup</application>. However, at present, + <literal>WAL</literal> verification is supported only for plain-format + backups. Therefore, if the backup is stored in tar-format, the + <literal>-n, --no-parse-wal</literal> option should be used. </para> <para> @@ -169,6 +173,45 @@ PostgreSQL documentation </varlistentry> <varlistentry> + <term><option>-F <replaceable class="parameter">format</replaceable></option></term> + <term><option>--format=<replaceable class="parameter">format</replaceable></option></term> + <listitem> + <para> + Specifies the format of the backup. <replaceable>format</replaceable> + can be one of the following: + + <variablelist> + <varlistentry> + <term><literal>p</literal></term> + <term><literal>plain</literal></term> + <listitem> + <para> + Backup consists of plain files with the same layout as the + source server's data directory and tablespaces. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>t</literal></term> + <term><literal>tar</literal></term> + <listitem> + <para> + Backup consists of tar files, which may be compressed. A valid + backup includes the main data directory in a file named + <filename>base.tar</filename>, the WAL files in + <filename>pg_wal.tar</filename>, and separate tar files for + each tablespace, named after the tablespace's OID. If the backup + is compressed, the relevant compression extension is added to the + end of each file name. + </para> + </listitem> + </varlistentry> + </variablelist></para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>-n</option></term> <term><option>--no-parse-wal</option></term> <listitem> |