d150e01474
Summary:
This is a new API added to db.h to allow for fetching all merge operands associated with a Key. The main motivation for this API is to support use cases where doing a full online merge is not necessary as it is performance sensitive. Example use-cases:
1. Update subset of columns and read subset of columns -
Imagine a SQL Table, a row is encoded as a K/V pair (as it is done in MyRocks). If there are many columns and users only updated one of them, we can use merge operator to reduce write amplification. While users only read one or two columns in the read query, this feature can avoid a full merging of the whole row, and save some CPU.
2. Updating very few attributes in a value which is a JSON-like document -
Updating one attribute can be done efficiently using merge operator, while reading back one attribute can be done more efficiently if we don't need to do a full merge.
----------------------------------------------------------------------------------------------------
API :
Status GetMergeOperands(
const ReadOptions& options, ColumnFamilyHandle* column_family,
const Slice& key, PinnableSlice* merge_operands,
GetMergeOperandsOptions* get_merge_operands_options,
int* number_of_operands)
Example usage :
int size = 100;
int number_of_operands = 0;
std::vector<PinnableSlice> values(size);
GetMergeOperandsOptions merge_operands_info;
db_->GetMergeOperands(ReadOptions(), db_->DefaultColumnFamily(), "k1", values.data(), merge_operands_info, &number_of_operands);
Description :
Returns all the merge operands corresponding to the key. If the number of merge operands in DB is greater than merge_operands_options.expected_max_number_of_operands no merge operands are returned and status is Incomplete. Merge operands returned are in the order of insertion.
merge_operands-> Points to an array of at-least merge_operands_options.expected_max_number_of_operands and the caller is responsible for allocating it. If the status returned is Incomplete then number_of_operands will contain the total number of merge operands found in DB for key.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/5604
Test Plan:
Added unit test and perf test in db_bench that can be run using the command:
./db_bench -benchmarks=getmergeoperands --merge_operator=sortlist
Differential Revision: D16657366
Pulled By: vjnadimpalli
fbshipit-source-id: 0faadd752351745224ee12d4ae9ef3cb529951bf
56 lines
2.0 KiB
C++
56 lines
2.0 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).
|
|
//
|
|
#pragma once
|
|
#include "rocksdb/merge_operator.h"
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
namespace rocksdb {
|
|
|
|
class MergeOperators {
|
|
public:
|
|
static std::shared_ptr<MergeOperator> CreatePutOperator();
|
|
static std::shared_ptr<MergeOperator> CreateDeprecatedPutOperator();
|
|
static std::shared_ptr<MergeOperator> CreateUInt64AddOperator();
|
|
static std::shared_ptr<MergeOperator> CreateStringAppendOperator();
|
|
static std::shared_ptr<MergeOperator> CreateStringAppendOperator(char delim_char);
|
|
static std::shared_ptr<MergeOperator> CreateStringAppendTESTOperator();
|
|
static std::shared_ptr<MergeOperator> CreateMaxOperator();
|
|
static std::shared_ptr<MergeOperator> CreateBytesXOROperator();
|
|
static std::shared_ptr<MergeOperator> CreateSortOperator();
|
|
|
|
// Will return a different merge operator depending on the string.
|
|
// TODO: Hook the "name" up to the actual Name() of the MergeOperators?
|
|
static std::shared_ptr<MergeOperator> CreateFromStringId(
|
|
const std::string& name) {
|
|
if (name == "put") {
|
|
return CreatePutOperator();
|
|
} else if (name == "put_v1") {
|
|
return CreateDeprecatedPutOperator();
|
|
} else if ( name == "uint64add") {
|
|
return CreateUInt64AddOperator();
|
|
} else if (name == "stringappend") {
|
|
return CreateStringAppendOperator();
|
|
} else if (name == "stringappendtest") {
|
|
return CreateStringAppendTESTOperator();
|
|
} else if (name == "max") {
|
|
return CreateMaxOperator();
|
|
} else if (name == "bytesxor") {
|
|
return CreateBytesXOROperator();
|
|
} else if (name == "sortlist") {
|
|
return CreateSortOperator();
|
|
} else {
|
|
// Empty or unknown, just return nullptr
|
|
return nullptr;
|
|
}
|
|
}
|
|
};
|
|
|
|
} // namespace rocksdb
|