### Performance Improvements
* Try to avoid updating DBOptions if `SetDBOptions()` does not change any option value.
+### Behavior Changes
+* `StringAppendOperator` additionally accepts a string as the delimiter.
+
## 6.23.0 (2021-07-16)
### Behavior Changes
* Obsolete keys in the bottommost level that were preserved for a snapshot will now be cleaned upon snapshot release in all cases. This form of compaction (snapshot release triggered compaction) previously had an artificial limitation that multiple tombstones needed to be present.
* Method: newSharedStringAppendOperator
* Signature: (C)J
*/
-jlong Java_org_rocksdb_StringAppendOperator_newSharedStringAppendOperator(
+jlong Java_org_rocksdb_StringAppendOperator_newSharedStringAppendOperator__C(
JNIEnv* /*env*/, jclass /*jclazz*/, jchar jdelim) {
auto* sptr_string_append_op =
new std::shared_ptr<ROCKSDB_NAMESPACE::MergeOperator>(
return reinterpret_cast<jlong>(sptr_string_append_op);
}
+jlong Java_org_rocksdb_StringAppendOperator_newSharedStringAppendOperator__Ljava_lang_String_2(
+ JNIEnv* env, jclass /*jclass*/, jstring jdelim) {
+ jboolean has_exception = JNI_FALSE;
+ auto delim =
+ ROCKSDB_NAMESPACE::JniUtil::copyStdString(env, jdelim, &has_exception);
+ if (has_exception == JNI_TRUE) {
+ return 0;
+ }
+ auto* sptr_string_append_op =
+ new std::shared_ptr<ROCKSDB_NAMESPACE::MergeOperator>(
+ ROCKSDB_NAMESPACE::MergeOperators::CreateStringAppendOperator(delim));
+ return reinterpret_cast<jlong>(sptr_string_append_op);
+}
+
/*
* Class: org_rocksdb_StringAppendOperator
* Method: disposeInternal
super(newSharedStringAppendOperator(delim));
}
+ public StringAppendOperator(String delim) {
+ super(newSharedStringAppendOperator(delim));
+ }
+
private native static long newSharedStringAppendOperator(final char delim);
+ private native static long newSharedStringAppendOperator(final String delim);
@Override protected final native void disposeInternal(final long handle);
}
}
}
+ @Test
+ public void emptyStringAsStringAppendDelimiter() throws RocksDBException {
+ try (final StringAppendOperator stringAppendOperator = new StringAppendOperator("");
+ final Options opt =
+ new Options().setCreateIfMissing(true).setMergeOperator(stringAppendOperator);
+ final RocksDB db = RocksDB.open(opt, dbFolder.getRoot().getAbsolutePath())) {
+ db.put("key".getBytes(), "aa".getBytes());
+ db.merge("key".getBytes(), "bb".getBytes());
+ final byte[] value = db.get("key".getBytes());
+ assertThat(new String(value)).isEqualTo("aabb");
+ }
+ }
+
+ @Test
+ public void multiCharStringAsStringAppendDelimiter() throws RocksDBException {
+ try (final StringAppendOperator stringAppendOperator = new StringAppendOperator("<>");
+ final Options opt =
+ new Options().setCreateIfMissing(true).setMergeOperator(stringAppendOperator);
+ final RocksDB db = RocksDB.open(opt, dbFolder.getRoot().getAbsolutePath())) {
+ db.put("key".getBytes(), "aa".getBytes());
+ db.merge("key".getBytes(), "bb".getBytes());
+ final byte[] value = db.get("key".getBytes());
+ assertThat(new String(value)).isEqualTo("aa<>bb");
+ }
+ }
+
@Test
public void emptyStringInSetMergeOperatorByName() {
try (final Options opt = new Options()
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> CreateStringAppendOperator(
+ const std::string& delim);
static std::shared_ptr<MergeOperator> CreateStringAppendTESTOperator();
static std::shared_ptr<MergeOperator> CreateMaxOperator();
static std::shared_ptr<MergeOperator> CreateBytesXOROperator();
// Constructor: also specify the delimiter character.
StringAppendOperator::StringAppendOperator(char delim_char)
- : delim_(delim_char) {
-}
+ : delim_(1, delim_char) {}
+
+StringAppendOperator::StringAppendOperator(const std::string& delim)
+ : delim_(delim) {}
// Implementation for the merge operation (concatenates two strings)
bool StringAppendOperator::Merge(const Slice& /*key*/,
} else {
// Generic append (existing_value != null).
// Reserve *new_value to correct size, and apply concatenation.
- new_value->reserve(existing_value->size() + 1 + value.size());
- new_value->assign(existing_value->data(),existing_value->size());
- new_value->append(1,delim_);
+ new_value->reserve(existing_value->size() + delim_.size() + value.size());
+ new_value->assign(existing_value->data(), existing_value->size());
+ new_value->append(delim_);
new_value->append(value.data(), value.size());
}
return std::make_shared<StringAppendOperator>(delim_char);
}
+std::shared_ptr<MergeOperator> MergeOperators::CreateStringAppendOperator(
+ const std::string& delim) {
+ return std::make_shared<StringAppendOperator>(delim);
+}
+
} // namespace ROCKSDB_NAMESPACE
public:
// Constructor: specify delimiter
explicit StringAppendOperator(char delim_char);
+ explicit StringAppendOperator(const std::string& delim);
virtual bool Merge(const Slice& key,
const Slice* existing_value,
virtual const char* Name() const override;
private:
- char delim_; // The delimiter is inserted between elements
-
+ std::string delim_; // The delimiter is inserted between elements
};
} // namespace ROCKSDB_NAMESPACE
// Constructor: also specify the delimiter character.
StringAppendTESTOperator::StringAppendTESTOperator(char delim_char)
- : delim_(delim_char) {
-}
+ : delim_(1, delim_char) {}
+
+StringAppendTESTOperator::StringAppendTESTOperator(const std::string& delim)
+ : delim_(delim) {}
// Implementation for the merge operation (concatenates two strings)
bool StringAppendTESTOperator::FullMergeV2(
size_t numBytes = 0;
for (auto it = merge_in.operand_list.begin();
it != merge_in.operand_list.end(); ++it) {
- numBytes += it->size() + 1; // Plus 1 for the delimiter
+ numBytes += it->size() + delim_.size();
}
// Only print the delimiter after the first entry has been printed
merge_in.existing_value->size());
printDelim = true;
} else if (numBytes) {
- merge_out->new_value.reserve(
- numBytes - 1); // Minus 1 since we have one less delimiter
+ // Without the existing (initial) value, the delimiter before the first of
+ // subsequent operands becomes redundant.
+ merge_out->new_value.reserve(numBytes - delim_.size());
}
// Concatenate the sequence of strings (and add a delimiter between each)
for (auto it = merge_in.operand_list.begin();
it != merge_in.operand_list.end(); ++it) {
if (printDelim) {
- merge_out->new_value.append(1, delim_);
+ merge_out->new_value.append(delim_);
}
merge_out->new_value.append(it->data(), it->size());
printDelim = true;
for (const auto& operand : operand_list) {
size += operand.size();
}
- size += operand_list.size() - 1; // Delimiters
+ size += (operand_list.size() - 1) * delim_.length(); // Delimiters
new_value->reserve(size);
// Apply concatenation
for (std::deque<Slice>::const_iterator it = operand_list.begin() + 1;
it != operand_list.end(); ++it) {
- new_value->append(1, delim_);
+ new_value->append(delim_);
new_value->append(it->data(), it->size());
}
public:
// Constructor with delimiter
explicit StringAppendTESTOperator(char delim_char);
+ explicit StringAppendTESTOperator(const std::string& delim);
virtual bool FullMergeV2(const MergeOperationInput& merge_in,
MergeOperationOutput* merge_out) const override;
const std::deque<Slice>& operand_list,
std::string* new_value, Logger* logger) const;
- char delim_; // The delimiter is inserted between elements
-
+ std::string delim_; // The delimiter is inserted between elements
};
} // namespace ROCKSDB_NAMESPACE
namespace {
// OpenDb opens a (possibly new) rocksdb database with a StringAppendOperator
-std::shared_ptr<DB> OpenNormalDb(char delim_char) {
+std::shared_ptr<DB> OpenNormalDb(const std::string& delim) {
DB* db;
Options options;
options.create_if_missing = true;
- options.merge_operator.reset(new StringAppendOperator(delim_char));
+ MergeOperator* mergeOperator;
+ if (delim.size() == 1) {
+ mergeOperator = new StringAppendOperator(delim[0]);
+ } else {
+ mergeOperator = new StringAppendOperator(delim);
+ }
+ options.merge_operator.reset(mergeOperator);
EXPECT_OK(DB::Open(options, kDbName, &db));
return std::shared_ptr<DB>(db);
}
#ifndef ROCKSDB_LITE // TtlDb is not supported in Lite
// Open a TtlDB with a non-associative StringAppendTESTOperator
-std::shared_ptr<DB> OpenTtlDb(char delim_char) {
+std::shared_ptr<DB> OpenTtlDb(const std::string& delim) {
DBWithTTL* db;
Options options;
options.create_if_missing = true;
- options.merge_operator.reset(new StringAppendTESTOperator(delim_char));
+ MergeOperator* mergeOperator;
+ if (delim.size() == 1) {
+ mergeOperator = new StringAppendTESTOperator(delim[0]);
+ } else {
+ mergeOperator = new StringAppendTESTOperator(delim);
+ }
+ options.merge_operator.reset(mergeOperator);
EXPECT_OK(DBWithTTL::Open(options, kDbName, &db, 123456));
return std::shared_ptr<DB>(db);
}
StringAppendOperatorTest::SetOpenDbFunction(&OpenNormalDb);
}
- typedef std::shared_ptr<DB> (* OpenFuncPtr)(char);
+ typedef std::shared_ptr<DB> (*OpenFuncPtr)(const std::string&);
// Allows user to open databases with different configurations.
// e.g.: Can open a DB or a TtlDB, etc.
// THE TEST CASES BEGIN HERE
TEST_P(StringAppendOperatorTest, IteratorTest) {
- auto db_ = OpenDb(',');
+ auto db_ = OpenDb(",");
StringLists slists(db_);
slists.Append("k1", "v1");
}
TEST_P(StringAppendOperatorTest, SimpleTest) {
- auto db = OpenDb(',');
+ auto db = OpenDb(",");
StringLists slists(db);
slists.Append("k1", "v1");
}
TEST_P(StringAppendOperatorTest, SimpleDelimiterTest) {
- auto db = OpenDb('|');
+ auto db = OpenDb("|");
StringLists slists(db);
slists.Append("k1", "v1");
ASSERT_EQ(res, "v1|v2|v3");
}
+TEST_P(StringAppendOperatorTest, EmptyDelimiterTest) {
+ auto db = OpenDb("");
+ StringLists slists(db);
+
+ slists.Append("k1", "v1");
+ slists.Append("k1", "v2");
+ slists.Append("k1", "v3");
+
+ std::string res;
+ ASSERT_TRUE(slists.Get("k1", &res));
+ ASSERT_EQ(res, "v1v2v3");
+}
+
+TEST_P(StringAppendOperatorTest, MultiCharDelimiterTest) {
+ auto db = OpenDb("<>");
+ StringLists slists(db);
+
+ slists.Append("k1", "v1");
+ slists.Append("k1", "v2");
+ slists.Append("k1", "v3");
+
+ std::string res;
+ ASSERT_TRUE(slists.Get("k1", &res));
+ ASSERT_EQ(res, "v1<>v2<>v3");
+}
+
+TEST_P(StringAppendOperatorTest, DelimiterIsDefensivelyCopiedTest) {
+ std::string delimiter = "<>";
+ auto db = OpenDb(delimiter);
+ StringLists slists(db);
+
+ slists.Append("k1", "v1");
+ slists.Append("k1", "v2");
+ delimiter.clear();
+ slists.Append("k1", "v3");
+
+ std::string res;
+ ASSERT_TRUE(slists.Get("k1", &res));
+ ASSERT_EQ(res, "v1<>v2<>v3");
+}
+
TEST_P(StringAppendOperatorTest, OneValueNoDelimiterTest) {
- auto db = OpenDb('!');
+ auto db = OpenDb("!");
StringLists slists(db);
slists.Append("random_key", "single_val");
}
TEST_P(StringAppendOperatorTest, VariousKeys) {
- auto db = OpenDb('\n');
+ auto db = OpenDb("\n");
StringLists slists(db);
slists.Append("c", "asdasd");
// Generate semi random keys/words from a small distribution.
TEST_P(StringAppendOperatorTest, RandomMixGetAppend) {
- auto db = OpenDb(' ');
+ auto db = OpenDb(" ");
StringLists slists(db);
// Generate a list of random keys and values
}
TEST_P(StringAppendOperatorTest, BIGRandomMixGetAppend) {
- auto db = OpenDb(' ');
+ auto db = OpenDb(" ");
StringLists slists(db);
// Generate a list of random keys and values
TEST_P(StringAppendOperatorTest, PersistentVariousKeys) {
// Perform the following operations in limited scope
{
- auto db = OpenDb('\n');
+ auto db = OpenDb("\n");
StringLists slists(db);
slists.Append("c", "asdasd");
// Reopen the database (the previous changes should persist / be remembered)
{
- auto db = OpenDb('\n');
+ auto db = OpenDb("\n");
StringLists slists(db);
slists.Append("c", "bbnagnagsx");
// Reopen the database (the previous changes should persist / be remembered)
{
- auto db = OpenDb('\n');
+ auto db = OpenDb("\n");
StringLists slists(db);
// All changes should be on disk. This will test VersionSet Get()
TEST_P(StringAppendOperatorTest, PersistentFlushAndCompaction) {
// Perform the following operations in limited scope
{
- auto db = OpenDb('\n');
+ auto db = OpenDb("\n");
StringLists slists(db);
std::string a, b, c;
// Reopen the database (the previous changes should persist / be remembered)
{
- auto db = OpenDb('\n');
+ auto db = OpenDb("\n");
StringLists slists(db);
std::string a, b, c;
}
TEST_P(StringAppendOperatorTest, SimpleTestNullDelimiter) {
- auto db = OpenDb('\0');
+ auto db = OpenDb(std::string(1, '\0'));
StringLists slists(db);
slists.Append("k1", "v1");