From 0ad5af42d0459424590616651cff445522fcde68 Mon Sep 17 00:00:00 2001 From: Andrew Kryczka Date: Thu, 2 Mar 2017 17:17:06 -0800 Subject: [PATCH] Clarify VerifyBackup behavior Summary: It's non-obvious to users that using the same backup engine for creating/verifying provides better results than using separate backup engines, so add a comment in header. Closes https://github.com/facebook/rocksdb/pull/1942 Differential Revision: D4637865 Pulled By: ajkr fbshipit-source-id: e6efe24 --- include/rocksdb/utilities/backupable_db.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/include/rocksdb/utilities/backupable_db.h b/include/rocksdb/utilities/backupable_db.h index 27c1b49ac..69f98591f 100644 --- a/include/rocksdb/utilities/backupable_db.h +++ b/include/rocksdb/utilities/backupable_db.h @@ -227,6 +227,12 @@ class BackupEngineReadOnly { // checks that each file exists and that the size of the file matches our // expectations. it does not check file checksum. + // + // If this BackupEngine created the backup, it compares the files' current + // sizes against the number of bytes written to them during creation. + // Otherwise, it compares the files' current sizes against their sizes when + // the BackupEngine was opened. + // // Returns Status::OK() if all checks are good virtual Status VerifyBackup(BackupID backup_id) = 0; };