Crate mz_rocksdb

source ·
Expand description

An async wrapper around RocksDB, that does IO on a separate thread.

This crate offers a limited API to communicate with RocksDB, to get the best performance possible (most importantly, by batching operations). Currently this API is only upsert, which replaces (or deletes) values for a set of keys, and returns the previous values.

Re-exports

Modules

  • config
    This module handles converting mz_rocksdb_types into rocksdb types.
  • defaults
    The following are defaults (and default strings for LD parameters) for RocksDBTuningParameters.

Structs

  • GetResult
    The result type for individual gets.
  • InstanceOptions
    Fixed options to configure a RocksDBInstance. These are not tuning parameters, see the config modules for tuning. These are generally fixed within the binary.
  • MultiGetResult
    The result type for multi_get.
  • MultiPutResult
    The result type for multi_put.
  • RocksDBInstance
    An async wrapper around RocksDB.
  • RocksDBInstanceMetrics
    Worker metrics about an instances usage of RocksDB. User-provided so the user can choose the labels.
  • RocksDBSharedMetrics
    Shared metrics about an instances usage of RocksDB. User-provided so the user can choose the labels.
  • RocksDBTuningParameters
    A set of parameters to tune RocksDB. This struct is plain-old-data, and is used to update RocksDBConfig, which contains some dynamic value for some parameters.

Enums

  • Error
    An error using this RocksDB wrapper.