2016-02-10 00:12:00 +01:00
|
|
|
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
2017-07-16 01:03:42 +02:00
|
|
|
// This source code is licensed under both the GPLv2 (found in the
|
|
|
|
|
// COPYING file in the root directory) and Apache 2.0 License
|
|
|
|
|
// (found in the LICENSE.Apache file in the root directory).
|
2014-09-17 21:49:13 +02:00
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
2017-02-07 19:35:15 +01:00
|
|
|
#include <map>
|
2014-11-18 22:21:02 +01:00
|
|
|
#include <stdexcept>
|
2016-09-20 22:02:41 +02:00
|
|
|
#include <string>
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
2015-11-12 15:52:43 +01:00
|
|
|
#include <vector>
|
|
|
|
|
|
2017-04-06 04:02:00 +02:00
|
|
|
#include "options/cf_options.h"
|
|
|
|
|
#include "options/db_options.h"
|
2020-04-03 19:48:46 +02:00
|
|
|
#include "options/options_type.h"
|
2015-08-27 01:13:56 +02:00
|
|
|
#include "rocksdb/options.h"
|
2014-11-05 01:23:05 +01:00
|
|
|
#include "rocksdb/status.h"
|
2015-10-11 21:17:42 +02:00
|
|
|
#include "rocksdb/table.h"
|
2017-12-11 22:12:12 +01:00
|
|
|
#include "rocksdb/universal_compaction.h"
|
2014-09-17 21:49:13 +02:00
|
|
|
|
2020-02-20 21:07:53 +01:00
|
|
|
namespace ROCKSDB_NAMESPACE {
|
2020-04-22 02:35:28 +02:00
|
|
|
struct ConfigOptions;
|
2014-09-17 21:49:13 +02:00
|
|
|
|
2020-04-25 00:30:12 +02:00
|
|
|
std::vector<CompressionType> GetSupportedCompressions();
|
|
|
|
|
|
2016-09-24 01:34:04 +02:00
|
|
|
DBOptions BuildDBOptions(const ImmutableDBOptions& immutable_db_options,
|
|
|
|
|
const MutableDBOptions& mutable_db_options);
|
|
|
|
|
|
2016-09-15 07:10:28 +02:00
|
|
|
ColumnFamilyOptions BuildColumnFamilyOptions(
|
|
|
|
|
const ColumnFamilyOptions& ioptions,
|
|
|
|
|
const MutableCFOptions& mutable_cf_options);
|
|
|
|
|
|
|
|
|
|
#ifndef ROCKSDB_LITE
|
2020-04-22 02:35:28 +02:00
|
|
|
Status GetStringFromStruct(
|
|
|
|
|
const ConfigOptions& config_options, const void* const opt_ptr,
|
|
|
|
|
const std::unordered_map<std::string, OptionTypeInfo>& type_info,
|
|
|
|
|
std::string* opt_string);
|
2016-09-15 07:10:28 +02:00
|
|
|
|
2020-04-22 02:35:28 +02:00
|
|
|
Status ParseColumnFamilyOption(const ConfigOptions& config_options,
|
|
|
|
|
const std::string& name,
|
2020-04-03 19:48:46 +02:00
|
|
|
const std::string& org_value,
|
2020-04-22 02:35:28 +02:00
|
|
|
ColumnFamilyOptions* new_options);
|
2020-04-03 19:48:46 +02:00
|
|
|
|
2014-11-05 01:23:05 +01:00
|
|
|
Status GetMutableOptionsFromStrings(
|
2014-09-17 21:49:13 +02:00
|
|
|
const MutableCFOptions& base_options,
|
|
|
|
|
const std::unordered_map<std::string, std::string>& options_map,
|
2018-04-11 03:48:49 +02:00
|
|
|
Logger* info_log, MutableCFOptions* new_options);
|
2014-09-17 21:49:13 +02:00
|
|
|
|
2016-10-14 21:25:39 +02:00
|
|
|
Status GetMutableDBOptionsFromStrings(
|
|
|
|
|
const MutableDBOptions& base_options,
|
|
|
|
|
const std::unordered_map<std::string, std::string>& options_map,
|
|
|
|
|
MutableDBOptions* new_options);
|
|
|
|
|
|
2015-10-11 21:17:42 +02:00
|
|
|
Status GetTableFactoryFromMap(
|
|
|
|
|
const std::string& factory_name,
|
|
|
|
|
const std::unordered_map<std::string, std::string>& opt_map,
|
2017-06-14 01:55:08 +02:00
|
|
|
std::shared_ptr<TableFactory>* table_factory,
|
|
|
|
|
bool ignore_unknown_options = false);
|
2015-10-11 21:17:42 +02:00
|
|
|
|
2020-04-22 02:35:28 +02:00
|
|
|
Status GetTableFactoryFromMap(
|
|
|
|
|
const ConfigOptions& config_options, const std::string& factory_name,
|
|
|
|
|
const std::unordered_map<std::string, std::string>& opt_map,
|
|
|
|
|
std::shared_ptr<TableFactory>* table_factory);
|
|
|
|
|
|
2015-10-03 00:35:32 +02:00
|
|
|
// A helper function that converts "opt_address" to a std::string
|
|
|
|
|
// based on the specified OptionType.
|
|
|
|
|
bool SerializeSingleOptionHelper(const char* opt_address,
|
|
|
|
|
const OptionType opt_type, std::string* value);
|
|
|
|
|
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
2015-11-12 15:52:43 +01:00
|
|
|
// In addition to its public version defined in rocksdb/convenience.h,
|
|
|
|
|
// this further takes an optional output vector "unsupported_options_names",
|
|
|
|
|
// which stores the name of all the unsupported options specified in "opts_map".
|
|
|
|
|
Status GetDBOptionsFromMapInternal(
|
2020-04-22 02:35:28 +02:00
|
|
|
const ConfigOptions& config_options, const DBOptions& base_options,
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
2015-11-12 15:52:43 +01:00
|
|
|
const std::unordered_map<std::string, std::string>& opts_map,
|
2020-04-22 02:35:28 +02:00
|
|
|
DBOptions* new_options,
|
|
|
|
|
std::vector<std::string>* unsupported_options_names = nullptr);
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
2015-11-12 15:52:43 +01:00
|
|
|
|
2018-06-27 00:56:26 +02:00
|
|
|
bool ParseSliceTransform(
|
|
|
|
|
const std::string& value,
|
|
|
|
|
std::shared_ptr<const SliceTransform>* slice_transform);
|
|
|
|
|
|
2017-07-29 01:23:50 +02:00
|
|
|
extern Status StringToMap(
|
|
|
|
|
const std::string& opts_str,
|
|
|
|
|
std::unordered_map<std::string, std::string>* opts_map);
|
|
|
|
|
|
|
|
|
|
extern bool ParseOptionHelper(char* opt_address, const OptionType& opt_type,
|
|
|
|
|
const std::string& value);
|
2016-09-15 07:10:28 +02:00
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
|
2017-11-18 02:02:13 +01:00
|
|
|
struct OptionsHelper {
|
|
|
|
|
static std::map<CompactionStyle, std::string> compaction_style_to_string;
|
|
|
|
|
static std::map<CompactionPri, std::string> compaction_pri_to_string;
|
|
|
|
|
static std::map<CompactionStopStyle, std::string>
|
|
|
|
|
compaction_stop_style_to_string;
|
|
|
|
|
static std::unordered_map<std::string, ChecksumType> checksum_type_string_map;
|
2018-01-23 23:36:54 +01:00
|
|
|
static std::unordered_map<std::string, CompressionType>
|
|
|
|
|
compression_type_string_map;
|
2017-11-18 02:02:13 +01:00
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
|
static std::unordered_map<std::string, OptionTypeInfo> cf_options_type_info;
|
|
|
|
|
static std::unordered_map<std::string, OptionTypeInfo>
|
|
|
|
|
fifo_compaction_options_type_info;
|
2017-12-11 22:12:12 +01:00
|
|
|
static std::unordered_map<std::string, OptionTypeInfo>
|
|
|
|
|
universal_compaction_options_type_info;
|
|
|
|
|
static std::unordered_map<std::string, CompactionStopStyle>
|
|
|
|
|
compaction_stop_style_string_map;
|
2017-11-18 02:02:13 +01:00
|
|
|
static std::unordered_map<std::string, OptionTypeInfo> db_options_type_info;
|
2017-11-28 19:35:17 +01:00
|
|
|
static std::unordered_map<std::string, OptionTypeInfo>
|
|
|
|
|
lru_cache_options_type_info;
|
2017-11-18 02:02:13 +01:00
|
|
|
static std::unordered_map<std::string, BlockBasedTableOptions::IndexType>
|
|
|
|
|
block_base_table_index_type_string_map;
|
2018-07-28 00:35:41 +02:00
|
|
|
static std::unordered_map<std::string,
|
|
|
|
|
BlockBasedTableOptions::DataBlockIndexType>
|
|
|
|
|
block_base_table_data_block_index_type_string_map;
|
2019-04-22 17:17:45 +02:00
|
|
|
static std::unordered_map<std::string,
|
|
|
|
|
BlockBasedTableOptions::IndexShorteningMode>
|
|
|
|
|
block_base_table_index_shortening_mode_string_map;
|
2017-11-18 02:02:13 +01:00
|
|
|
static std::unordered_map<std::string, EncodingType> encoding_type_string_map;
|
|
|
|
|
static std::unordered_map<std::string, CompactionStyle>
|
|
|
|
|
compaction_style_string_map;
|
|
|
|
|
static std::unordered_map<std::string, CompactionPri>
|
|
|
|
|
compaction_pri_string_map;
|
|
|
|
|
static std::unordered_map<std::string, WALRecoveryMode>
|
|
|
|
|
wal_recovery_mode_string_map;
|
|
|
|
|
static std::unordered_map<std::string, DBOptions::AccessHint>
|
|
|
|
|
access_hint_string_map;
|
|
|
|
|
static std::unordered_map<std::string, InfoLogLevel>
|
|
|
|
|
info_log_level_string_map;
|
|
|
|
|
static ColumnFamilyOptions dummy_cf_options;
|
|
|
|
|
static CompactionOptionsFIFO dummy_comp_options;
|
2017-11-28 19:35:17 +01:00
|
|
|
static LRUCacheOptions dummy_lru_cache_options;
|
2017-12-11 22:12:12 +01:00
|
|
|
static CompactionOptionsUniversal dummy_comp_options_universal;
|
2017-11-18 02:02:13 +01:00
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
// Some aliasing
|
|
|
|
|
static auto& compaction_style_to_string =
|
|
|
|
|
OptionsHelper::compaction_style_to_string;
|
|
|
|
|
static auto& compaction_pri_to_string = OptionsHelper::compaction_pri_to_string;
|
|
|
|
|
static auto& compaction_stop_style_to_string =
|
|
|
|
|
OptionsHelper::compaction_stop_style_to_string;
|
|
|
|
|
static auto& checksum_type_string_map = OptionsHelper::checksum_type_string_map;
|
|
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
|
static auto& cf_options_type_info = OptionsHelper::cf_options_type_info;
|
|
|
|
|
static auto& fifo_compaction_options_type_info =
|
|
|
|
|
OptionsHelper::fifo_compaction_options_type_info;
|
2017-12-11 22:12:12 +01:00
|
|
|
static auto& universal_compaction_options_type_info =
|
|
|
|
|
OptionsHelper::universal_compaction_options_type_info;
|
|
|
|
|
static auto& compaction_stop_style_string_map =
|
|
|
|
|
OptionsHelper::compaction_stop_style_string_map;
|
2017-11-18 02:02:13 +01:00
|
|
|
static auto& db_options_type_info = OptionsHelper::db_options_type_info;
|
2017-11-28 19:35:17 +01:00
|
|
|
static auto& lru_cache_options_type_info =
|
|
|
|
|
OptionsHelper::lru_cache_options_type_info;
|
2017-11-18 02:02:13 +01:00
|
|
|
static auto& compression_type_string_map =
|
|
|
|
|
OptionsHelper::compression_type_string_map;
|
|
|
|
|
static auto& block_base_table_index_type_string_map =
|
|
|
|
|
OptionsHelper::block_base_table_index_type_string_map;
|
2018-07-28 00:35:41 +02:00
|
|
|
static auto& block_base_table_data_block_index_type_string_map =
|
|
|
|
|
OptionsHelper::block_base_table_data_block_index_type_string_map;
|
2019-04-22 17:17:45 +02:00
|
|
|
static auto& block_base_table_index_shortening_mode_string_map =
|
|
|
|
|
OptionsHelper::block_base_table_index_shortening_mode_string_map;
|
2017-11-18 02:02:13 +01:00
|
|
|
static auto& encoding_type_string_map = OptionsHelper::encoding_type_string_map;
|
|
|
|
|
static auto& compaction_style_string_map =
|
|
|
|
|
OptionsHelper::compaction_style_string_map;
|
|
|
|
|
static auto& compaction_pri_string_map =
|
|
|
|
|
OptionsHelper::compaction_pri_string_map;
|
|
|
|
|
static auto& wal_recovery_mode_string_map =
|
|
|
|
|
OptionsHelper::wal_recovery_mode_string_map;
|
|
|
|
|
static auto& access_hint_string_map = OptionsHelper::access_hint_string_map;
|
|
|
|
|
static auto& info_log_level_string_map =
|
|
|
|
|
OptionsHelper::info_log_level_string_map;
|
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
|
2020-02-20 21:07:53 +01:00
|
|
|
} // namespace ROCKSDB_NAMESPACE
|
