2016-02-10 00:12:00 +01:00
|
|
|
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
2014-09-17 21:46:32 +02:00
|
|
|
// 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.
|
Add options.compaction_measure_io_stats to print write I/O stats in compactions
Summary:
Add options.compaction_measure_io_stats to print out / pass to listener accumulated time spent on write calls. Example outputs in info logs:
2015/08/12-16:27:59.463944 7fd428bff700 (Original Log Time 2015/08/12-16:27:59.463922) EVENT_LOG_v1 {"time_micros": 1439422079463897, "job": 6, "event": "compaction_finished", "output_level": 1, "num_output_files": 4, "total_output_size": 6900525, "num_input_records": 111483, "num_output_records": 106877, "file_write_nanos": 15663206, "file_range_sync_nanos": 649588, "file_fsync_nanos": 349614797, "file_prepare_write_nanos": 1505812, "lsm_state": [2, 4, 0, 0, 0, 0, 0]}
Add two more counters in iostats_context.
Also add a parameter of db_bench.
Test Plan: Add a unit test. Also manually verify LOG outputs in db_bench
Subscribers: leveldb, dhruba
Differential Revision: https://reviews.facebook.net/D44115
2015-08-13 02:24:45 +02:00
|
|
|
#include "util/options_helper.h"
|
2014-09-17 21:46:32 +02:00
|
|
|
|
|
|
|
#include <cassert>
|
2014-10-10 19:00:12 +02:00
|
|
|
#include <cctype>
|
2015-04-24 04:17:57 +02:00
|
|
|
#include <cstdlib>
|
2014-10-02 01:19:16 +02:00
|
|
|
#include <unordered_set>
|
2015-10-03 00:35:32 +02:00
|
|
|
#include <vector>
|
2014-12-22 22:18:57 +01:00
|
|
|
#include "rocksdb/cache.h"
|
2015-10-03 00:35:32 +02:00
|
|
|
#include "rocksdb/compaction_filter.h"
|
2015-07-15 23:51:51 +02:00
|
|
|
#include "rocksdb/convenience.h"
|
2014-12-22 22:18:57 +01:00
|
|
|
#include "rocksdb/filter_policy.h"
|
2015-10-03 00:35:32 +02:00
|
|
|
#include "rocksdb/memtablerep.h"
|
|
|
|
#include "rocksdb/merge_operator.h"
|
2014-09-17 21:46:32 +02:00
|
|
|
#include "rocksdb/options.h"
|
2015-03-06 23:21:15 +01:00
|
|
|
#include "rocksdb/rate_limiter.h"
|
2015-01-16 00:33:12 +01:00
|
|
|
#include "rocksdb/slice_transform.h"
|
2014-12-22 22:18:57 +01:00
|
|
|
#include "rocksdb/table.h"
|
2015-02-20 04:11:14 +01:00
|
|
|
#include "table/block_based_table_factory.h"
|
2015-10-28 18:46:01 +01:00
|
|
|
#include "table/plain_table_factory.h"
|
2015-04-24 04:17:57 +02:00
|
|
|
#include "util/logging.h"
|
2015-08-18 22:30:18 +02:00
|
|
|
#include "util/string_util.h"
|
2014-09-17 21:46:32 +02:00
|
|
|
|
|
|
|
namespace rocksdb {
|
|
|
|
|
2016-09-24 01:34:04 +02:00
|
|
|
DBOptions BuildDBOptions(const ImmutableDBOptions& immutable_db_options,
|
|
|
|
const MutableDBOptions& mutable_db_options) {
|
|
|
|
DBOptions options;
|
|
|
|
|
|
|
|
options.create_if_missing = immutable_db_options.create_if_missing;
|
|
|
|
options.create_missing_column_families =
|
|
|
|
immutable_db_options.create_missing_column_families;
|
|
|
|
options.error_if_exists = immutable_db_options.error_if_exists;
|
|
|
|
options.paranoid_checks = immutable_db_options.paranoid_checks;
|
|
|
|
options.env = immutable_db_options.env;
|
|
|
|
options.rate_limiter = immutable_db_options.rate_limiter;
|
|
|
|
options.sst_file_manager = immutable_db_options.sst_file_manager;
|
|
|
|
options.info_log = immutable_db_options.info_log;
|
|
|
|
options.info_log_level = immutable_db_options.info_log_level;
|
|
|
|
options.max_open_files = immutable_db_options.max_open_files;
|
|
|
|
options.max_file_opening_threads =
|
|
|
|
immutable_db_options.max_file_opening_threads;
|
|
|
|
options.max_total_wal_size = immutable_db_options.max_total_wal_size;
|
|
|
|
options.statistics = immutable_db_options.statistics;
|
|
|
|
options.disableDataSync = immutable_db_options.disable_data_sync;
|
|
|
|
options.use_fsync = immutable_db_options.use_fsync;
|
|
|
|
options.db_paths = immutable_db_options.db_paths;
|
|
|
|
options.db_log_dir = immutable_db_options.db_log_dir;
|
|
|
|
options.wal_dir = immutable_db_options.wal_dir;
|
|
|
|
options.delete_obsolete_files_period_micros =
|
|
|
|
immutable_db_options.delete_obsolete_files_period_micros;
|
|
|
|
options.base_background_compactions =
|
|
|
|
immutable_db_options.base_background_compactions;
|
|
|
|
options.max_background_compactions =
|
|
|
|
immutable_db_options.max_background_compactions;
|
|
|
|
options.max_subcompactions = immutable_db_options.max_subcompactions;
|
|
|
|
options.max_background_flushes = immutable_db_options.max_background_flushes;
|
|
|
|
options.max_log_file_size = immutable_db_options.max_log_file_size;
|
|
|
|
options.log_file_time_to_roll = immutable_db_options.log_file_time_to_roll;
|
|
|
|
options.keep_log_file_num = immutable_db_options.keep_log_file_num;
|
|
|
|
options.recycle_log_file_num = immutable_db_options.recycle_log_file_num;
|
|
|
|
options.max_manifest_file_size = immutable_db_options.max_manifest_file_size;
|
|
|
|
options.table_cache_numshardbits =
|
|
|
|
immutable_db_options.table_cache_numshardbits;
|
|
|
|
options.WAL_ttl_seconds = immutable_db_options.wal_ttl_seconds;
|
|
|
|
options.WAL_size_limit_MB = immutable_db_options.wal_size_limit_mb;
|
|
|
|
options.manifest_preallocation_size =
|
|
|
|
immutable_db_options.manifest_preallocation_size;
|
|
|
|
options.allow_os_buffer = immutable_db_options.allow_os_buffer;
|
|
|
|
options.allow_mmap_reads = immutable_db_options.allow_mmap_reads;
|
|
|
|
options.allow_mmap_writes = immutable_db_options.allow_mmap_writes;
|
|
|
|
options.allow_fallocate = immutable_db_options.allow_fallocate;
|
|
|
|
options.is_fd_close_on_exec = immutable_db_options.is_fd_close_on_exec;
|
|
|
|
options.stats_dump_period_sec = immutable_db_options.stats_dump_period_sec;
|
|
|
|
options.advise_random_on_open = immutable_db_options.advise_random_on_open;
|
|
|
|
options.db_write_buffer_size = immutable_db_options.db_write_buffer_size;
|
|
|
|
options.write_buffer_manager = immutable_db_options.write_buffer_manager;
|
|
|
|
options.access_hint_on_compaction_start =
|
|
|
|
immutable_db_options.access_hint_on_compaction_start;
|
|
|
|
options.new_table_reader_for_compaction_inputs =
|
|
|
|
immutable_db_options.new_table_reader_for_compaction_inputs;
|
|
|
|
options.compaction_readahead_size =
|
|
|
|
immutable_db_options.compaction_readahead_size;
|
|
|
|
options.random_access_max_buffer_size =
|
|
|
|
immutable_db_options.random_access_max_buffer_size;
|
|
|
|
options.writable_file_max_buffer_size =
|
|
|
|
immutable_db_options.writable_file_max_buffer_size;
|
|
|
|
options.use_adaptive_mutex = immutable_db_options.use_adaptive_mutex;
|
|
|
|
options.bytes_per_sync = immutable_db_options.bytes_per_sync;
|
|
|
|
options.wal_bytes_per_sync = immutable_db_options.wal_bytes_per_sync;
|
|
|
|
options.listeners = immutable_db_options.listeners;
|
|
|
|
options.enable_thread_tracking = immutable_db_options.enable_thread_tracking;
|
|
|
|
options.delayed_write_rate = immutable_db_options.delayed_write_rate;
|
|
|
|
options.allow_concurrent_memtable_write =
|
|
|
|
immutable_db_options.allow_concurrent_memtable_write;
|
|
|
|
options.enable_write_thread_adaptive_yield =
|
|
|
|
immutable_db_options.enable_write_thread_adaptive_yield;
|
|
|
|
options.write_thread_max_yield_usec =
|
|
|
|
immutable_db_options.write_thread_max_yield_usec;
|
|
|
|
options.write_thread_slow_yield_usec =
|
|
|
|
immutable_db_options.write_thread_slow_yield_usec;
|
|
|
|
options.skip_stats_update_on_db_open =
|
|
|
|
immutable_db_options.skip_stats_update_on_db_open;
|
|
|
|
options.wal_recovery_mode = immutable_db_options.wal_recovery_mode;
|
|
|
|
options.allow_2pc = immutable_db_options.allow_2pc;
|
|
|
|
options.row_cache = immutable_db_options.row_cache;
|
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
options.wal_filter = immutable_db_options.wal_filter;
|
|
|
|
#endif // ROCKSDB_LITE
|
|
|
|
options.fail_if_options_file_error =
|
|
|
|
immutable_db_options.fail_if_options_file_error;
|
|
|
|
options.dump_malloc_stats = immutable_db_options.dump_malloc_stats;
|
|
|
|
options.avoid_flush_during_recovery =
|
|
|
|
immutable_db_options.avoid_flush_during_recovery;
|
|
|
|
|
|
|
|
return options;
|
|
|
|
}
|
|
|
|
|
2016-09-15 07:10:28 +02:00
|
|
|
ColumnFamilyOptions BuildColumnFamilyOptions(
|
|
|
|
const ColumnFamilyOptions& options,
|
|
|
|
const MutableCFOptions& mutable_cf_options) {
|
|
|
|
ColumnFamilyOptions cf_opts(options);
|
|
|
|
|
|
|
|
// Memtable related options
|
|
|
|
cf_opts.write_buffer_size = mutable_cf_options.write_buffer_size;
|
|
|
|
cf_opts.max_write_buffer_number = mutable_cf_options.max_write_buffer_number;
|
|
|
|
cf_opts.arena_block_size = mutable_cf_options.arena_block_size;
|
|
|
|
cf_opts.memtable_prefix_bloom_size_ratio =
|
|
|
|
mutable_cf_options.memtable_prefix_bloom_size_ratio;
|
|
|
|
cf_opts.memtable_huge_page_size = mutable_cf_options.memtable_huge_page_size;
|
|
|
|
cf_opts.max_successive_merges = mutable_cf_options.max_successive_merges;
|
|
|
|
cf_opts.inplace_update_num_locks =
|
|
|
|
mutable_cf_options.inplace_update_num_locks;
|
|
|
|
|
|
|
|
// Compaction related options
|
|
|
|
cf_opts.disable_auto_compactions =
|
|
|
|
mutable_cf_options.disable_auto_compactions;
|
|
|
|
cf_opts.level0_file_num_compaction_trigger =
|
|
|
|
mutable_cf_options.level0_file_num_compaction_trigger;
|
|
|
|
cf_opts.level0_slowdown_writes_trigger =
|
|
|
|
mutable_cf_options.level0_slowdown_writes_trigger;
|
|
|
|
cf_opts.level0_stop_writes_trigger =
|
|
|
|
mutable_cf_options.level0_stop_writes_trigger;
|
|
|
|
cf_opts.max_compaction_bytes = mutable_cf_options.max_compaction_bytes;
|
|
|
|
cf_opts.target_file_size_base = mutable_cf_options.target_file_size_base;
|
|
|
|
cf_opts.target_file_size_multiplier =
|
|
|
|
mutable_cf_options.target_file_size_multiplier;
|
|
|
|
cf_opts.max_bytes_for_level_base =
|
|
|
|
mutable_cf_options.max_bytes_for_level_base;
|
|
|
|
cf_opts.max_bytes_for_level_multiplier =
|
|
|
|
mutable_cf_options.max_bytes_for_level_multiplier;
|
|
|
|
|
|
|
|
cf_opts.max_bytes_for_level_multiplier_additional.clear();
|
|
|
|
for (auto value :
|
|
|
|
mutable_cf_options.max_bytes_for_level_multiplier_additional) {
|
|
|
|
cf_opts.max_bytes_for_level_multiplier_additional.emplace_back(value);
|
|
|
|
}
|
|
|
|
|
|
|
|
cf_opts.verify_checksums_in_compaction =
|
|
|
|
mutable_cf_options.verify_checksums_in_compaction;
|
|
|
|
|
|
|
|
// Misc options
|
|
|
|
cf_opts.max_sequential_skip_in_iterations =
|
|
|
|
mutable_cf_options.max_sequential_skip_in_iterations;
|
|
|
|
cf_opts.paranoid_file_checks = mutable_cf_options.paranoid_file_checks;
|
|
|
|
cf_opts.report_bg_io_stats = mutable_cf_options.report_bg_io_stats;
|
|
|
|
cf_opts.compression = mutable_cf_options.compression;
|
|
|
|
cf_opts.min_partial_merge_operands =
|
|
|
|
mutable_cf_options.min_partial_merge_operands;
|
|
|
|
|
|
|
|
cf_opts.table_factory = options.table_factory;
|
|
|
|
// TODO(yhchiang): find some way to handle the following derived options
|
|
|
|
// * max_file_size
|
|
|
|
|
|
|
|
return cf_opts;
|
|
|
|
}
|
|
|
|
|
2014-11-13 20:39:30 +01:00
|
|
|
#ifndef ROCKSDB_LITE
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
bool isSpecialChar(const char c) {
|
|
|
|
if (c == '\\' || c == '#' || c == ':' || c == '\r' || c == '\n') {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2016-08-17 09:42:35 +02:00
|
|
|
namespace {
|
|
|
|
using
|
|
|
|
CharMap = std::pair<char, char>;
|
|
|
|
}
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
char UnescapeChar(const char c) {
|
2016-08-17 09:42:35 +02:00
|
|
|
static const CharMap convert_map[] = {{'r', '\r'},
|
|
|
|
{'n', '\n'}};
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
|
2016-08-17 09:42:35 +02:00
|
|
|
auto iter = std::find_if(std::begin(convert_map),
|
|
|
|
std::end(convert_map),
|
|
|
|
[c](const CharMap& p) { return p.first == c; });
|
|
|
|
|
|
|
|
if (iter == std::end(convert_map)) {
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
return c;
|
|
|
|
}
|
|
|
|
return iter->second;
|
|
|
|
}
|
|
|
|
|
|
|
|
char EscapeChar(const char c) {
|
2016-08-17 09:42:35 +02:00
|
|
|
static const CharMap convert_map[] = {{'\n', 'n'},
|
|
|
|
{'\r', 'r'}};
|
|
|
|
|
|
|
|
auto iter = std::find_if(std::begin(convert_map),
|
|
|
|
std::end(convert_map),
|
|
|
|
[c](const CharMap& p) { return p.first == c; });
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
|
2016-08-17 09:42:35 +02:00
|
|
|
if (iter == std::end(convert_map)) {
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
return c;
|
|
|
|
}
|
|
|
|
return iter->second;
|
|
|
|
}
|
|
|
|
|
|
|
|
std::string EscapeOptionString(const std::string& raw_string) {
|
|
|
|
std::string output;
|
|
|
|
for (auto c : raw_string) {
|
|
|
|
if (isSpecialChar(c)) {
|
|
|
|
output += '\\';
|
|
|
|
output += EscapeChar(c);
|
|
|
|
} else {
|
|
|
|
output += c;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return output;
|
|
|
|
}
|
|
|
|
|
|
|
|
std::string UnescapeOptionString(const std::string& escaped_string) {
|
|
|
|
bool escaped = false;
|
|
|
|
std::string output;
|
|
|
|
|
|
|
|
for (auto c : escaped_string) {
|
|
|
|
if (escaped) {
|
|
|
|
output += UnescapeChar(c);
|
|
|
|
escaped = false;
|
|
|
|
} else {
|
|
|
|
if (c == '\\') {
|
|
|
|
escaped = true;
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
output += c;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return output;
|
|
|
|
}
|
2014-11-13 20:39:30 +01:00
|
|
|
|
2016-08-06 00:56:22 +02:00
|
|
|
uint64_t ParseUint64(const std::string& value) {
|
|
|
|
size_t endchar;
|
|
|
|
#ifndef CYGWIN
|
|
|
|
uint64_t num = std::stoull(value.c_str(), &endchar);
|
|
|
|
#else
|
|
|
|
char* endptr;
|
|
|
|
uint64_t num = std::strtoul(value.c_str(), &endptr, 0);
|
|
|
|
endchar = endptr - value.c_str();
|
|
|
|
#endif
|
|
|
|
|
|
|
|
if (endchar < value.length()) {
|
|
|
|
char c = value[endchar];
|
|
|
|
if (c == 'k' || c == 'K')
|
|
|
|
num <<= 10LL;
|
|
|
|
else if (c == 'm' || c == 'M')
|
|
|
|
num <<= 20LL;
|
|
|
|
else if (c == 'g' || c == 'G')
|
|
|
|
num <<= 30LL;
|
|
|
|
else if (c == 't' || c == 'T')
|
|
|
|
num <<= 40LL;
|
|
|
|
}
|
|
|
|
|
|
|
|
return num;
|
|
|
|
}
|
|
|
|
|
2014-09-17 21:46:32 +02:00
|
|
|
namespace {
|
2015-10-03 00:35:32 +02:00
|
|
|
std::string trim(const std::string& str) {
|
|
|
|
if (str.empty()) return std::string();
|
|
|
|
size_t start = 0;
|
|
|
|
size_t end = str.size() - 1;
|
|
|
|
while (isspace(str[start]) != 0 && start <= end) {
|
|
|
|
++start;
|
|
|
|
}
|
|
|
|
while (isspace(str[end]) != 0 && start <= end) {
|
|
|
|
--end;
|
|
|
|
}
|
|
|
|
if (start <= end) {
|
|
|
|
return str.substr(start, end - start + 1);
|
|
|
|
}
|
|
|
|
return std::string();
|
|
|
|
}
|
|
|
|
|
2016-09-14 06:12:43 +02:00
|
|
|
bool SerializeIntVector(const std::vector<int>& vec, std::string* value) {
|
|
|
|
*value = "";
|
|
|
|
for (size_t i = 0; i < vec.size(); ++i) {
|
|
|
|
if (i > 0) {
|
|
|
|
*value += ":";
|
|
|
|
}
|
|
|
|
*value += ToString(vec[i]);
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2015-11-18 01:41:54 +01:00
|
|
|
template <typename T>
|
|
|
|
bool ParseEnum(const std::unordered_map<std::string, T>& type_map,
|
2015-10-30 23:58:46 +01:00
|
|
|
const std::string& type, T* value) {
|
|
|
|
auto iter = type_map.find(type);
|
|
|
|
if (iter != type_map.end()) {
|
|
|
|
*value = iter->second;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2015-11-18 01:41:54 +01:00
|
|
|
template <typename T>
|
|
|
|
bool SerializeEnum(const std::unordered_map<std::string, T>& type_map,
|
2015-10-30 23:58:46 +01:00
|
|
|
const T& type, std::string* value) {
|
|
|
|
for (const auto& pair : type_map) {
|
|
|
|
if (pair.second == type) {
|
|
|
|
*value = pair.first;
|
2015-10-03 00:35:32 +02:00
|
|
|
return true;
|
2015-10-30 23:58:46 +01:00
|
|
|
}
|
2015-10-03 00:35:32 +02:00
|
|
|
}
|
2015-10-30 23:58:46 +01:00
|
|
|
return false;
|
2015-10-03 00:35:32 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
bool SerializeVectorCompressionType(const std::vector<CompressionType>& types,
|
|
|
|
std::string* value) {
|
|
|
|
std::stringstream ss;
|
|
|
|
bool result;
|
|
|
|
for (size_t i = 0; i < types.size(); ++i) {
|
|
|
|
if (i > 0) {
|
|
|
|
ss << ':';
|
|
|
|
}
|
|
|
|
std::string string_type;
|
2015-10-30 23:58:46 +01:00
|
|
|
result = SerializeEnum<CompressionType>(compression_type_string_map,
|
2015-11-18 01:41:54 +01:00
|
|
|
types[i], &string_type);
|
2015-10-03 00:35:32 +02:00
|
|
|
if (result == false) {
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
ss << string_type;
|
|
|
|
}
|
|
|
|
*value = ss.str();
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2014-09-17 21:46:32 +02:00
|
|
|
bool ParseBoolean(const std::string& type, const std::string& value) {
|
|
|
|
if (value == "true" || value == "1") {
|
|
|
|
return true;
|
|
|
|
} else if (value == "false" || value == "0") {
|
|
|
|
return false;
|
|
|
|
}
|
2014-12-22 22:18:57 +01:00
|
|
|
throw std::invalid_argument(type);
|
2014-09-17 21:46:32 +02:00
|
|
|
}
|
|
|
|
|
2014-11-13 20:39:30 +01:00
|
|
|
size_t ParseSizeT(const std::string& value) {
|
|
|
|
return static_cast<size_t>(ParseUint64(value));
|
2014-09-17 21:46:32 +02:00
|
|
|
}
|
|
|
|
|
2014-11-17 22:47:51 +01:00
|
|
|
uint32_t ParseUint32(const std::string& value) {
|
|
|
|
uint64_t num = ParseUint64(value);
|
|
|
|
if ((num >> 32LL) == 0) {
|
|
|
|
return static_cast<uint32_t>(num);
|
|
|
|
} else {
|
|
|
|
throw std::out_of_range(value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
int ParseInt(const std::string& value) {
|
|
|
|
size_t endchar;
|
2015-04-24 04:17:57 +02:00
|
|
|
#ifndef CYGWIN
|
2014-11-17 22:47:51 +01:00
|
|
|
int num = std::stoi(value.c_str(), &endchar);
|
2015-04-24 04:17:57 +02:00
|
|
|
#else
|
|
|
|
char* endptr;
|
|
|
|
int num = std::strtoul(value.c_str(), &endptr, 0);
|
|
|
|
endchar = endptr - value.c_str();
|
|
|
|
#endif
|
2014-11-17 22:47:51 +01:00
|
|
|
|
|
|
|
if (endchar < value.length()) {
|
|
|
|
char c = value[endchar];
|
|
|
|
if (c == 'k' || c == 'K')
|
|
|
|
num <<= 10;
|
|
|
|
else if (c == 'm' || c == 'M')
|
|
|
|
num <<= 20;
|
|
|
|
else if (c == 'g' || c == 'G')
|
|
|
|
num <<= 30;
|
|
|
|
}
|
|
|
|
|
|
|
|
return num;
|
|
|
|
}
|
|
|
|
|
2016-09-14 06:12:43 +02:00
|
|
|
std::vector<int> ParseVectorInt(const std::string& value) {
|
|
|
|
std::vector<int> result;
|
|
|
|
size_t start = 0;
|
|
|
|
while (start < value.size()) {
|
|
|
|
size_t end = value.find(':', start);
|
|
|
|
if (end == std::string::npos) {
|
|
|
|
result.push_back(ParseInt(value.substr(start)));
|
|
|
|
break;
|
|
|
|
} else {
|
|
|
|
result.push_back(ParseInt(value.substr(start, end - start)));
|
|
|
|
start = end + 1;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
2014-09-17 21:46:32 +02:00
|
|
|
double ParseDouble(const std::string& value) {
|
2015-04-24 04:17:57 +02:00
|
|
|
#ifndef CYGWIN
|
2014-09-17 21:46:32 +02:00
|
|
|
return std::stod(value);
|
2015-04-24 04:17:57 +02:00
|
|
|
#else
|
|
|
|
return std::strtod(value.c_str(), 0);
|
|
|
|
#endif
|
2014-09-17 21:46:32 +02:00
|
|
|
}
|
2015-08-27 01:13:56 +02:00
|
|
|
|
2015-10-03 00:35:32 +02:00
|
|
|
bool ParseVectorCompressionType(
|
|
|
|
const std::string& value,
|
|
|
|
std::vector<CompressionType>* compression_per_level) {
|
|
|
|
compression_per_level->clear();
|
|
|
|
size_t start = 0;
|
|
|
|
while (start < value.size()) {
|
|
|
|
size_t end = value.find(':', start);
|
|
|
|
bool is_ok;
|
|
|
|
CompressionType type;
|
|
|
|
if (end == std::string::npos) {
|
2015-11-18 01:41:54 +01:00
|
|
|
is_ok = ParseEnum<CompressionType>(compression_type_string_map,
|
|
|
|
value.substr(start), &type);
|
2015-10-03 00:35:32 +02:00
|
|
|
if (!is_ok) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
compression_per_level->emplace_back(type);
|
|
|
|
break;
|
|
|
|
} else {
|
2015-11-18 01:41:54 +01:00
|
|
|
is_ok = ParseEnum<CompressionType>(
|
|
|
|
compression_type_string_map, value.substr(start, end - start), &type);
|
2015-10-03 00:35:32 +02:00
|
|
|
if (!is_ok) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
compression_per_level->emplace_back(type);
|
|
|
|
start = end + 1;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool ParseSliceTransformHelper(
|
|
|
|
const std::string& kFixedPrefixName, const std::string& kCappedPrefixName,
|
|
|
|
const std::string& value,
|
|
|
|
std::shared_ptr<const SliceTransform>* slice_transform) {
|
2015-10-11 21:17:42 +02:00
|
|
|
static const std::string kNullptrString = "nullptr";
|
2015-10-03 00:35:32 +02:00
|
|
|
auto& pe_value = value;
|
|
|
|
if (pe_value.size() > kFixedPrefixName.size() &&
|
|
|
|
pe_value.compare(0, kFixedPrefixName.size(), kFixedPrefixName) == 0) {
|
|
|
|
int prefix_length = ParseInt(trim(value.substr(kFixedPrefixName.size())));
|
|
|
|
slice_transform->reset(NewFixedPrefixTransform(prefix_length));
|
|
|
|
} else if (pe_value.size() > kCappedPrefixName.size() &&
|
|
|
|
pe_value.compare(0, kCappedPrefixName.size(), kCappedPrefixName) ==
|
|
|
|
0) {
|
|
|
|
int prefix_length =
|
|
|
|
ParseInt(trim(pe_value.substr(kCappedPrefixName.size())));
|
|
|
|
slice_transform->reset(NewCappedPrefixTransform(prefix_length));
|
2015-10-11 21:17:42 +02:00
|
|
|
} else if (value == kNullptrString) {
|
2015-10-03 00:35:32 +02:00
|
|
|
slice_transform->reset();
|
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool ParseSliceTransform(
|
|
|
|
const std::string& value,
|
|
|
|
std::shared_ptr<const SliceTransform>* slice_transform) {
|
|
|
|
// While we normally don't convert the string representation of a
|
|
|
|
// pointer-typed option into its instance, here we do so for backward
|
|
|
|
// compatibility as we allow this action in SetOption().
|
|
|
|
|
|
|
|
// TODO(yhchiang): A possible better place for these serialization /
|
|
|
|
// deserialization is inside the class definition of pointer-typed
|
|
|
|
// option itself, but this requires a bigger change of public API.
|
|
|
|
bool result =
|
|
|
|
ParseSliceTransformHelper("fixed:", "capped:", value, slice_transform);
|
|
|
|
if (result) {
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
result = ParseSliceTransformHelper(
|
|
|
|
"rocksdb.FixedPrefix.", "rocksdb.CappedPrefix.", value, slice_transform);
|
|
|
|
if (result) {
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
// TODO(yhchiang): we can further support other default
|
|
|
|
// SliceTransforms here.
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2015-08-27 01:13:56 +02:00
|
|
|
bool ParseOptionHelper(char* opt_address, const OptionType& opt_type,
|
|
|
|
const std::string& value) {
|
|
|
|
switch (opt_type) {
|
|
|
|
case OptionType::kBoolean:
|
|
|
|
*reinterpret_cast<bool*>(opt_address) = ParseBoolean("", value);
|
|
|
|
break;
|
|
|
|
case OptionType::kInt:
|
|
|
|
*reinterpret_cast<int*>(opt_address) = ParseInt(value);
|
|
|
|
break;
|
2016-09-14 06:12:43 +02:00
|
|
|
case OptionType::kVectorInt:
|
|
|
|
*reinterpret_cast<std::vector<int>*>(opt_address) = ParseVectorInt(value);
|
|
|
|
break;
|
2015-08-27 01:13:56 +02:00
|
|
|
case OptionType::kUInt:
|
|
|
|
*reinterpret_cast<unsigned int*>(opt_address) = ParseUint32(value);
|
|
|
|
break;
|
|
|
|
case OptionType::kUInt32T:
|
|
|
|
*reinterpret_cast<uint32_t*>(opt_address) = ParseUint32(value);
|
|
|
|
break;
|
|
|
|
case OptionType::kUInt64T:
|
|
|
|
*reinterpret_cast<uint64_t*>(opt_address) = ParseUint64(value);
|
|
|
|
break;
|
|
|
|
case OptionType::kSizeT:
|
|
|
|
*reinterpret_cast<size_t*>(opt_address) = ParseSizeT(value);
|
|
|
|
break;
|
|
|
|
case OptionType::kString:
|
|
|
|
*reinterpret_cast<std::string*>(opt_address) = value;
|
|
|
|
break;
|
|
|
|
case OptionType::kDouble:
|
|
|
|
*reinterpret_cast<double*>(opt_address) = ParseDouble(value);
|
|
|
|
break;
|
|
|
|
case OptionType::kCompactionStyle:
|
2015-11-18 01:41:54 +01:00
|
|
|
return ParseEnum<CompactionStyle>(
|
|
|
|
compaction_style_string_map, value,
|
|
|
|
reinterpret_cast<CompactionStyle*>(opt_address));
|
2015-10-03 00:35:32 +02:00
|
|
|
case OptionType::kCompressionType:
|
2015-11-18 01:41:54 +01:00
|
|
|
return ParseEnum<CompressionType>(
|
|
|
|
compression_type_string_map, value,
|
|
|
|
reinterpret_cast<CompressionType*>(opt_address));
|
2015-10-03 00:35:32 +02:00
|
|
|
case OptionType::kVectorCompressionType:
|
|
|
|
return ParseVectorCompressionType(
|
|
|
|
value, reinterpret_cast<std::vector<CompressionType>*>(opt_address));
|
|
|
|
case OptionType::kSliceTransform:
|
|
|
|
return ParseSliceTransform(
|
|
|
|
value, reinterpret_cast<std::shared_ptr<const SliceTransform>*>(
|
|
|
|
opt_address));
|
2015-10-11 21:17:42 +02:00
|
|
|
case OptionType::kChecksumType:
|
2015-11-18 01:41:54 +01:00
|
|
|
return ParseEnum<ChecksumType>(
|
|
|
|
checksum_type_string_map, value,
|
|
|
|
reinterpret_cast<ChecksumType*>(opt_address));
|
2015-10-11 21:17:42 +02:00
|
|
|
case OptionType::kBlockBasedTableIndexType:
|
2015-10-30 23:58:46 +01:00
|
|
|
return ParseEnum<BlockBasedTableOptions::IndexType>(
|
2015-11-18 01:41:54 +01:00
|
|
|
block_base_table_index_type_string_map, value,
|
|
|
|
reinterpret_cast<BlockBasedTableOptions::IndexType*>(opt_address));
|
2015-10-28 18:46:01 +01:00
|
|
|
case OptionType::kEncodingType:
|
2015-11-18 01:41:54 +01:00
|
|
|
return ParseEnum<EncodingType>(
|
|
|
|
encoding_type_string_map, value,
|
|
|
|
reinterpret_cast<EncodingType*>(opt_address));
|
2016-03-02 19:34:14 +01:00
|
|
|
case OptionType::kWALRecoveryMode:
|
|
|
|
return ParseEnum<WALRecoveryMode>(
|
|
|
|
wal_recovery_mode_string_map, value,
|
|
|
|
reinterpret_cast<WALRecoveryMode*>(opt_address));
|
|
|
|
case OptionType::kAccessHint:
|
|
|
|
return ParseEnum<DBOptions::AccessHint>(
|
|
|
|
access_hint_string_map, value,
|
|
|
|
reinterpret_cast<DBOptions::AccessHint*>(opt_address));
|
|
|
|
case OptionType::kInfoLogLevel:
|
|
|
|
return ParseEnum<InfoLogLevel>(
|
|
|
|
info_log_level_string_map, value,
|
|
|
|
reinterpret_cast<InfoLogLevel*>(opt_address));
|
2015-08-27 01:13:56 +02:00
|
|
|
default:
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2015-10-03 00:35:32 +02:00
|
|
|
} // anonymouse namespace
|
|
|
|
|
2015-08-27 01:13:56 +02:00
|
|
|
bool SerializeSingleOptionHelper(const char* opt_address,
|
|
|
|
const OptionType opt_type,
|
|
|
|
std::string* value) {
|
2015-10-12 02:40:50 +02:00
|
|
|
static const std::string kNullptrString = "nullptr";
|
2015-08-27 01:13:56 +02:00
|
|
|
assert(value);
|
|
|
|
switch (opt_type) {
|
|
|
|
case OptionType::kBoolean:
|
|
|
|
*value = *(reinterpret_cast<const bool*>(opt_address)) ? "true" : "false";
|
|
|
|
break;
|
|
|
|
case OptionType::kInt:
|
|
|
|
*value = ToString(*(reinterpret_cast<const int*>(opt_address)));
|
|
|
|
break;
|
2016-09-14 06:12:43 +02:00
|
|
|
case OptionType::kVectorInt:
|
|
|
|
return SerializeIntVector(
|
|
|
|
*reinterpret_cast<const std::vector<int>*>(opt_address), value);
|
2015-08-27 01:13:56 +02:00
|
|
|
case OptionType::kUInt:
|
|
|
|
*value = ToString(*(reinterpret_cast<const unsigned int*>(opt_address)));
|
|
|
|
break;
|
|
|
|
case OptionType::kUInt32T:
|
|
|
|
*value = ToString(*(reinterpret_cast<const uint32_t*>(opt_address)));
|
|
|
|
break;
|
|
|
|
case OptionType::kUInt64T:
|
|
|
|
*value = ToString(*(reinterpret_cast<const uint64_t*>(opt_address)));
|
|
|
|
break;
|
|
|
|
case OptionType::kSizeT:
|
|
|
|
*value = ToString(*(reinterpret_cast<const size_t*>(opt_address)));
|
|
|
|
break;
|
|
|
|
case OptionType::kDouble:
|
|
|
|
*value = ToString(*(reinterpret_cast<const double*>(opt_address)));
|
|
|
|
break;
|
|
|
|
case OptionType::kString:
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
*value = EscapeOptionString(
|
|
|
|
*(reinterpret_cast<const std::string*>(opt_address)));
|
2015-08-27 01:13:56 +02:00
|
|
|
break;
|
|
|
|
case OptionType::kCompactionStyle:
|
2015-11-18 01:41:54 +01:00
|
|
|
return SerializeEnum<CompactionStyle>(
|
|
|
|
compaction_style_string_map,
|
2015-10-30 23:58:46 +01:00
|
|
|
*(reinterpret_cast<const CompactionStyle*>(opt_address)), value);
|
2015-10-03 00:35:32 +02:00
|
|
|
case OptionType::kCompressionType:
|
2015-11-18 01:41:54 +01:00
|
|
|
return SerializeEnum<CompressionType>(
|
|
|
|
compression_type_string_map,
|
2015-10-03 00:35:32 +02:00
|
|
|
*(reinterpret_cast<const CompressionType*>(opt_address)), value);
|
|
|
|
case OptionType::kVectorCompressionType:
|
|
|
|
return SerializeVectorCompressionType(
|
|
|
|
*(reinterpret_cast<const std::vector<CompressionType>*>(opt_address)),
|
|
|
|
value);
|
|
|
|
break;
|
|
|
|
case OptionType::kSliceTransform: {
|
|
|
|
const auto* slice_transform_ptr =
|
|
|
|
reinterpret_cast<const std::shared_ptr<const SliceTransform>*>(
|
|
|
|
opt_address);
|
|
|
|
*value = slice_transform_ptr->get() ? slice_transform_ptr->get()->Name()
|
2015-10-11 21:17:42 +02:00
|
|
|
: kNullptrString;
|
2015-10-03 00:35:32 +02:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
case OptionType::kTableFactory: {
|
|
|
|
const auto* table_factory_ptr =
|
|
|
|
reinterpret_cast<const std::shared_ptr<const TableFactory>*>(
|
|
|
|
opt_address);
|
|
|
|
*value = table_factory_ptr->get() ? table_factory_ptr->get()->Name()
|
2015-10-11 21:17:42 +02:00
|
|
|
: kNullptrString;
|
2015-10-03 00:35:32 +02:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
case OptionType::kComparator: {
|
|
|
|
// it's a const pointer of const Comparator*
|
|
|
|
const auto* ptr = reinterpret_cast<const Comparator* const*>(opt_address);
|
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
|
|
|
// Since the user-specified comparator will be wrapped by
|
|
|
|
// InternalKeyComparator, we should persist the user-specified one
|
|
|
|
// instead of InternalKeyComparator.
|
|
|
|
const auto* internal_comparator =
|
|
|
|
dynamic_cast<const InternalKeyComparator*>(*ptr);
|
|
|
|
if (internal_comparator != nullptr) {
|
|
|
|
*value = internal_comparator->user_comparator()->Name();
|
|
|
|
} else {
|
|
|
|
*value = *ptr ? (*ptr)->Name() : kNullptrString;
|
|
|
|
}
|
2015-10-03 00:35:32 +02:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
case OptionType::kCompactionFilter: {
|
|
|
|
// it's a const pointer of const CompactionFilter*
|
|
|
|
const auto* ptr =
|
|
|
|
reinterpret_cast<const CompactionFilter* const*>(opt_address);
|
2015-10-11 21:17:42 +02:00
|
|
|
*value = *ptr ? (*ptr)->Name() : kNullptrString;
|
2015-10-03 00:35:32 +02:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
case OptionType::kCompactionFilterFactory: {
|
|
|
|
const auto* ptr =
|
|
|
|
reinterpret_cast<const std::shared_ptr<CompactionFilterFactory>*>(
|
|
|
|
opt_address);
|
2015-10-11 21:17:42 +02:00
|
|
|
*value = ptr->get() ? ptr->get()->Name() : kNullptrString;
|
2015-10-03 00:35:32 +02:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
case OptionType::kMemTableRepFactory: {
|
|
|
|
const auto* ptr =
|
|
|
|
reinterpret_cast<const std::shared_ptr<MemTableRepFactory>*>(
|
|
|
|
opt_address);
|
2015-10-11 21:17:42 +02:00
|
|
|
*value = ptr->get() ? ptr->get()->Name() : kNullptrString;
|
2015-10-03 00:35:32 +02:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
case OptionType::kMergeOperator: {
|
|
|
|
const auto* ptr =
|
|
|
|
reinterpret_cast<const std::shared_ptr<MergeOperator>*>(opt_address);
|
2015-10-11 21:17:42 +02:00
|
|
|
*value = ptr->get() ? ptr->get()->Name() : kNullptrString;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
case OptionType::kFilterPolicy: {
|
|
|
|
const auto* ptr =
|
|
|
|
reinterpret_cast<const std::shared_ptr<FilterPolicy>*>(opt_address);
|
|
|
|
*value = ptr->get() ? ptr->get()->Name() : kNullptrString;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
case OptionType::kChecksumType:
|
2015-11-18 01:41:54 +01:00
|
|
|
return SerializeEnum<ChecksumType>(
|
|
|
|
checksum_type_string_map,
|
2015-10-11 21:17:42 +02:00
|
|
|
*reinterpret_cast<const ChecksumType*>(opt_address), value);
|
|
|
|
case OptionType::kBlockBasedTableIndexType:
|
2015-10-30 23:58:46 +01:00
|
|
|
return SerializeEnum<BlockBasedTableOptions::IndexType>(
|
|
|
|
block_base_table_index_type_string_map,
|
2015-10-11 21:17:42 +02:00
|
|
|
*reinterpret_cast<const BlockBasedTableOptions::IndexType*>(
|
|
|
|
opt_address),
|
|
|
|
value);
|
|
|
|
case OptionType::kFlushBlockPolicyFactory: {
|
|
|
|
const auto* ptr =
|
|
|
|
reinterpret_cast<const std::shared_ptr<FlushBlockPolicyFactory>*>(
|
|
|
|
opt_address);
|
|
|
|
*value = ptr->get() ? ptr->get()->Name() : kNullptrString;
|
2015-10-03 00:35:32 +02:00
|
|
|
break;
|
|
|
|
}
|
2015-10-28 18:46:01 +01:00
|
|
|
case OptionType::kEncodingType:
|
2015-11-18 01:41:54 +01:00
|
|
|
return SerializeEnum<EncodingType>(
|
|
|
|
encoding_type_string_map,
|
2015-10-28 18:46:01 +01:00
|
|
|
*reinterpret_cast<const EncodingType*>(opt_address), value);
|
2016-03-02 19:34:14 +01:00
|
|
|
case OptionType::kWALRecoveryMode:
|
|
|
|
return SerializeEnum<WALRecoveryMode>(
|
|
|
|
wal_recovery_mode_string_map,
|
|
|
|
*reinterpret_cast<const WALRecoveryMode*>(opt_address), value);
|
|
|
|
case OptionType::kAccessHint:
|
|
|
|
return SerializeEnum<DBOptions::AccessHint>(
|
|
|
|
access_hint_string_map,
|
|
|
|
*reinterpret_cast<const DBOptions::AccessHint*>(opt_address), value);
|
|
|
|
case OptionType::kInfoLogLevel:
|
|
|
|
return SerializeEnum<InfoLogLevel>(
|
|
|
|
info_log_level_string_map,
|
|
|
|
*reinterpret_cast<const InfoLogLevel*>(opt_address), value);
|
2015-08-27 01:13:56 +02:00
|
|
|
default:
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
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,
|
|
|
|
MutableCFOptions* new_options) {
|
|
|
|
assert(new_options);
|
|
|
|
*new_options = base_options;
|
2014-12-22 22:18:57 +01:00
|
|
|
for (const auto& o : options_map) {
|
|
|
|
try {
|
2016-09-14 06:12:43 +02:00
|
|
|
auto iter = cf_options_type_info.find(o.first);
|
|
|
|
if (iter == cf_options_type_info.end()) {
|
|
|
|
return Status::InvalidArgument("Unrecognized option: " + o.first);
|
|
|
|
}
|
|
|
|
const auto& opt_info = iter->second;
|
|
|
|
if (!opt_info.is_mutable) {
|
|
|
|
return Status::InvalidArgument("Option not changeable: " + o.first);
|
|
|
|
}
|
|
|
|
bool is_ok = ParseOptionHelper(
|
|
|
|
reinterpret_cast<char*>(new_options) + opt_info.mutable_offset,
|
|
|
|
opt_info.type, o.second);
|
|
|
|
if (!is_ok) {
|
|
|
|
return Status::InvalidArgument("Error parsing " + o.first);
|
2014-09-17 21:49:13 +02:00
|
|
|
}
|
2015-07-08 16:35:56 +02:00
|
|
|
} catch (std::exception& e) {
|
2016-09-14 06:12:43 +02:00
|
|
|
return Status::InvalidArgument("Error parsing " + o.first + ":" +
|
2014-12-22 22:18:57 +01:00
|
|
|
std::string(e.what()));
|
2014-09-17 21:49:13 +02:00
|
|
|
}
|
|
|
|
}
|
2014-11-05 01:23:05 +01:00
|
|
|
return Status::OK();
|
2014-09-17 21:49:13 +02:00
|
|
|
}
|
|
|
|
|
2014-12-22 22:18:57 +01:00
|
|
|
Status StringToMap(const std::string& opts_str,
|
|
|
|
std::unordered_map<std::string, std::string>* opts_map) {
|
2014-10-10 19:00:12 +02:00
|
|
|
assert(opts_map);
|
|
|
|
// Example:
|
2014-12-22 22:18:57 +01:00
|
|
|
// opts_str = "write_buffer_size=1024;max_write_buffer_number=2;"
|
|
|
|
// "nested_opt={opt1=1;opt2=2};max_bytes_for_level_base=100"
|
2014-10-10 19:00:12 +02:00
|
|
|
size_t pos = 0;
|
|
|
|
std::string opts = trim(opts_str);
|
|
|
|
while (pos < opts.size()) {
|
|
|
|
size_t eq_pos = opts.find('=', pos);
|
|
|
|
if (eq_pos == std::string::npos) {
|
2014-12-22 22:18:57 +01:00
|
|
|
return Status::InvalidArgument("Mismatched key value pair, '=' expected");
|
2014-10-10 19:00:12 +02:00
|
|
|
}
|
|
|
|
std::string key = trim(opts.substr(pos, eq_pos - pos));
|
2014-12-22 22:18:57 +01:00
|
|
|
if (key.empty()) {
|
|
|
|
return Status::InvalidArgument("Empty key found");
|
|
|
|
}
|
2014-10-10 19:00:12 +02:00
|
|
|
|
2014-12-22 22:18:57 +01:00
|
|
|
// skip space after '=' and look for '{' for possible nested options
|
|
|
|
pos = eq_pos + 1;
|
|
|
|
while (pos < opts.size() && isspace(opts[pos])) {
|
|
|
|
++pos;
|
|
|
|
}
|
|
|
|
// Empty value at the end
|
|
|
|
if (pos >= opts.size()) {
|
|
|
|
(*opts_map)[key] = "";
|
2014-10-10 19:00:12 +02:00
|
|
|
break;
|
2014-12-22 22:18:57 +01:00
|
|
|
}
|
|
|
|
if (opts[pos] == '{') {
|
|
|
|
int count = 1;
|
|
|
|
size_t brace_pos = pos + 1;
|
|
|
|
while (brace_pos < opts.size()) {
|
|
|
|
if (opts[brace_pos] == '{') {
|
|
|
|
++count;
|
|
|
|
} else if (opts[brace_pos] == '}') {
|
|
|
|
--count;
|
|
|
|
if (count == 0) {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
++brace_pos;
|
|
|
|
}
|
|
|
|
// found the matching closing brace
|
|
|
|
if (count == 0) {
|
|
|
|
(*opts_map)[key] = trim(opts.substr(pos + 1, brace_pos - pos - 1));
|
|
|
|
// skip all whitespace and move to the next ';'
|
|
|
|
// brace_pos points to the next position after the matching '}'
|
|
|
|
pos = brace_pos + 1;
|
|
|
|
while (pos < opts.size() && isspace(opts[pos])) {
|
|
|
|
++pos;
|
|
|
|
}
|
|
|
|
if (pos < opts.size() && opts[pos] != ';') {
|
|
|
|
return Status::InvalidArgument(
|
|
|
|
"Unexpected chars after nested options");
|
|
|
|
}
|
|
|
|
++pos;
|
|
|
|
} else {
|
|
|
|
return Status::InvalidArgument(
|
|
|
|
"Mismatched curly braces for nested options");
|
|
|
|
}
|
2014-10-10 19:00:12 +02:00
|
|
|
} else {
|
2014-12-22 22:18:57 +01:00
|
|
|
size_t sc_pos = opts.find(';', pos);
|
|
|
|
if (sc_pos == std::string::npos) {
|
|
|
|
(*opts_map)[key] = trim(opts.substr(pos));
|
|
|
|
// It either ends with a trailing semi-colon or the last key-value pair
|
|
|
|
break;
|
|
|
|
} else {
|
|
|
|
(*opts_map)[key] = trim(opts.substr(pos, sc_pos - pos));
|
|
|
|
}
|
|
|
|
pos = sc_pos + 1;
|
2014-10-10 19:00:12 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-12-22 22:18:57 +01:00
|
|
|
return Status::OK();
|
2014-10-10 19:00:12 +02:00
|
|
|
}
|
|
|
|
|
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
|
|
|
Status ParseColumnFamilyOption(const std::string& name,
|
|
|
|
const std::string& org_value,
|
|
|
|
ColumnFamilyOptions* new_options,
|
|
|
|
bool input_strings_escaped = false) {
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
const std::string& value =
|
2015-10-28 18:46:01 +01:00
|
|
|
input_strings_escaped ? UnescapeOptionString(org_value) : org_value;
|
2015-02-20 04:11:14 +01:00
|
|
|
try {
|
2016-09-14 06:12:43 +02:00
|
|
|
if (name == "block_based_table_factory") {
|
2015-02-20 04:11:14 +01:00
|
|
|
// Nested options
|
|
|
|
BlockBasedTableOptions table_opt, base_table_options;
|
|
|
|
auto block_based_table_factory = dynamic_cast<BlockBasedTableFactory*>(
|
|
|
|
new_options->table_factory.get());
|
|
|
|
if (block_based_table_factory != nullptr) {
|
2015-10-30 23:58:46 +01:00
|
|
|
base_table_options = block_based_table_factory->table_options();
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
|
|
|
Status table_opt_s = GetBlockBasedTableOptionsFromString(
|
|
|
|
base_table_options, value, &table_opt);
|
|
|
|
if (!table_opt_s.ok()) {
|
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
|
|
|
return Status::InvalidArgument(
|
|
|
|
"unable to parse the specified CF option " + name);
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
|
|
|
new_options->table_factory.reset(NewBlockBasedTableFactory(table_opt));
|
2015-10-28 18:46:01 +01:00
|
|
|
} else if (name == "plain_table_factory") {
|
|
|
|
// Nested options
|
|
|
|
PlainTableOptions table_opt, base_table_options;
|
|
|
|
auto plain_table_factory = dynamic_cast<PlainTableFactory*>(
|
|
|
|
new_options->table_factory.get());
|
|
|
|
if (plain_table_factory != nullptr) {
|
2015-10-30 23:58:46 +01:00
|
|
|
base_table_options = plain_table_factory->table_options();
|
2015-10-28 18:46:01 +01:00
|
|
|
}
|
|
|
|
Status table_opt_s = GetPlainTableOptionsFromString(
|
|
|
|
base_table_options, value, &table_opt);
|
|
|
|
if (!table_opt_s.ok()) {
|
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
|
|
|
return Status::InvalidArgument(
|
|
|
|
"unable to parse the specified CF option " + name);
|
2015-10-28 18:46:01 +01:00
|
|
|
}
|
|
|
|
new_options->table_factory.reset(NewPlainTableFactory(table_opt));
|
2015-11-17 23:29:01 +01:00
|
|
|
} else if (name == "memtable") {
|
|
|
|
std::unique_ptr<MemTableRepFactory> new_mem_factory;
|
|
|
|
Status mem_factory_s =
|
|
|
|
GetMemTableRepFactoryFromString(value, &new_mem_factory);
|
|
|
|
if (!mem_factory_s.ok()) {
|
|
|
|
return Status::InvalidArgument(
|
|
|
|
"unable to parse the specified CF option " + name);
|
|
|
|
}
|
|
|
|
new_options->memtable_factory.reset(new_mem_factory.release());
|
2015-02-20 04:11:14 +01:00
|
|
|
} else if (name == "compression_opts") {
|
|
|
|
size_t start = 0;
|
|
|
|
size_t end = value.find(':');
|
|
|
|
if (end == std::string::npos) {
|
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
|
|
|
return Status::InvalidArgument(
|
|
|
|
"unable to parse the specified CF option " + name);
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
|
|
|
new_options->compression_opts.window_bits =
|
|
|
|
ParseInt(value.substr(start, end - start));
|
|
|
|
start = end + 1;
|
|
|
|
end = value.find(':', start);
|
|
|
|
if (end == std::string::npos) {
|
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
|
|
|
return Status::InvalidArgument(
|
|
|
|
"unable to parse the specified CF option " + name);
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
|
|
|
new_options->compression_opts.level =
|
|
|
|
ParseInt(value.substr(start, end - start));
|
|
|
|
start = end + 1;
|
2016-05-06 20:27:28 +02:00
|
|
|
if (start >= value.size()) {
|
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
|
|
|
return Status::InvalidArgument(
|
|
|
|
"unable to parse the specified CF option " + name);
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
2016-05-06 20:27:28 +02:00
|
|
|
end = value.find(':', start);
|
2015-02-20 04:11:14 +01:00
|
|
|
new_options->compression_opts.strategy =
|
|
|
|
ParseInt(value.substr(start, value.size() - start));
|
2016-05-06 20:27:28 +02:00
|
|
|
// max_dict_bytes is optional for backwards compatibility
|
|
|
|
if (end != std::string::npos) {
|
|
|
|
start = end + 1;
|
|
|
|
if (start >= value.size()) {
|
|
|
|
return Status::InvalidArgument(
|
|
|
|
"unable to parse the specified CF option " + name);
|
|
|
|
}
|
|
|
|
new_options->compression_opts.max_dict_bytes =
|
|
|
|
ParseInt(value.substr(start, value.size() - start));
|
Shared dictionary compression using reference block
Summary:
This adds a new metablock containing a shared dictionary that is used
to compress all data blocks in the SST file. The size of the shared dictionary
is configurable in CompressionOptions and defaults to 0. It's currently only
used for zlib/lz4/lz4hc, but the block will be stored in the SST regardless of
the compression type if the user chooses a nonzero dictionary size.
During compaction, computes the dictionary by randomly sampling the first
output file in each subcompaction. It pre-computes the intervals to sample
by assuming the output file will have the maximum allowable length. In case
the file is smaller, some of the pre-computed sampling intervals can be beyond
end-of-file, in which case we skip over those samples and the dictionary will
be a bit smaller. After the dictionary is generated using the first file in a
subcompaction, it is loaded into the compression library before writing each
block in each subsequent file of that subcompaction.
On the read path, gets the dictionary from the metablock, if it exists. Then,
loads that dictionary into the compression library before reading each block.
Test Plan: new unit test
Reviewers: yhchiang, IslamAbdelRahman, cyan, sdong
Reviewed By: sdong
Subscribers: andrewkr, yoshinorim, kradhakrishnan, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D52287
2016-04-28 02:36:03 +02:00
|
|
|
}
|
2015-02-20 04:11:14 +01:00
|
|
|
} else if (name == "compaction_options_fifo") {
|
|
|
|
new_options->compaction_options_fifo.max_table_files_size =
|
|
|
|
ParseUint64(value);
|
|
|
|
} else {
|
2015-08-27 01:13:56 +02:00
|
|
|
auto iter = cf_options_type_info.find(name);
|
|
|
|
if (iter == cf_options_type_info.end()) {
|
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
|
|
|
return Status::InvalidArgument(
|
|
|
|
"Unable to parse the specified CF option " + name);
|
2015-08-27 01:13:56 +02:00
|
|
|
}
|
|
|
|
const auto& opt_info = iter->second;
|
2016-06-17 13:52:53 +02:00
|
|
|
if (opt_info.verification != OptionVerificationType::kDeprecated &&
|
|
|
|
ParseOptionHelper(
|
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
|
|
|
reinterpret_cast<char*>(new_options) + opt_info.offset,
|
|
|
|
opt_info.type, value)) {
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
switch (opt_info.verification) {
|
|
|
|
case OptionVerificationType::kByName:
|
2016-02-19 23:42:24 +01:00
|
|
|
case OptionVerificationType::kByNameAllowNull:
|
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
|
|
|
return Status::NotSupported(
|
|
|
|
"Deserializing the specified CF option " + name +
|
|
|
|
" is not supported");
|
|
|
|
case OptionVerificationType::kDeprecated:
|
|
|
|
return Status::OK();
|
|
|
|
default:
|
|
|
|
return Status::InvalidArgument(
|
|
|
|
"Unable to parse the specified CF option " + name);
|
|
|
|
}
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
2015-11-02 23:11:28 +01:00
|
|
|
} catch (const std::exception&) {
|
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
|
|
|
return Status::InvalidArgument(
|
|
|
|
"unable to parse the specified option " + name);
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
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
|
|
|
return Status::OK();
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
bool SerializeSingleDBOption(std::string* opt_string,
|
|
|
|
const DBOptions& db_options,
|
|
|
|
const std::string& name,
|
|
|
|
const std::string& delimiter) {
|
2015-08-18 22:30:18 +02:00
|
|
|
auto iter = db_options_type_info.find(name);
|
|
|
|
if (iter == db_options_type_info.end()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
auto& opt_info = iter->second;
|
|
|
|
const char* opt_address =
|
|
|
|
reinterpret_cast<const char*>(&db_options) + opt_info.offset;
|
|
|
|
std::string value;
|
2015-08-27 01:13:56 +02:00
|
|
|
bool result = SerializeSingleOptionHelper(opt_address, opt_info.type, &value);
|
|
|
|
if (result) {
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
*opt_string = name + "=" + value + delimiter;
|
2015-08-18 22:30:18 +02:00
|
|
|
}
|
2015-08-27 01:13:56 +02:00
|
|
|
return result;
|
2015-08-18 22:30:18 +02:00
|
|
|
}
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
Status GetStringFromDBOptions(std::string* opt_string,
|
|
|
|
const DBOptions& db_options,
|
|
|
|
const std::string& delimiter) {
|
2015-08-18 22:30:18 +02:00
|
|
|
assert(opt_string);
|
|
|
|
opt_string->clear();
|
|
|
|
for (auto iter = db_options_type_info.begin();
|
|
|
|
iter != db_options_type_info.end(); ++iter) {
|
2015-09-30 02:58:00 +02:00
|
|
|
if (iter->second.verification == OptionVerificationType::kDeprecated) {
|
|
|
|
// If the option is no longer used in rocksdb and marked as deprecated,
|
|
|
|
// we skip it in the serialization.
|
|
|
|
continue;
|
|
|
|
}
|
2015-08-18 22:30:18 +02:00
|
|
|
std::string single_output;
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
bool result = SerializeSingleDBOption(&single_output, db_options,
|
|
|
|
iter->first, delimiter);
|
2015-08-18 22:30:18 +02:00
|
|
|
assert(result);
|
|
|
|
if (result) {
|
|
|
|
opt_string->append(single_output);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
bool SerializeSingleColumnFamilyOption(std::string* opt_string,
|
|
|
|
const ColumnFamilyOptions& cf_options,
|
2015-08-27 01:13:56 +02:00
|
|
|
const std::string& name,
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
const std::string& delimiter) {
|
2015-08-27 01:13:56 +02:00
|
|
|
auto iter = cf_options_type_info.find(name);
|
|
|
|
if (iter == cf_options_type_info.end()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
auto& opt_info = iter->second;
|
|
|
|
const char* opt_address =
|
|
|
|
reinterpret_cast<const char*>(&cf_options) + opt_info.offset;
|
|
|
|
std::string value;
|
|
|
|
bool result = SerializeSingleOptionHelper(opt_address, opt_info.type, &value);
|
|
|
|
if (result) {
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
*opt_string = name + "=" + value + delimiter;
|
2015-08-27 01:13:56 +02:00
|
|
|
}
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
Status GetStringFromColumnFamilyOptions(std::string* opt_string,
|
|
|
|
const ColumnFamilyOptions& cf_options,
|
|
|
|
const std::string& delimiter) {
|
2015-08-27 01:13:56 +02:00
|
|
|
assert(opt_string);
|
|
|
|
opt_string->clear();
|
|
|
|
for (auto iter = cf_options_type_info.begin();
|
|
|
|
iter != cf_options_type_info.end(); ++iter) {
|
2015-09-30 02:13:02 +02:00
|
|
|
if (iter->second.verification == OptionVerificationType::kDeprecated) {
|
2015-09-30 02:58:00 +02:00
|
|
|
// If the option is no longer used in rocksdb and marked as deprecated,
|
|
|
|
// we skip it in the serialization.
|
2015-09-30 02:13:02 +02:00
|
|
|
continue;
|
|
|
|
}
|
2015-08-27 01:13:56 +02:00
|
|
|
std::string single_output;
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
bool result = SerializeSingleColumnFamilyOption(&single_output, cf_options,
|
|
|
|
iter->first, delimiter);
|
2015-08-27 01:13:56 +02:00
|
|
|
if (result) {
|
|
|
|
opt_string->append(single_output);
|
|
|
|
} else {
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
return Status::InvalidArgument("failed to serialize %s\n",
|
|
|
|
iter->first.c_str());
|
2015-08-27 01:13:56 +02:00
|
|
|
}
|
|
|
|
assert(result);
|
|
|
|
}
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
2016-05-19 00:03:21 +02:00
|
|
|
Status GetStringFromCompressionType(std::string* compression_str,
|
|
|
|
CompressionType compression_type) {
|
|
|
|
bool ok = SerializeEnum<CompressionType>(compression_type_string_map,
|
|
|
|
compression_type, compression_str);
|
|
|
|
if (ok) {
|
|
|
|
return Status::OK();
|
|
|
|
} else {
|
|
|
|
return Status::InvalidArgument("Invalid compression types");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-10-11 21:17:42 +02:00
|
|
|
bool SerializeSingleBlockBasedTableOption(
|
|
|
|
std::string* opt_string, const BlockBasedTableOptions& bbt_options,
|
|
|
|
const std::string& name, const std::string& delimiter) {
|
|
|
|
auto iter = block_based_table_type_info.find(name);
|
|
|
|
if (iter == block_based_table_type_info.end()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
auto& opt_info = iter->second;
|
|
|
|
const char* opt_address =
|
|
|
|
reinterpret_cast<const char*>(&bbt_options) + opt_info.offset;
|
|
|
|
std::string value;
|
|
|
|
bool result = SerializeSingleOptionHelper(opt_address, opt_info.type, &value);
|
|
|
|
if (result) {
|
|
|
|
*opt_string = name + "=" + value + delimiter;
|
|
|
|
}
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
|
|
|
Status GetStringFromBlockBasedTableOptions(
|
|
|
|
std::string* opt_string, const BlockBasedTableOptions& bbt_options,
|
|
|
|
const std::string& delimiter) {
|
|
|
|
assert(opt_string);
|
|
|
|
opt_string->clear();
|
|
|
|
for (auto iter = block_based_table_type_info.begin();
|
|
|
|
iter != block_based_table_type_info.end(); ++iter) {
|
|
|
|
if (iter->second.verification == OptionVerificationType::kDeprecated) {
|
|
|
|
// If the option is no longer used in rocksdb and marked as deprecated,
|
|
|
|
// we skip it in the serialization.
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
std::string single_output;
|
|
|
|
bool result = SerializeSingleBlockBasedTableOption(
|
|
|
|
&single_output, bbt_options, iter->first, delimiter);
|
|
|
|
assert(result);
|
|
|
|
if (result) {
|
|
|
|
opt_string->append(single_output);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
|
|
|
Status GetStringFromTableFactory(std::string* opts_str, const TableFactory* tf,
|
|
|
|
const std::string& delimiter) {
|
|
|
|
const auto* bbtf = dynamic_cast<const BlockBasedTableFactory*>(tf);
|
|
|
|
opts_str->clear();
|
|
|
|
if (bbtf != nullptr) {
|
2015-11-18 01:41:54 +01:00
|
|
|
return GetStringFromBlockBasedTableOptions(opts_str, bbtf->table_options(),
|
|
|
|
delimiter);
|
2015-10-11 21:17:42 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
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
|
|
|
Status ParseDBOption(const std::string& name,
|
|
|
|
const std::string& org_value,
|
|
|
|
DBOptions* new_options,
|
|
|
|
bool input_strings_escaped = false) {
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
const std::string& value =
|
2015-10-28 18:46:01 +01:00
|
|
|
input_strings_escaped ? UnescapeOptionString(org_value) : org_value;
|
2015-02-20 04:11:14 +01:00
|
|
|
try {
|
2015-08-18 22:30:18 +02:00
|
|
|
if (name == "rate_limiter_bytes_per_sec") {
|
2015-03-06 23:21:15 +01:00
|
|
|
new_options->rate_limiter.reset(
|
|
|
|
NewGenericRateLimiter(static_cast<int64_t>(ParseUint64(value))));
|
2015-02-20 04:11:14 +01:00
|
|
|
} else {
|
2015-08-18 22:30:18 +02:00
|
|
|
auto iter = db_options_type_info.find(name);
|
|
|
|
if (iter == db_options_type_info.end()) {
|
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
|
|
|
return Status::InvalidArgument("Unrecognized option DBOptions:", name);
|
2015-08-18 22:30:18 +02:00
|
|
|
}
|
2015-08-27 01:13:56 +02:00
|
|
|
const auto& opt_info = iter->second;
|
2016-06-17 13:52:53 +02:00
|
|
|
if (opt_info.verification != OptionVerificationType::kDeprecated &&
|
|
|
|
ParseOptionHelper(
|
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
|
|
|
reinterpret_cast<char*>(new_options) + opt_info.offset,
|
|
|
|
opt_info.type, value)) {
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
switch (opt_info.verification) {
|
|
|
|
case OptionVerificationType::kByName:
|
2016-02-19 23:42:24 +01:00
|
|
|
case OptionVerificationType::kByNameAllowNull:
|
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
|
|
|
return Status::NotSupported(
|
|
|
|
"Deserializing the specified DB option " + name +
|
|
|
|
" is not supported");
|
|
|
|
case OptionVerificationType::kDeprecated:
|
|
|
|
return Status::OK();
|
|
|
|
default:
|
|
|
|
return Status::InvalidArgument(
|
|
|
|
"Unable to parse the specified DB option " + name);
|
2015-10-03 00:35:32 +02:00
|
|
|
}
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
2015-11-02 23:11:28 +01:00
|
|
|
} catch (const std::exception&) {
|
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
|
|
|
return Status::InvalidArgument("Unable to parse DBOptions:", name);
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
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
|
|
|
return Status::OK();
|
2015-02-20 04:11:14 +01:00
|
|
|
}
|
2014-10-10 19:00:12 +02:00
|
|
|
|
2015-10-11 21:17:42 +02:00
|
|
|
std::string ParseBlockBasedTableOption(const std::string& name,
|
|
|
|
const std::string& org_value,
|
|
|
|
BlockBasedTableOptions* new_options,
|
2015-10-28 18:46:01 +01:00
|
|
|
bool input_strings_escaped = false) {
|
2015-10-11 21:17:42 +02:00
|
|
|
const std::string& value =
|
2015-10-28 18:46:01 +01:00
|
|
|
input_strings_escaped ? UnescapeOptionString(org_value) : org_value;
|
|
|
|
if (!input_strings_escaped) {
|
2015-10-11 21:17:42 +02:00
|
|
|
// if the input string is not escaped, it means this function is
|
|
|
|
// invoked from SetOptions, which takes the old format.
|
|
|
|
if (name == "block_cache") {
|
|
|
|
new_options->block_cache = NewLRUCache(ParseSizeT(value));
|
|
|
|
return "";
|
|
|
|
} else if (name == "block_cache_compressed") {
|
|
|
|
new_options->block_cache_compressed = NewLRUCache(ParseSizeT(value));
|
|
|
|
return "";
|
|
|
|
} else if (name == "filter_policy") {
|
|
|
|
// Expect the following format
|
|
|
|
// bloomfilter:int:bool
|
|
|
|
const std::string kName = "bloomfilter:";
|
|
|
|
if (value.compare(0, kName.size(), kName) != 0) {
|
|
|
|
return "Invalid filter policy name";
|
|
|
|
}
|
|
|
|
size_t pos = value.find(':', kName.size());
|
|
|
|
if (pos == std::string::npos) {
|
|
|
|
return "Invalid filter policy config, missing bits_per_key";
|
|
|
|
}
|
|
|
|
int bits_per_key =
|
|
|
|
ParseInt(trim(value.substr(kName.size(), pos - kName.size())));
|
|
|
|
bool use_block_based_builder =
|
|
|
|
ParseBoolean("use_block_based_builder", trim(value.substr(pos + 1)));
|
|
|
|
new_options->filter_policy.reset(
|
|
|
|
NewBloomFilterPolicy(bits_per_key, use_block_based_builder));
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
const auto iter = block_based_table_type_info.find(name);
|
|
|
|
if (iter == block_based_table_type_info.end()) {
|
|
|
|
return "Unrecognized option";
|
|
|
|
}
|
|
|
|
const auto& opt_info = iter->second;
|
|
|
|
if (!ParseOptionHelper(reinterpret_cast<char*>(new_options) + opt_info.offset,
|
|
|
|
opt_info.type, value)) {
|
|
|
|
return "Invalid value";
|
|
|
|
}
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
|
2015-10-28 18:46:01 +01:00
|
|
|
std::string ParsePlainTableOptions(const std::string& name,
|
|
|
|
const std::string& org_value,
|
|
|
|
PlainTableOptions* new_option,
|
|
|
|
bool input_strings_escaped = false) {
|
2015-11-16 21:56:21 +01:00
|
|
|
const std::string& value =
|
2015-10-28 18:46:01 +01:00
|
|
|
input_strings_escaped ? UnescapeOptionString(org_value) : org_value;
|
|
|
|
const auto iter = plain_table_type_info.find(name);
|
|
|
|
if (iter == plain_table_type_info.end()) {
|
|
|
|
return "Unrecognized option";
|
|
|
|
}
|
|
|
|
const auto& opt_info = iter->second;
|
|
|
|
if (!ParseOptionHelper(reinterpret_cast<char*>(new_option) + opt_info.offset,
|
|
|
|
opt_info.type, value)) {
|
|
|
|
return "Invalid value";
|
|
|
|
}
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
|
2014-12-22 22:18:57 +01:00
|
|
|
Status GetBlockBasedTableOptionsFromMap(
|
|
|
|
const BlockBasedTableOptions& table_options,
|
|
|
|
const std::unordered_map<std::string, std::string>& opts_map,
|
2015-10-11 21:17:42 +02:00
|
|
|
BlockBasedTableOptions* new_table_options, bool input_strings_escaped) {
|
2014-12-22 22:18:57 +01:00
|
|
|
assert(new_table_options);
|
|
|
|
*new_table_options = table_options;
|
|
|
|
for (const auto& o : opts_map) {
|
2015-10-11 21:17:42 +02:00
|
|
|
auto error_message = ParseBlockBasedTableOption(
|
|
|
|
o.first, o.second, new_table_options, input_strings_escaped);
|
|
|
|
if (error_message != "") {
|
|
|
|
const auto iter = block_based_table_type_info.find(o.first);
|
|
|
|
if (iter == block_based_table_type_info.end() ||
|
|
|
|
!input_strings_escaped || // !input_strings_escaped indicates
|
|
|
|
// the old API, where everything is
|
|
|
|
// parsable.
|
|
|
|
(iter->second.verification != OptionVerificationType::kByName &&
|
2016-02-19 23:42:24 +01:00
|
|
|
iter->second.verification !=
|
|
|
|
OptionVerificationType::kByNameAllowNull &&
|
2015-10-11 21:17:42 +02:00
|
|
|
iter->second.verification != OptionVerificationType::kDeprecated)) {
|
2016-08-11 23:54:29 +02:00
|
|
|
// Restore "new_options" to the default "base_options".
|
|
|
|
*new_table_options = table_options;
|
2015-10-11 21:17:42 +02:00
|
|
|
return Status::InvalidArgument("Can't parse BlockBasedTableOptions:",
|
|
|
|
o.first + " " + error_message);
|
2014-12-22 22:18:57 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
|
|
|
Status GetBlockBasedTableOptionsFromString(
|
|
|
|
const BlockBasedTableOptions& table_options,
|
|
|
|
const std::string& opts_str,
|
|
|
|
BlockBasedTableOptions* new_table_options) {
|
|
|
|
std::unordered_map<std::string, std::string> opts_map;
|
|
|
|
Status s = StringToMap(opts_str, &opts_map);
|
|
|
|
if (!s.ok()) {
|
|
|
|
return s;
|
|
|
|
}
|
|
|
|
return GetBlockBasedTableOptionsFromMap(table_options, opts_map,
|
|
|
|
new_table_options);
|
|
|
|
}
|
|
|
|
|
2015-07-02 01:13:49 +02:00
|
|
|
Status GetPlainTableOptionsFromMap(
|
|
|
|
const PlainTableOptions& table_options,
|
|
|
|
const std::unordered_map<std::string, std::string>& opts_map,
|
2015-10-28 18:46:01 +01:00
|
|
|
PlainTableOptions* new_table_options, bool input_strings_escaped) {
|
2015-07-02 01:13:49 +02:00
|
|
|
assert(new_table_options);
|
|
|
|
*new_table_options = table_options;
|
|
|
|
for (const auto& o : opts_map) {
|
2015-10-28 18:46:01 +01:00
|
|
|
auto error_message = ParsePlainTableOptions(
|
|
|
|
o.first, o.second, new_table_options, input_strings_escaped);
|
|
|
|
if (error_message != "") {
|
|
|
|
const auto iter = plain_table_type_info.find(o.first);
|
|
|
|
if (iter == plain_table_type_info.end() ||
|
2016-02-19 23:42:24 +01:00
|
|
|
!input_strings_escaped || // !input_strings_escaped indicates
|
|
|
|
// the old API, where everything is
|
|
|
|
// parsable.
|
2015-10-28 18:46:01 +01:00
|
|
|
(iter->second.verification != OptionVerificationType::kByName &&
|
2016-02-19 23:42:24 +01:00
|
|
|
iter->second.verification !=
|
|
|
|
OptionVerificationType::kByNameAllowNull &&
|
2015-10-28 18:46:01 +01:00
|
|
|
iter->second.verification != OptionVerificationType::kDeprecated)) {
|
2016-08-11 23:54:29 +02:00
|
|
|
// Restore "new_options" to the default "base_options".
|
|
|
|
*new_table_options = table_options;
|
2015-10-28 18:46:01 +01:00
|
|
|
return Status::InvalidArgument("Can't parse PlainTableOptions:",
|
|
|
|
o.first + " " + error_message);
|
2015-07-02 01:13:49 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
2015-10-28 18:46:01 +01:00
|
|
|
Status GetPlainTableOptionsFromString(
|
|
|
|
const PlainTableOptions& table_options,
|
|
|
|
const std::string& opts_str,
|
|
|
|
PlainTableOptions* new_table_options) {
|
|
|
|
std::unordered_map<std::string, std::string> opts_map;
|
|
|
|
Status s = StringToMap(opts_str, &opts_map);
|
|
|
|
if (!s.ok()) {
|
|
|
|
return s;
|
|
|
|
}
|
2015-11-16 21:56:21 +01:00
|
|
|
return GetPlainTableOptionsFromMap(table_options, opts_map,
|
2015-10-28 18:46:01 +01:00
|
|
|
new_table_options);
|
|
|
|
}
|
|
|
|
|
2015-11-17 23:29:01 +01:00
|
|
|
Status GetMemTableRepFactoryFromString(const std::string& opts_str,
|
|
|
|
std::unique_ptr<MemTableRepFactory>* new_mem_factory) {
|
|
|
|
std::vector<std::string> opts_list = StringSplit(opts_str, ':');
|
|
|
|
size_t len = opts_list.size();
|
|
|
|
|
|
|
|
if (opts_list.size() <= 0 || opts_list.size() > 2) {
|
|
|
|
return Status::InvalidArgument("Can't parse memtable_factory option ",
|
|
|
|
opts_str);
|
|
|
|
}
|
|
|
|
|
|
|
|
MemTableRepFactory* mem_factory = nullptr;
|
|
|
|
|
|
|
|
if (opts_list[0] == "skip_list") {
|
|
|
|
// Expecting format
|
|
|
|
// skip_list:<lookahead>
|
|
|
|
if (2 == len) {
|
|
|
|
size_t lookahead = ParseSizeT(opts_list[1]);
|
|
|
|
mem_factory = new SkipListFactory(lookahead);
|
|
|
|
} else if (1 == len) {
|
|
|
|
mem_factory = new SkipListFactory();
|
|
|
|
}
|
|
|
|
} else if (opts_list[0] == "prefix_hash") {
|
|
|
|
// Expecting format
|
|
|
|
// prfix_hash:<hash_bucket_count>
|
|
|
|
if (2 == len) {
|
|
|
|
size_t hash_bucket_count = ParseSizeT(opts_list[1]);
|
|
|
|
mem_factory = NewHashSkipListRepFactory(hash_bucket_count);
|
|
|
|
} else if (1 == len) {
|
|
|
|
mem_factory = NewHashSkipListRepFactory();
|
|
|
|
}
|
|
|
|
} else if (opts_list[0] == "hash_linkedlist") {
|
|
|
|
// Expecting format
|
|
|
|
// hash_linkedlist:<hash_bucket_count>
|
|
|
|
if (2 == len) {
|
|
|
|
size_t hash_bucket_count = ParseSizeT(opts_list[1]);
|
|
|
|
mem_factory = NewHashLinkListRepFactory(hash_bucket_count);
|
|
|
|
} else if (1 == len) {
|
|
|
|
mem_factory = NewHashLinkListRepFactory();
|
|
|
|
}
|
|
|
|
} else if (opts_list[0] == "vector") {
|
|
|
|
// Expecting format
|
|
|
|
// vector:<count>
|
|
|
|
if (2 == len) {
|
|
|
|
size_t count = ParseSizeT(opts_list[1]);
|
|
|
|
mem_factory = new VectorRepFactory(count);
|
|
|
|
} else if (1 == len) {
|
|
|
|
mem_factory = new VectorRepFactory();
|
|
|
|
}
|
|
|
|
} else if (opts_list[0] == "cuckoo") {
|
|
|
|
// Expecting format
|
|
|
|
// cuckoo:<write_buffer_size>
|
|
|
|
if (2 == len) {
|
|
|
|
size_t write_buffer_size = ParseSizeT(opts_list[1]);
|
|
|
|
mem_factory= NewHashCuckooRepFactory(write_buffer_size);
|
|
|
|
} else if (1 == len) {
|
|
|
|
return Status::InvalidArgument("Can't parse memtable_factory option ",
|
|
|
|
opts_str);
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
return Status::InvalidArgument("Unrecognized memtable_factory option ",
|
|
|
|
opts_str);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (mem_factory != nullptr){
|
|
|
|
new_mem_factory->reset(mem_factory);
|
|
|
|
}
|
|
|
|
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
2014-12-22 22:18:57 +01:00
|
|
|
Status GetColumnFamilyOptionsFromMap(
|
2014-10-10 19:00:12 +02:00
|
|
|
const ColumnFamilyOptions& base_options,
|
|
|
|
const std::unordered_map<std::string, std::string>& opts_map,
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
ColumnFamilyOptions* new_options, bool input_strings_escaped) {
|
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
|
|
|
return GetColumnFamilyOptionsFromMapInternal(
|
|
|
|
base_options, opts_map, new_options, input_strings_escaped);
|
|
|
|
}
|
|
|
|
|
|
|
|
Status GetColumnFamilyOptionsFromMapInternal(
|
|
|
|
const ColumnFamilyOptions& base_options,
|
|
|
|
const std::unordered_map<std::string, std::string>& opts_map,
|
|
|
|
ColumnFamilyOptions* new_options, bool input_strings_escaped,
|
|
|
|
std::vector<std::string>* unsupported_options_names) {
|
2014-09-17 21:46:32 +02:00
|
|
|
assert(new_options);
|
|
|
|
*new_options = 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
|
|
|
if (unsupported_options_names) {
|
|
|
|
unsupported_options_names->clear();
|
|
|
|
}
|
2014-10-10 19:00:12 +02:00
|
|
|
for (const auto& o : opts_map) {
|
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
|
|
|
auto s = ParseColumnFamilyOption(o.first, o.second, new_options,
|
|
|
|
input_strings_escaped);
|
|
|
|
if (!s.ok()) {
|
|
|
|
if (s.IsNotSupported()) {
|
|
|
|
// If the deserialization of the specified option is not supported
|
|
|
|
// and an output vector of unsupported_options is provided, then
|
|
|
|
// we log the name of the unsupported option and proceed.
|
|
|
|
if (unsupported_options_names != nullptr) {
|
|
|
|
unsupported_options_names->push_back(o.first);
|
|
|
|
}
|
|
|
|
// Note that we still return Status::OK in such case to maintain
|
|
|
|
// the backward compatibility in the old public API defined in
|
|
|
|
// rocksdb/convenience.h
|
|
|
|
} else {
|
2016-08-11 23:54:29 +02:00
|
|
|
// Restore "new_options" to the default "base_options".
|
|
|
|
*new_options = 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
|
|
|
return s;
|
2015-10-03 00:35:32 +02:00
|
|
|
}
|
2014-10-10 19:00:12 +02:00
|
|
|
}
|
|
|
|
}
|
2014-12-22 22:18:57 +01:00
|
|
|
return Status::OK();
|
2014-10-10 19:00:12 +02:00
|
|
|
}
|
|
|
|
|
2014-12-22 22:18:57 +01:00
|
|
|
Status GetColumnFamilyOptionsFromString(
|
2014-10-10 19:00:12 +02:00
|
|
|
const ColumnFamilyOptions& base_options,
|
|
|
|
const std::string& opts_str,
|
|
|
|
ColumnFamilyOptions* new_options) {
|
|
|
|
std::unordered_map<std::string, std::string> opts_map;
|
2014-12-22 22:18:57 +01:00
|
|
|
Status s = StringToMap(opts_str, &opts_map);
|
|
|
|
if (!s.ok()) {
|
2016-08-11 23:54:29 +02:00
|
|
|
*new_options = base_options;
|
2014-12-22 22:18:57 +01:00
|
|
|
return s;
|
2014-10-10 19:00:12 +02:00
|
|
|
}
|
|
|
|
return GetColumnFamilyOptionsFromMap(base_options, opts_map, new_options);
|
|
|
|
}
|
|
|
|
|
2014-12-22 22:18:57 +01:00
|
|
|
Status GetDBOptionsFromMap(
|
2014-10-10 19:00:12 +02:00
|
|
|
const DBOptions& base_options,
|
|
|
|
const std::unordered_map<std::string, std::string>& opts_map,
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
DBOptions* new_options, bool input_strings_escaped) {
|
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
|
|
|
return GetDBOptionsFromMapInternal(
|
|
|
|
base_options, opts_map, new_options, input_strings_escaped);
|
|
|
|
}
|
|
|
|
|
|
|
|
Status GetDBOptionsFromMapInternal(
|
|
|
|
const DBOptions& base_options,
|
|
|
|
const std::unordered_map<std::string, std::string>& opts_map,
|
|
|
|
DBOptions* new_options, bool input_strings_escaped,
|
|
|
|
std::vector<std::string>* unsupported_options_names) {
|
2014-10-10 19:00:12 +02:00
|
|
|
assert(new_options);
|
|
|
|
*new_options = 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
|
|
|
if (unsupported_options_names) {
|
|
|
|
unsupported_options_names->clear();
|
|
|
|
}
|
2014-10-10 19:00:12 +02:00
|
|
|
for (const auto& o : opts_map) {
|
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
|
|
|
auto s = ParseDBOption(o.first, o.second,
|
|
|
|
new_options, input_strings_escaped);
|
|
|
|
if (!s.ok()) {
|
|
|
|
if (s.IsNotSupported()) {
|
|
|
|
// If the deserialization of the specified option is not supported
|
|
|
|
// and an output vector of unsupported_options is provided, then
|
|
|
|
// we log the name of the unsupported option and proceed.
|
|
|
|
if (unsupported_options_names != nullptr) {
|
|
|
|
unsupported_options_names->push_back(o.first);
|
|
|
|
}
|
|
|
|
// Note that we still return Status::OK in such case to maintain
|
|
|
|
// the backward compatibility in the old public API defined in
|
|
|
|
// rocksdb/convenience.h
|
|
|
|
} else {
|
2016-08-11 23:54:29 +02:00
|
|
|
// Restore "new_options" to the default "base_options".
|
|
|
|
*new_options = 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
|
|
|
return s;
|
|
|
|
}
|
2014-09-17 21:46:32 +02:00
|
|
|
}
|
|
|
|
}
|
2014-12-22 22:18:57 +01:00
|
|
|
return Status::OK();
|
2014-09-17 21:46:32 +02:00
|
|
|
}
|
|
|
|
|
2014-12-22 22:18:57 +01:00
|
|
|
Status GetDBOptionsFromString(
|
2014-10-10 19:00:12 +02:00
|
|
|
const DBOptions& base_options,
|
|
|
|
const std::string& opts_str,
|
|
|
|
DBOptions* new_options) {
|
|
|
|
std::unordered_map<std::string, std::string> opts_map;
|
2014-12-22 22:18:57 +01:00
|
|
|
Status s = StringToMap(opts_str, &opts_map);
|
|
|
|
if (!s.ok()) {
|
2016-08-11 23:54:29 +02:00
|
|
|
*new_options = base_options;
|
2014-12-22 22:18:57 +01:00
|
|
|
return s;
|
2014-10-10 19:00:12 +02:00
|
|
|
}
|
|
|
|
return GetDBOptionsFromMap(base_options, opts_map, new_options);
|
|
|
|
}
|
|
|
|
|
2015-02-20 04:11:14 +01:00
|
|
|
Status GetOptionsFromString(const Options& base_options,
|
|
|
|
const std::string& opts_str, Options* new_options) {
|
|
|
|
std::unordered_map<std::string, std::string> opts_map;
|
|
|
|
Status s = StringToMap(opts_str, &opts_map);
|
|
|
|
if (!s.ok()) {
|
|
|
|
return s;
|
|
|
|
}
|
|
|
|
DBOptions new_db_options(base_options);
|
|
|
|
ColumnFamilyOptions new_cf_options(base_options);
|
|
|
|
for (const auto& o : opts_map) {
|
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
|
|
|
if (ParseDBOption(o.first, o.second, &new_db_options).ok()) {
|
|
|
|
} else if (ParseColumnFamilyOption(
|
|
|
|
o.first, o.second, &new_cf_options).ok()) {
|
2015-02-20 04:11:14 +01:00
|
|
|
} else {
|
|
|
|
return Status::InvalidArgument("Can't parse option " + o.first);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
*new_options = Options(new_db_options, new_cf_options);
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
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,
|
|
|
|
std::shared_ptr<TableFactory>* table_factory) {
|
|
|
|
Status s;
|
|
|
|
if (factory_name == BlockBasedTableFactory().Name()) {
|
|
|
|
BlockBasedTableOptions bbt_opt;
|
|
|
|
s = GetBlockBasedTableOptionsFromMap(BlockBasedTableOptions(), opt_map,
|
|
|
|
&bbt_opt, true);
|
|
|
|
if (!s.ok()) {
|
|
|
|
return s;
|
|
|
|
}
|
|
|
|
table_factory->reset(new BlockBasedTableFactory(bbt_opt));
|
|
|
|
return Status::OK();
|
2015-10-28 18:46:01 +01:00
|
|
|
} else if (factory_name == PlainTableFactory().Name()) {
|
|
|
|
PlainTableOptions pt_opt;
|
2015-11-16 21:56:21 +01:00
|
|
|
s = GetPlainTableOptionsFromMap(PlainTableOptions(), opt_map, &pt_opt,
|
|
|
|
true);
|
2015-10-28 18:46:01 +01:00
|
|
|
if (!s.ok()) {
|
|
|
|
return s;
|
|
|
|
}
|
|
|
|
table_factory->reset(new PlainTableFactory(pt_opt));
|
|
|
|
return Status::OK();
|
2015-10-11 21:17:42 +02:00
|
|
|
}
|
|
|
|
// Return OK for not supported table factories as TableFactory
|
|
|
|
// Deserialization is optional.
|
|
|
|
table_factory->reset();
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
2015-09-29 23:42:40 +02:00
|
|
|
#endif // !ROCKSDB_LITE
|
2016-09-15 07:10:28 +02:00
|
|
|
|
2014-09-17 21:46:32 +02:00
|
|
|
} // namespace rocksdb
|