mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
abaf26266d
Summary: Some changes to PlainTable format: (1) support variable key length (2) use user defined slice transformer to extract prefixes (3) Run some test cases against PlainTable in db_test and table_test Test Plan: test db_test Reviewers: haobo, kailiu CC: dhruba, igor, leveldb, nkg- Differential Revision: https://reviews.facebook.net/D14457
108 lines
3.9 KiB
C++
108 lines
3.9 KiB
C++
// Copyright (c) 2013, 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.
|
|
#pragma once
|
|
|
|
#include <string>
|
|
#include <unordered_map>
|
|
|
|
#include "rocksdb/status.h"
|
|
|
|
namespace rocksdb {
|
|
|
|
// Other than basic table properties, each table may also have the user
|
|
// collected properties.
|
|
// The value of the user-collected properties are encoded as raw bytes --
|
|
// users have to interprete these values by themselves.
|
|
typedef
|
|
std::unordered_map<std::string, std::string>
|
|
UserCollectedProperties;
|
|
|
|
// TableProperties contains a bunch of read-only properties of its associated
|
|
// table.
|
|
struct TableProperties {
|
|
public:
|
|
// the total size of all data blocks.
|
|
uint64_t data_size = 0;
|
|
// the size of index block.
|
|
uint64_t index_size = 0;
|
|
// the size of filter block.
|
|
uint64_t filter_size = 0;
|
|
// total raw key size
|
|
uint64_t raw_key_size = 0;
|
|
// total raw value size
|
|
uint64_t raw_value_size = 0;
|
|
// the number of blocks in this table
|
|
uint64_t num_data_blocks = 0;
|
|
// the number of entries in this table
|
|
uint64_t num_entries = 0;
|
|
// format version, reserved for backward compatibility
|
|
uint64_t format_version = 0;
|
|
// If 0, key is variable length. Otherwise number of bytes for each key.
|
|
uint64_t fixed_key_len = 0;
|
|
|
|
// The name of the filter policy used in this table.
|
|
// If no filter policy is used, `filter_policy_name` will be an empty string.
|
|
std::string filter_policy_name;
|
|
|
|
// user collected properties
|
|
UserCollectedProperties user_collected_properties;
|
|
|
|
// convert this object to a human readable form
|
|
// @prop_delim: delimiter for each property.
|
|
std::string ToString(
|
|
const std::string& prop_delim = "; ",
|
|
const std::string& kv_delim = "=") const;
|
|
};
|
|
|
|
// table properties' human-readable names in the property block.
|
|
struct TablePropertiesNames {
|
|
static const std::string kDataSize;
|
|
static const std::string kIndexSize;
|
|
static const std::string kFilterSize;
|
|
static const std::string kRawKeySize;
|
|
static const std::string kRawValueSize;
|
|
static const std::string kNumDataBlocks;
|
|
static const std::string kNumEntries;
|
|
static const std::string kFormatVersion;
|
|
static const std::string kFixedKeyLen;
|
|
static const std::string kFilterPolicy;
|
|
};
|
|
|
|
extern const std::string kPropertiesBlock;
|
|
|
|
// `TablePropertiesCollector` provides the mechanism for users to collect
|
|
// their own interested properties. This class is essentially a collection
|
|
// of callback functions that will be invoked during table building.
|
|
class TablePropertiesCollector {
|
|
public:
|
|
virtual ~TablePropertiesCollector() { }
|
|
|
|
// Add() will be called when a new key/value pair is inserted into the table.
|
|
// @params key the original key that is inserted into the table.
|
|
// @params value the original value that is inserted into the table.
|
|
virtual Status Add(const Slice& key, const Slice& value) = 0;
|
|
|
|
// Finish() will be called when a table has already been built and is ready
|
|
// for writing the properties block.
|
|
// @params properties User will add their collected statistics to
|
|
// `properties`.
|
|
virtual Status Finish(UserCollectedProperties* properties) = 0;
|
|
|
|
// The name of the properties collector can be used for debugging purpose.
|
|
virtual const char* Name() const = 0;
|
|
|
|
// Return the human-readable properties, where the key is property name and
|
|
// the value is the human-readable form of value.
|
|
virtual UserCollectedProperties GetReadableProperties() const = 0;
|
|
};
|
|
|
|
// Extra properties
|
|
// Below is a list of non-basic properties that are collected by database
|
|
// itself. Especially some properties regarding to the internal keys (which
|
|
// is unknown to `table`).
|
|
extern uint64_t GetDeletedKeys(const UserCollectedProperties& props);
|
|
|
|
} // namespace rocksdb
|