Skip to content

Commit 95eb875

Browse files
authored
Merge pull request #272 from percona/pxb-3232
PXB-3232 Encrypted backup with xbstream larger than unencrypted backup
2 parents b279809 + 8a548ee commit 95eb875

File tree

2 files changed

+24
-17
lines changed

2 files changed

+24
-17
lines changed

docs/create-compressed-backup.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To make a compressed backup, use the `--compress` option along with the `--backu
66

77
## Version updates
88

9-
??? note "From Percona XtraBackup 8.0.34-29"
9+
??? note "Percona XtraBackup 8.0.34-29 and later"
1010

1111
Percona XtraBackup removes `qpress/QuickLZ` and moves the `ZSTD` compression method to [General Availability](glossary.md#general-availability-ga). With this version `ZSTD` becomes the default compression method for the `--compress` option.
1212

@@ -62,7 +62,7 @@ To make a compressed backup, use the `--compress` option along with the `--backu
6262

6363
To decompress files, use the `--decompress` option.
6464

65-
??? note "From Percona XtraBackup 8.0.31-24"
65+
??? note "Percona XtraBackup 8.0.31-24 to 8.0.34-29 "
6666

6767
Using qpress/QuickLZ to compress backups is deprecated and may be removed in future versions. We recommend using either `LZ4` or Zstandard (`ZSTD`) compression algorithms. `ZSTD` compression algorithm is in [tech preview](glossary.md#tech-preview).
6868

@@ -76,6 +76,9 @@ To make a compressed backup, use the `--compress` option along with the `--backu
7676
$ sudo apt install qpress
7777
```
7878

79+
80+
81+
7982
!!! note
8083

8184
Enable the repository: `percona-release enable-only tools release`.
@@ -144,6 +147,10 @@ To make a compressed backup, use the `--compress` option along with the `--backu
144147
170223 13:00:39 completed OK!
145148
```
146149

150+
Using `--encrypt` might create larger backups than expected when used with InnoDB Page Compression.
151+
152+
To avoid this issue with compressed backups, use the `--compress` option with the `--xbstream` option in Percona XtraBackup 8.0.31-24 and later.
153+
147154
The next step is to [prepare](prepare-compressed-backup.md) the backup in order to [restore](restore-a-backup.md) it.
148155

149156

docs/take-streaming-backup.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
# Take a streaming backup
22

3-
**Percona XtraBackup** supports streaming mode. Streaming mode sends a backup to `STDOUT` in the *xbstream* format instead of copying the files to the backup directory.
3+
Percona XtraBackup supports streaming mode. Streaming mode sends a backup to `STDOUT` in the xbstream format instead of copying the files to the backup directory.
44

5-
This method allows you to use other programs to filter the output of the backup,
6-
providing greater flexibility for storage of the backup. For example,
7-
compression is achieved by piping the output to a compression utility. One of
8-
the benefits of streaming backups and using Unix pipes is that the backups can
9-
be automatically encrypted.
5+
This method enables you to utilize other programs to filter the backup output, enhancing flexibility in backup storage. For instance, compression can be achieved by directing the output to a compression utility. One advantage of streaming backups and employing Unix pipes is that backups can be automatically encrypted.
106

11-
To use the streaming feature, you must use the `--stream`,
12-
providing the format of the stream (`xbstream` ) and where to store
13-
the temporary files:
7+
## Version changes
8+
9+
Using `--encrypt` might create larger backups than expected when used with InnoDB Page Compression.
10+
11+
To avoid this issue with compressed backups, use the `--compress` option with the `--xbstream` option in Percona XtraBackup 8.0.31-24 and later.
12+
13+
## Use streaming
14+
15+
To utilize the streaming feature, you need to employ the `--stream` option, specifying the stream format (xbstream ) and the location for storing temporary files:
1416

1517
```{.bash data-prompt="$"}
1618
$ xtrabackup --stream=xbstream --target-dir=/tmp
1719
```
1820

19-
*xtrabackup* uses *xbstream* to stream all of the data files to `STDOUT`, in a
20-
special `xbstream` format. After it finishes streaming all of the data files
21-
to `STDOUT`, it stops xtrabackup and streams the saved log file too.
21+
xtrabackup uses xbstream to stream all of the data files to `STDOUT`, in a
22+
special `xbstream` format. After all data is streamed, xtrabackup stops and also streams the saved transaction log.
2223

23-
When compression is enabled, *xtrabackup* compresses the output data, except for the metadata, using the specified compression algorithm. Read about the supported compression algorithms in the [Create a compressed backup](create-compressed-backup.md) document.
24+
When compression is enabled, xtrabackup compresses the output data, except for the metadata, using the specified compression algorithm. Read about the supported compression algorithms in the [Create a compressed backup](create-compressed-backup.md) document.
2425

25-
Using *xbstream* as a stream option, backups can be copied and compressed in parallel. This option can significantly improve the speed of the backup process. In case backups
26-
were both compressed and encrypted, they must be decrypted before they are uncompressed.
26+
With xbstream, backups can be copied and compressed simultaneously, significantly speeding up the process. However, if backups are both compressed and encrypted, they need to be decrypted before uncompressing.
2727

2828
|Task | Command |
2929
|---------|------|

0 commit comments

Comments
 (0)