Skip to content

Add fdbrestore status --json #14141

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

Merged
saintstack merged 4 commits into from
Oct 23, 2026
Merged

Add fdbrestore status --json #14141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a62b75
Add fdbrestore status --json
Sep 25, 2026
c89b3bd
Share the avg-bytes-per-task guard between the text and JSON renderers
Sep 25, 2026
b8cae66
Read the restore state once in getStatusSnapshot_impl
Oct 5, 2026
19aa342
Trim review nits: drop redundant status comments and help wording
Oct 22, 2026
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
16 changes: 11 additions & 5 deletions fdbbackup/backup.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -609,6 +609,7 @@ CSimpleOpt::SOption g_rgRestoreOptions[] = {
{ OPT_RESTORE_BEGIN_VERSION, "--begin-version", SO_REQ_SEP },
{ OPT_RESTORE_INCONSISTENT_SNAPSHOT_ONLY, "--inconsistent-snapshot-only", SO_NONE },
{ OPT_ENCRYPTION_KEY_FILE, "--encryption-key-file", SO_REQ_SEP },
{ OPT_JSON, "--json", SO_NONE },
TLS_OPTION_FLAGS,
SO_END_OF_OPTIONS
};
Expand Down Expand Up @@ -1010,6 +1011,9 @@ static void printRestoreUsage(bool devhelp) {
printf(" -t, --tagname TAGNAME\n");
printf(" The restore tag to act on. Default is 'default'\n");
printf("\n");
printf(" Options for status:\n\n");
printf(" --json Emit the status as a JSON document.\n");
printf("\n");
printf(" Options for start:\n\n");
printf(" -r URL The Backup URL for the restore to read from.\n");
printBackupContainerInfo();
Expand Down Expand Up @@ -1140,7 +1144,7 @@ static void printDBBackupUsage(bool devhelp) {
" The path of a file containing the connection string for the\n"
" source FoundationDB cluster.\n");
printf(" -e ERRORLIMIT The maximum number of errors printed by status (default is 20).\n");
printf(" --json Emit status as a JSON document instead of text. Reports every error\n"
printf(" --json Emit status as a JSON document. Reports every error\n"
" rather than the -e maximum, which applies to the text output only.\n");
printf(" -k KEYS List of key ranges to backup.\n"
" If not specified, the entire database will be backed up.\n");
Expand Down Expand Up @@ -4375,10 +4379,12 @@ int main(int argc, char* argv[]) {
// If no tag is specifically provided then print all tag status, don't just use "default"
if (tagProvided)
tag = tagName;
f = stopAfter(map(ba.restoreStatus(db, KeyRef(tag)), [](std::string s) -> Void {
printf("%s\n", s.c_str());
return Void();
}));
f = stopAfter(
map(jsonOutput ? ba.restoreStatusJSON(db, KeyRef(tag)) : ba.restoreStatus(db, KeyRef(tag)),
[](std::string s) -> Void {
printf("%s\n", s.c_str());
return Void();
}));
break;
default:
throw restore_error();
Expand Down
Loading
Loading