6eb317bb4c
Summary: - By providing the "env" field in any text-based options (i.e., string, map, or file), we can use `NewCustomObject` to deserialize the text value into an actual `Env` object. - Currently factory functions for `Env` registered with object registry should only return pointer to static `Env` objects. That's because `DBOptions::env` is a raw pointer so we cannot easily delegate cleanup. - Note I did not add `env` to `db_option_type_info`. It wasn't needed for (de)serialization, and I believe we don't want to do verification on `env`, even by checking name. That's because the user should be able to copy their DB from Linux to Windows, change envs, and not see an option verification error. Pull Request resolved: https://github.com/facebook/rocksdb/pull/5237 Differential Revision: D15056360 Pulled By: siying fbshipit-source-id: 4b5f0b83297a5058f8949ec955dbf27d98d73d7e
103 lines
4.2 KiB
C++
103 lines
4.2 KiB
C++
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
|
// This source code is licensed under both the GPLv2 (found in the
|
|
// COPYING file in the root directory) and Apache 2.0 License
|
|
// (found in the LICENSE.Apache file in the root directory).
|
|
|
|
// This file contains utility functions for RocksDB Options.
|
|
#pragma once
|
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "rocksdb/db.h"
|
|
#include "rocksdb/env.h"
|
|
#include "rocksdb/options.h"
|
|
#include "rocksdb/status.h"
|
|
|
|
namespace rocksdb {
|
|
// Constructs the DBOptions and ColumnFamilyDescriptors by loading the
|
|
// latest RocksDB options file stored in the specified rocksdb database.
|
|
//
|
|
// Note that the all the pointer options (except table_factory, which will
|
|
// be described in more details below) will be initialized with the default
|
|
// values. Developers can further initialize them after this function call.
|
|
// Below is an example list of pointer options which will be initialized
|
|
//
|
|
// * env
|
|
// * memtable_factory
|
|
// * compaction_filter_factory
|
|
// * prefix_extractor
|
|
// * comparator
|
|
// * merge_operator
|
|
// * compaction_filter
|
|
//
|
|
// User can also choose to load customized comparator, env, and/or
|
|
// merge_operator through object registry:
|
|
// * comparator needs to be registered through Registrar<const Comparator>
|
|
// * env needs to be registered through Registrar<Env>
|
|
// * merge operator needs to be registered through
|
|
// Registrar<std::shared_ptr<MergeOperator>>.
|
|
//
|
|
// For table_factory, this function further supports deserializing
|
|
// BlockBasedTableFactory and its BlockBasedTableOptions except the
|
|
// pointer options of BlockBasedTableOptions (flush_block_policy_factory,
|
|
// block_cache, and block_cache_compressed), which will be initialized with
|
|
// default values. Developers can further specify these three options by
|
|
// casting the return value of TableFactoroy::GetOptions() to
|
|
// BlockBasedTableOptions and making necessary changes.
|
|
//
|
|
// ignore_unknown_options can be set to true if you want to ignore options
|
|
// that are from a newer version of the db, esentially for forward
|
|
// compatibility.
|
|
//
|
|
// examples/options_file_example.cc demonstrates how to use this function
|
|
// to open a RocksDB instance.
|
|
//
|
|
// @return the function returns an OK status when it went successfully. If
|
|
// the specified "dbpath" does not contain any option file, then a
|
|
// Status::NotFound will be returned. A return value other than
|
|
// Status::OK or Status::NotFound indicates there're some error related
|
|
// to the options file itself.
|
|
//
|
|
// @see LoadOptionsFromFile
|
|
Status LoadLatestOptions(const std::string& dbpath, Env* env,
|
|
DBOptions* db_options,
|
|
std::vector<ColumnFamilyDescriptor>* cf_descs,
|
|
bool ignore_unknown_options = false,
|
|
std::shared_ptr<Cache>* cache = {});
|
|
|
|
// Similar to LoadLatestOptions, this function constructs the DBOptions
|
|
// and ColumnFamilyDescriptors based on the specified RocksDB Options file.
|
|
//
|
|
// @see LoadLatestOptions
|
|
Status LoadOptionsFromFile(const std::string& options_file_name, Env* env,
|
|
DBOptions* db_options,
|
|
std::vector<ColumnFamilyDescriptor>* cf_descs,
|
|
bool ignore_unknown_options = false,
|
|
std::shared_ptr<Cache>* cache = {});
|
|
|
|
// Returns the latest options file name under the specified db path.
|
|
Status GetLatestOptionsFileName(const std::string& dbpath, Env* env,
|
|
std::string* options_file_name);
|
|
|
|
// Returns Status::OK if the input DBOptions and ColumnFamilyDescriptors
|
|
// are compatible with the latest options stored in the specified DB path.
|
|
//
|
|
// If the return status is non-ok, it means the specified RocksDB instance
|
|
// might not be correctly opened with the input set of options. Currently,
|
|
// changing one of the following options will fail the compatibility check:
|
|
//
|
|
// * comparator
|
|
// * prefix_extractor
|
|
// * table_factory
|
|
// * merge_operator
|
|
Status CheckOptionsCompatibility(
|
|
const std::string& dbpath, Env* env, const DBOptions& db_options,
|
|
const std::vector<ColumnFamilyDescriptor>& cf_descs,
|
|
bool ignore_unknown_options = false);
|
|
|
|
} // namespace rocksdb
|
|
#endif // !ROCKSDB_LITE
|