Struct InstanceOptions

pub struct InstanceOptions<O, V, F> {
    pub cleanup_on_new: bool,
    pub cleanup_tries: usize,
    pub use_wal: bool,
    pub env: Env,
    pub bincode: O,
    pub merge_operator: Option<(String, F)>,
    pub(crate) v: PhantomData<V>,
}

Fixed options to configure a RocksDBInstance. These are not tuning parameters, see the config modules for tuning. These are generally fixed within the binary.

Fields

cleanup_on_new: bool

Whether or not to clear state at the instance path before starting.

cleanup_tries: usize

If cleanup_on_new, how many times to try.

use_wal: bool

Whether or not to write writes to the wal. This is not in RocksDBTuningParameters because it applies to WriteOptions when creating WriteBatches.

env: Env

A possibly shared RocksDB Env.

bincode: O

The bincode options to use for serializing and deserializing values.

merge_operator: Option<(String, F)>

A merge operator to use for associative merges, if any. The first item is the name of the operator to store in RocksDB for compatibility checks, and the second is the merge function.

v: PhantomData<V>

Implementations

impl<O, V, F> InstanceOptions<O, V, F>

where O: Options + Copy + Send + Sync + 'static, V: DeserializeOwned + Serialize + Send + Sync + 'static, F: for<'a> Fn(&'a [u8], ValueIterator<'a, O, V>) -> V + Copy + Send + Sync + 'static,

pub fn new( env: Env, cleanup_tries: usize, merge_operator: Option<(String, F)>, bincode: O, ) -> Self

A new Options object with reasonable defaults.

pub(crate) fn as_rocksdb_options( &self, tuning_config: &RocksDBConfig, ) -> (RocksDBOptions, Option<WriteBufferManagerHandle>)

pub(crate) fn as_rocksdb_write_options(&self) -> WriteOptions