Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the description of incremental backups with locality aware #19398

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update the description of incremental backups with locality aware #19398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/current/v24.3/take-and-restore-locality-aware-backups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ To restore from a specific backup, use [`RESTORE FROM {subdirectory} IN ...`]({%

## Create an incremental locality-aware backup

If you backup to a destination already containing a [full backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups), an [incremental backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups) will be appended to the full backup in a subdirectory. When you're taking an incremental backup, you must ensure that the incremental backup localities match the full backup localities otherwise you will receive an error. Alternatively, take another full backup with the matching localities before running the incremental backup.
If you back up to a destination already containing a [full backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups), an [incremental backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups) will be appended to the full backup in a subdirectory. To take a locality-aware incremental backup and restore from it successfully, you must maintain the same storage URI and `COCKROACH_LOCALITY` mappings that were established by the corresponding full backup. Alternatively, take another full backup with the matching localities and URIs before running the incremental backup.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there was some confusion/ambiguity with my answer in Slack. The incremental mappings don't have to match the full backup mappings, they just have to be consistent. So if with one BACKUP command you have incremental_location = ('foo?region=us-east', 'bar?region=us-west', 'baz?region=us-central'), then that mapping must be maintained for all incrementals in that chain. @dt if you could confirm this behavior that'd be helpful!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @kev-cao, are you only to referring to incremental_location in your comment here? Or, all incrementals? I haven't changed the text for the incremental_location option on this page. This update is only referring to regular incrementals — so I want to check whether I need to adjust the edits I've made or not.


There is different syntax for taking an incremental backup depending on where you need to store the backups:

Expand Down
2 changes: 1 addition & 1 deletion src/current/v25.1/take-and-restore-locality-aware-backups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ To restore from a specific backup, use [`RESTORE FROM {subdirectory} IN ...`]({%

## Create an incremental locality-aware backup

If you backup to a destination already containing a [full backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups), an [incremental backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups) will be appended to the full backup in a subdirectory. When you're taking an incremental backup, you must ensure that the incremental backup localities match the full backup localities otherwise you will receive an error. Alternatively, take another full backup with the matching localities before running the incremental backup.
If you back up to a destination already containing a [full backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups), an [incremental backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups) will be appended to the full backup in a subdirectory. To take a locality-aware incremental backup and restore from it successfully, you must maintain the same storage URI and `COCKROACH_LOCALITY` mappings that were established by the corresponding full backup. Alternatively, take another full backup with the matching localities and URIs before running the incremental backup.

There is different syntax for taking an incremental backup depending on where you need to store the backups:

Expand Down
Loading