Struct RocksDBInstance

pub struct RocksDBInstance<K, V> {
    pub(crate) tx: Sender<Command<K, V>>,
    pub(crate) multi_get_scratch: Vec<K>,
    pub(crate) multi_get_results_scratch: Vec<Option<GetResult<V>>>,
    pub(crate) multi_update_scratch: Vec<(K, KeyUpdate<V>, Option<Overflowing<i64>>)>,
    pub(crate) dynamic_config: RocksDBDynamicConfig,
    pub supports_merges: bool,
}

An async wrapper around RocksDB.

Fields

tx: Sender<Command<K, V>>

multi_get_scratch: Vec<K>

multi_get_results_scratch: Vec<Option<GetResult<V>>>

multi_update_scratch: Vec<(K, KeyUpdate<V>, Option<Overflowing<i64>>)>

dynamic_config: RocksDBDynamicConfig

supports_merges: bool

Whether this instance supports merge operations (whether a merge operator was set at creation time)

Implementations

impl<K, V> RocksDBInstance<K, V>

where K: AsRef<[u8]> + Send + Sync + 'static, V: Serialize + DeserializeOwned + Send + Sync + 'static,

pub fn new<M, O, IM, F>( instance_path: &Path, options: InstanceOptions<O, V, F>, tuning_config: RocksDBConfig, shared_metrics: M, instance_metrics: IM, ) -> Result<Self, Error>

where O: Options + Copy + Send + Sync + 'static, M: Deref<Target = RocksDBSharedMetrics> + Send + 'static, IM: Deref<Target = RocksDBInstanceMetrics> + Send + 'static, F: for<'a> Fn(&'a [u8], ValueIterator<'a, O, V>) -> V + Copy + Send + Sync + 'static,

Start a new RocksDB instance at the path, using the Options and RocksDBTuningParameters to configure the instance.

metrics is a set of metric types that this type will keep up to date. enc_opts is the bincode options used to serialize and deserialize the keys and values.

pub async fn multi_get<'r, G, R, Ret, Placement>( &mut self, gets: G, results_out: R, placement: Placement, ) -> Result<MultiGetResult, Error>

where G: IntoIterator<Item = K>, R: IntoIterator<Item = &'r mut Ret>, Ret: 'r, Placement: Fn(Option<GetResult<V>>) -> Ret,

For each unique key in gets, place the stored value (if any) in results_out.

Panics if gets and results_out are not the same length.

pub(crate) async fn multi_get_inner<'r, G, R, Ret, Placement>( &mut self, gets: G, results_out: R, placement: &Placement, ) -> Result<MultiGetResult, Error>

where G: IntoIterator<Item = K>, R: IntoIterator<Item = &'r mut Ret>, Ret: 'r, Placement: Fn(Option<GetResult<V>>) -> Ret,

pub async fn multi_update<P>( &mut self, puts: P, ) -> Result<MultiUpdateResult, Error>

where P: IntoIterator<Item = (K, KeyUpdate<V>, Option<Overflowing<i64>>)>,

For each key in puts, store the given value, or delete it if the value is None. If the same key appears multiple times, the last value for the key wins. The third item in each tuple is an optional diff multiplier that when present, will be multiplied by the size of the encoded value written to the database and summed into the MultiUpdateResult::size_diff field.

pub(crate) async fn multi_update_inner<P>( &mut self, updates: P, ) -> Result<MultiUpdateResult, Error>

where P: IntoIterator<Item = (K, KeyUpdate<V>, Option<Overflowing<i64>>)>,

pub async fn manual_compaction(&self) -> Result<(), Error>

Trigger manual compaction of the RocksDB instance.

pub async fn close(self) -> Result<(), Error>

Gracefully shut down RocksDB. Can error if the instance is already shut down or errored.