Skip to content

Commit 6381c81

Browse files
authored
br: add compatibility between log backup and PITR (#20485)
1 parent 717e1a4 commit 6381c81

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

br/br-pitr-manual.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,3 +495,25 @@ tiup br restore point --pd="${PD_IP}:2379"
495495
--master-key-crypter-method aes128-ctr
496496
--master-key "local:///path/to/master.key"
497497
```
498+
499+
### Compatibility between ongoing log backup and snapshot restore
500+
501+
Starting from v9.0.0, when a log backup task is running, if all of the following conditions are met, you can still perform snapshot restore (`br restore [full|database|table]`) and allow the restored data to be properly recorded by the ongoing log backup (hereinafter referred to as "log backup"):
502+
503+
- The node performing backup and restore operations has the following necessary permissions:
504+
- Read access to the external storage containing the backup source, for snapshot restore
505+
- Write access to the target external storage used by the log backup
506+
- The target external storage for the log backup is Amazon S3 (`s3://`), Google Cloud Storage (`gcs://`), or Azure Blob Storage (`azblob://`).
507+
- The data to be restored uses the same type of external storage as the target storage for the log backup.
508+
- Neither the data to be restored nor the log backup has enabled local encryption. For details, see [log backup encryption](#encrypt-the-log-backup-data) and [snapshot backup encryption](/br/br-snapshot-manual.md#encrypt-the-backup-data).
509+
510+
If any of the above conditions are not met, or if you need to perform a point-in-time recovery, while a log backup task is running, BR refuses to proceed with the data recovery. In this case, you can complete the recovery by following these steps:
511+
512+
1. [Stop the log backup task](#stop-a-log-backup-task).
513+
2. Perform the data restore.
514+
3. After the restore is complete, perform a new snapshot backup.
515+
4. [Restart the log backup task](#restart-a-log-backup-task).
516+
517+
> **Note:**
518+
>
519+
> When restoring a log backup that contains records of snapshot (full) restore data, you must use BR v9.0.0 or later. Otherwise, restoring the recorded full restore data might fail.

0 commit comments

Comments
 (0)