89ad9f3adb
Summary:
Added a flag, `ignore_unknown_options`, to skip unknown options when loading an options file (using `LoadLatestOptions`/`LoadOptionsFromFile`) or while verifying options (using `CheckOptionsCompatibility`). This will help in downgrading the db to an older version.
Also added `--ignore_unknown_options` flag to ldb
**Example Use case:**
In MyRocks, if copying from newer version to older version, it is often impossible to start because of new RocksDB options that don't exist in older version, even though data format is compatible.
MyRocks uses these load and verify functions in [ha_rocksdb.cc::check_rocksdb_options_compatibility](e004fd9f41/storage/rocksdb/ha_rocksdb.cc (L3348-L3401)).
**Test Plan:**
Updated the unit tests.
`make check`
ldb:
$ ./ldb --db=/tmp/test_db --create_if_missing put a1 b1
OK
Now edit /tmp/test_db/<OPTIONS-file> and add an unknown option.
Try loading the options now, and it fails:
$ ./ldb --db=/tmp/test_db --try_load_options get a1
Failed: Invalid argument: Unrecognized option DBOptions:: abcd
Passes with the new --ignore_unknown_options flag
$ ./ldb --db=/tmp/test_db --try_load_options --ignore_unknown_options get a1
b1
Closes https://github.com/facebook/rocksdb/pull/2423
Differential Revision: D5212091
Pulled By: sagar0
fbshipit-source-id: 2ec17636feb47dc0351b53a77e5f15ef7cbf2ca7
103 lines
3.3 KiB
C++
103 lines
3.3 KiB
C++
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
|
// This source code is licensed under the BSD-style license found in the
|
|
// LICENSE file in the root directory of this source tree. An additional grant
|
|
// of patent rights can be found in the PATENTS file in the same directory.
|
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
#include "rocksdb/utilities/options_util.h"
|
|
|
|
#include "options/options_parser.h"
|
|
#include "rocksdb/options.h"
|
|
#include "util/filename.h"
|
|
|
|
namespace rocksdb {
|
|
Status LoadOptionsFromFile(const std::string& file_name, Env* env,
|
|
DBOptions* db_options,
|
|
std::vector<ColumnFamilyDescriptor>* cf_descs,
|
|
bool ignore_unknown_options) {
|
|
RocksDBOptionsParser parser;
|
|
Status s = parser.Parse(file_name, env, ignore_unknown_options);
|
|
if (!s.ok()) {
|
|
return s;
|
|
}
|
|
|
|
*db_options = *parser.db_opt();
|
|
|
|
const std::vector<std::string>& cf_names = *parser.cf_names();
|
|
const std::vector<ColumnFamilyOptions>& cf_opts = *parser.cf_opts();
|
|
cf_descs->clear();
|
|
for (size_t i = 0; i < cf_opts.size(); ++i) {
|
|
cf_descs->push_back({cf_names[i], cf_opts[i]});
|
|
}
|
|
return Status::OK();
|
|
}
|
|
|
|
Status GetLatestOptionsFileName(const std::string& dbpath,
|
|
Env* env, std::string* options_file_name) {
|
|
Status s;
|
|
std::string latest_file_name;
|
|
uint64_t latest_time_stamp = 0;
|
|
std::vector<std::string> file_names;
|
|
s = env->GetChildren(dbpath, &file_names);
|
|
if (!s.ok()) {
|
|
return s;
|
|
}
|
|
for (auto& file_name : file_names) {
|
|
uint64_t time_stamp;
|
|
FileType type;
|
|
if (ParseFileName(file_name, &time_stamp, &type) && type == kOptionsFile) {
|
|
if (time_stamp > latest_time_stamp) {
|
|
latest_time_stamp = time_stamp;
|
|
latest_file_name = file_name;
|
|
}
|
|
}
|
|
}
|
|
if (latest_file_name.size() == 0) {
|
|
return Status::NotFound("No options files found in the DB directory.");
|
|
}
|
|
*options_file_name = latest_file_name;
|
|
return Status::OK();
|
|
}
|
|
|
|
Status LoadLatestOptions(const std::string& dbpath, Env* env,
|
|
DBOptions* db_options,
|
|
std::vector<ColumnFamilyDescriptor>* cf_descs,
|
|
bool ignore_unknown_options) {
|
|
std::string options_file_name;
|
|
Status s = GetLatestOptionsFileName(dbpath, env, &options_file_name);
|
|
if (!s.ok()) {
|
|
return s;
|
|
}
|
|
|
|
return LoadOptionsFromFile(dbpath + "/" + options_file_name, env, db_options,
|
|
cf_descs, ignore_unknown_options);
|
|
}
|
|
|
|
Status CheckOptionsCompatibility(
|
|
const std::string& dbpath, Env* env, const DBOptions& db_options,
|
|
const std::vector<ColumnFamilyDescriptor>& cf_descs,
|
|
bool ignore_unknown_options) {
|
|
std::string options_file_name;
|
|
Status s = GetLatestOptionsFileName(dbpath, env, &options_file_name);
|
|
if (!s.ok()) {
|
|
return s;
|
|
}
|
|
|
|
std::vector<std::string> cf_names;
|
|
std::vector<ColumnFamilyOptions> cf_opts;
|
|
for (const auto& cf_desc : cf_descs) {
|
|
cf_names.push_back(cf_desc.name);
|
|
cf_opts.push_back(cf_desc.options);
|
|
}
|
|
|
|
const OptionsSanityCheckLevel kDefaultLevel = kSanityLevelLooselyCompatible;
|
|
|
|
return RocksDBOptionsParser::VerifyRocksDBOptionsFromFile(
|
|
db_options, cf_names, cf_opts, dbpath + "/" + options_file_name, env,
|
|
kDefaultLevel, ignore_unknown_options);
|
|
}
|
|
|
|
} // namespace rocksdb
|
|
#endif // !ROCKSDB_LITE
|