YugabyteDB (2.13.1.0-b60, 21121d69985fbf76aa6958d8f04a9bfa936293b5)

// Copyright (c) 2011 The LevelDB Authors. All rights reserved.

// Use of this source code is governed by a BSD-style license that can be

// found in the LICENSE file. See the AUTHORS file for names of contributors.

//

// The following only applies to changes made to this file as part of YugaByte development.

//

// Portions Copyright (c) YugaByte, Inc.

//

// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except

// in compliance with the License.  You may obtain a copy of the License at

//

// http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software distributed under the License

// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express

// or implied.  See the License for the specific language governing permissions and limitations

// under the License.

//

#ifndef YB_ROCKSDB_TABLE_PROPERTIES_H

#define YB_ROCKSDB_TABLE_PROPERTIES_H

#pragma once

#include <stdint.h>

#include <string>

#include <map>

#include "yb/rocksdb/status.h"

#include "yb/util/slice.h"

#include "yb/rocksdb/types.h"

namespace rocksdb {

// -- Table Properties

// 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 interpret these values by themselves.

// Note: To do prefix seek/scan in `UserCollectedProperties`, you can do

// something similar to:

//

// UserCollectedProperties props = ...;

// for (auto pos = props.lower_bound(prefix);

//      pos != props.end() && pos->first.compare(0, prefix.size(), prefix) == 0;

//      ++pos) {

//   ...

// }

typedef std::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 data index block.

  uint64_t data_index_size = 0;

  // the size of filter block.

  uint64_t filter_size = 0;

  // the size of filter index block.

  uint64_t filter_index_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;

  // the number of filter blocks

  uint64_t num_filter_blocks = 0;

  // the number of data index blocks

  uint64_t num_data_index_blocks = 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;

  UserCollectedProperties readable_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;

  // Aggregate the numerical member variables of the specified

  // TableProperties.

  void Add(const TableProperties& tp);

};

// table properties' human-readable names in the property block.

struct TablePropertiesNames {

  static const std::string kDataSize;

  static const std::string kDataIndexSize;

  static const std::string kFilterSize;

  static const std::string kFilterIndexSize;

  static const std::string kRawKeySize;

  static const std::string kRawValueSize;

  static const std::string kNumDataBlocks;

  static const std::string kNumEntries;

  static const std::string kNumFilterBlocks;

  static const std::string kNumDataIndexBlocks;

  static const std::string kFormatVersion;

  static const std::string kFixedKeyLen;

  static const std::string kFilterPolicy;

};

extern const std::string kPropertiesBlock;

enum EntryType {

  kEntryPut,

  kEntryDelete,

  kEntrySingleDelete,

  kEntryMerge,

  kEntryOther,

};

// `TablePropertiesCollector` provides the mechanism for users to collect

// their own properties that they are interested in. This class is essentially

// a collection of callback functions that will be invoked during table

// building. It is construced with TablePropertiesCollectorFactory. The methods

// don't need to be thread-safe, as we will create exactly one

// TablePropertiesCollector object per table and then call it sequentially

class TablePropertiesCollector {

 public:

  virtual ~TablePropertiesCollector() {}

  // DEPRECATE User defined collector should implement AddUserKey(), though

  //           this old function still works for backward compatible reason.

  // Add() will be called when a new key/value pair is inserted into the table.

  // @params key    the user key that is inserted into the table.

  // @params value  the value that is inserted into the table.

  virtual Status Add(const Slice& /*key*/, const Slice& /*value*/) {

    return STATUS(InvalidArgument, "TablePropertiesCollector::Add() deprecated.");

  }

Unexecuted instantiation: rocksdb::TablePropertiesCollector::Add(yb::Slice const&, yb::Slice const&)

Unexecuted instantiation: rocksdb::TablePropertiesCollector::Add(yb::Slice const&, yb::Slice const&)

  // AddUserKey() will be called when a new key/value pair is inserted into the

  // table.

  // @params key    the user key that is inserted into the table.

  // @params value  the value that is inserted into the table.

  virtual Status AddUserKey(const Slice& key, const Slice& value,

                            EntryType /*type*/, SequenceNumber /*seq*/,

                            uint64_t /*file_size*/) {

    // For backwards-compatibility.

    return Add(key, value);

  }

  // 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;

  // 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;

  // The name of the properties collector can be used for debugging purpose.

  virtual const char* Name() const = 0;

  // EXPERIMENTAL Return whether the output file should be further compacted

  virtual bool NeedCompact() const { return false; }

};

// Constructs TablePropertiesCollector. Internals create a new

// TablePropertiesCollector for each new table

class TablePropertiesCollectorFactory {

 public:

  struct Context {

    uint32_t column_family_id;

    static const uint32_t kUnknownColumnFamily;

  };

  virtual ~TablePropertiesCollectorFactory() {}

  // has to be thread-safe

  virtual TablePropertiesCollector* CreateTablePropertiesCollector(

      TablePropertiesCollectorFactory::Context context) = 0;

  // The name of the properties collector can be used for debugging purpose.

  virtual const char* Name() 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

#endif // YB_ROCKSDB_TABLE_PROPERTIES_H