Summary: - Introduced an include/ file dedicated to db-related debug functions to avoid making db.h more complex - Added debugging function, `GetAllKeyVersions()`, to return a listing of internal data for a range of user keys. The new `struct KeyVersion` exposes data similar to internal key without exposing any internal type. - Migrated the "ldb idump" subcommand to use this function - The API takes an inclusive-exclusive range to match behavior of "ldb idump". This will be quite annoying for users who want to query a single user key's versions :(. Closes https://github.com/facebook/rocksdb/pull/2232 Differential Revision: D4976007 Pulled By: ajkr fbshipit-source-id: cab375da53a7595d6575af2b7e3b776aa3ad793emain
parent
1a60982a5a
commit
3fa9a39c68
@ -0,0 +1,41 @@ |
||||
// Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
|
||||
// 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.
|
||||
// This source code is also licensed under the GPLv2 license found in the
|
||||
// COPYING file in the root directory of this source tree.
|
||||
|
||||
#pragma once |
||||
|
||||
#ifndef ROCKSDB_LITE |
||||
|
||||
#include "rocksdb/db.h" |
||||
#include "rocksdb/types.h" |
||||
|
||||
namespace rocksdb { |
||||
|
||||
// Data associated with a particular version of a key. A database may internally
|
||||
// store multiple versions of a same user key due to snapshots, compaction not
|
||||
// happening yet, etc.
|
||||
struct KeyVersion { |
||||
KeyVersion(const std::string& _user_key, const std::string& _value, |
||||
SequenceNumber _sequence, int _type) |
||||
: user_key(_user_key), value(_value), sequence(_sequence), type(_type) {} |
||||
|
||||
std::string user_key; |
||||
std::string value; |
||||
SequenceNumber sequence; |
||||
// TODO(ajkr): we should provide a helper function that converts the int to a
|
||||
// string describing the type for easier debugging.
|
||||
int type; |
||||
}; |
||||
|
||||
// Returns listing of all versions of keys in the provided user key range.
|
||||
// The range is inclusive-inclusive, i.e., [`begin_key`, `end_key`].
|
||||
// The result is inserted into the provided vector, `key_versions`.
|
||||
Status GetAllKeyVersions(DB* db, Slice begin_key, Slice end_key, |
||||
std::vector<KeyVersion>* key_versions); |
||||
|
||||
} // namespace rocksdb
|
||||
|
||||
#endif // ROCKSDB_LITE
|
@ -0,0 +1,57 @@ |
||||
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
||||
// 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.
|
||||
// This source code is also licensed under the GPLv2 license found in the
|
||||
// COPYING file in the root directory of this source tree.
|
||||
|
||||
#ifndef ROCKSDB_LITE |
||||
|
||||
#include "rocksdb/utilities/debug.h" |
||||
|
||||
#include "db/db_impl.h" |
||||
|
||||
namespace rocksdb { |
||||
|
||||
Status GetAllKeyVersions(DB* db, Slice begin_key, Slice end_key, |
||||
std::vector<KeyVersion>* key_versions) { |
||||
assert(key_versions != nullptr); |
||||
key_versions->clear(); |
||||
|
||||
DBImpl* idb = static_cast<DBImpl*>(db->GetRootDB()); |
||||
auto icmp = InternalKeyComparator(idb->GetOptions().comparator); |
||||
RangeDelAggregator range_del_agg(icmp, {} /* snapshots */); |
||||
Arena arena; |
||||
ScopedArenaIterator iter(idb->NewInternalIterator(&arena, &range_del_agg)); |
||||
|
||||
if (!begin_key.empty()) { |
||||
InternalKey ikey; |
||||
ikey.SetMaxPossibleForUserKey(begin_key); |
||||
iter->Seek(ikey.Encode()); |
||||
} else { |
||||
iter->SeekToFirst(); |
||||
} |
||||
|
||||
for (; iter->Valid(); iter->Next()) { |
||||
ParsedInternalKey ikey; |
||||
if (!ParseInternalKey(iter->key(), &ikey)) { |
||||
return Status::Corruption("Internal Key [" + iter->key().ToString() + |
||||
"] parse error!"); |
||||
} |
||||
|
||||
if (!end_key.empty() && |
||||
icmp.user_comparator()->Compare(ikey.user_key, end_key) > 0) { |
||||
break; |
||||
} |
||||
|
||||
key_versions->emplace_back(ikey.user_key.ToString() /* _user_key */, |
||||
iter->value().ToString() /* _value */, |
||||
ikey.sequence /* _sequence */, |
||||
static_cast<int>(ikey.type) /* _type */); |
||||
} |
||||
return Status::OK(); |
||||
} |
||||
|
||||
} // namespace rocksdb
|
||||
|
||||
#endif // ROCKSDB_LITE
|
Loading…
Reference in new issue