Struct DBMap

pub struct DBMap<K, V> {
    pub rocksdb: Arc<RocksDB>,
    pub opts: ReadWriteOptions,
    /* private fields */
}

An interface to a rocksDB database, keyed by a columnfamily

Fields

rocksdb: Arc<RocksDB>

opts: ReadWriteOptions

Implementations

impl<K, V> DBMap<K, V>

pub fn open<P: AsRef<Path>>( path: P, metric_conf: MetricConf, db_options: Option<Options>, opt_cf: Option<&str>, rw_options: &ReadWriteOptions, ) -> Result<Self, TypedStoreError>

Opens a database from a path, with specific options and an optional column family.

This database is used to perform operations on single column family, and parametrizes all operations in DBBatch when writing across column families.

pub fn reopen( db: &Arc<RocksDB>, opt_cf: Option<&str>, rw_options: &ReadWriteOptions, is_deprecated: bool, ) -> Result<Self, TypedStoreError>

Reopens an open database as a typed map operating under a specific column family. if no column family is passed, the default column family is used.

use core::fmt::Error;
use std::sync::Arc;

use prometheus::Registry;
use tempfile::tempdir;
use typed_store::{metrics::DBMetrics, rocks::*};
#[tokio::main]
async fn main() -> Result<(), Error> {
    /// Open the DB with all needed column families first.
    let rocks = open_cf(
        tempdir().unwrap(),
        None,
        MetricConf::default(),
        &["First_CF", "Second_CF"],
    )
    .unwrap();
    /// Attach the column families to specific maps.
    let db_cf_1 = DBMap::<u32, u32>::reopen(
        &rocks,
        Some("First_CF"),
        &ReadWriteOptions::default(),
        false,
    )
    .expect("Failed to open storage");
    let db_cf_2 = DBMap::<u32, u32>::reopen(
        &rocks,
        Some("Second_CF"),
        &ReadWriteOptions::default(),
        false,
    )
    .expect("Failed to open storage");
    Ok(())
}

pub fn batch(&self) -> DBBatch

pub fn compact_range<J: Serialize>( &self, start: &J, end: &J, ) -> Result<(), TypedStoreError>

pub fn compact_range_raw( &self, cf_name: &str, start: Vec<u8>, end: Vec<u8>, ) -> Result<(), TypedStoreError>

pub fn compact_range_to_bottom<J: Serialize>( &self, start: &J, end: &J, ) -> Result<(), TypedStoreError>

pub fn cf(&self) -> Arc<BoundColumnFamily<'_>>

pub fn iterator_cf(&self) -> RocksDBIter<'_>

pub fn flush(&self) -> Result<(), TypedStoreError>

pub fn set_options(&self, opts: &[(&str, &str)]) -> Result<(), Error>

pub fn transaction(&self) -> Result<DBTransaction<'_>, TypedStoreError>

pub fn transaction_without_snapshot( &self, ) -> Result<DBTransaction<'_>, TypedStoreError>

pub fn checkpoint_db(&self, path: &Path) -> Result<(), TypedStoreError>

pub fn snapshot(&self) -> Result<RocksDBSnapshot<'_>, TypedStoreError>

pub fn table_summary(&self) -> Result<TableSummary>

Trait Implementations

impl<K: Clone, V: Clone> Clone for DBMap<K, V>

fn clone(&self) -> DBMap<K, V>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for DBMap<K, V>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, K, V> Map<'a, K, V> for DBMap<K, V>

where K: Serialize + DeserializeOwned, V: Serialize + DeserializeOwned,

fn delete_file_in_range(&self, from: &K, to: &K) -> Result<(), TypedStoreError>

Deletes a range of keys between from (inclusive) and to (non-inclusive) by immediately deleting any sst files whose key range overlaps with the range. Files whose range only partially overlaps with the range are not deleted. This can be useful for quickly removing a large amount of data without having to delete individual keys. Only files at level 1 or higher are considered ( Level 0 files are skipped). It doesn’t guarantee that all keys in the range are deleted, as there might be keys in files that weren’t entirely within the range.

fn unsafe_clear(&self) -> Result<(), TypedStoreError>

This method first drops the existing column family and then creates a new one with the same name. The two operations are not atomic and hence it is possible to get into a race condition where the column family has been dropped but new one is not created yet

fn schedule_delete_all(&self) -> Result<(), TypedStoreError>

Writes a range delete tombstone to delete all entries in the db map If the DBMap is configured with ignore_range_deletions set to false, the effect of this write will be visible immediately i.e. you won’t see old values when you do a lookup or scan. But if it is configured with ignore_range_deletions set to true, the old value are visible until compaction actually deletes them which will happen sometime after. By default ignore_range_deletions is set to true on a DBMap (unless it is overridden in the config), so please use this function with caution

fn unbounded_iter(&'a self) -> Self::Iterator

Returns an unbounded iterator visiting each key-value pair in the map. This is potentially unsafe as it can perform a full table scan

fn iter_with_bounds( &'a self, lower_bound: Option<K>, upper_bound: Option<K>, ) -> Self::Iterator

Returns an iterator visiting each key-value pair in the map. By proving bounds of the scan range, RocksDB scan avoid unnecessary scans. Lower bound is inclusive, while upper bound is exclusive.

fn range_iter(&'a self, range: impl RangeBounds<K>) -> Self::Iterator

Similar to iter_with_bounds but allows specifying inclusivity/exclusivity of ranges explicitly. TODO: find better name

fn multi_get_raw_bytes<J>( &self, keys: impl IntoIterator<Item = J>, ) -> Result<Vec<Option<Vec<u8>>>, TypedStoreError>

where J: Borrow<K>,

Returns a vector of raw values corresponding to the keys provided.

fn multi_get<J>( &self, keys: impl IntoIterator<Item = J>, ) -> Result<Vec<Option<V>>, TypedStoreError>

where J: Borrow<K>,

Returns a vector of values corresponding to the keys provided.

fn chunked_multi_get<J>( &self, keys: impl IntoIterator<Item = J>, chunk_size: usize, ) -> Result<Vec<Option<V>>, TypedStoreError>

where J: Borrow<K>,

Returns a vector of values corresponding to the keys provided.

fn multi_insert<J, U>( &self, key_val_pairs: impl IntoIterator<Item = (J, U)>, ) -> Result<(), Self::Error>

where J: Borrow<K>, U: Borrow<V>,

Convenience method for batch insertion

fn multi_remove<J>( &self, keys: impl IntoIterator<Item = J>, ) -> Result<(), Self::Error>

where J: Borrow<K>,

Convenience method for batch removal

fn try_catch_up_with_primary(&self) -> Result<(), Self::Error>

Try to catch up with primary when running as secondary

type Error = TypedStoreError

type Iterator = Iter<'a, K, V>

type SafeIterator = SafeIter<'a, K, V>

type Keys = Keys<'a, K>

type Values = Values<'a, V>

fn contains_key(&self, key: &K) -> Result<bool, TypedStoreError>

Returns true if the map contains a value for the specified key.

fn multi_contains_keys<J>( &self, keys: impl IntoIterator<Item = J>, ) -> Result<Vec<bool>, Self::Error>

where J: Borrow<K>,

Returns true if the map contains a value for the specified key.

fn get(&self, key: &K) -> Result<Option<V>, TypedStoreError>

Returns the value for the given key from the map, if it exists.

fn get_raw_bytes(&self, key: &K) -> Result<Option<Vec<u8>>, TypedStoreError>

Returns the raw value (serialized bytes) for the given key from the map, if it exists.

fn insert(&self, key: &K, value: &V) -> Result<(), TypedStoreError>

Inserts the given key-value pair into the map.

fn remove(&self, key: &K) -> Result<(), TypedStoreError>

Removes the entry for the given key from the map.

fn is_empty(&self) -> bool

Returns true if the map is empty, otherwise false.

fn safe_iter(&'a self) -> Self::SafeIterator

Same as iter but performs status check.

fn safe_iter_with_bounds( &'a self, lower_bound: Option<K>, upper_bound: Option<K>, ) -> Self::SafeIterator

fn safe_range_iter(&'a self, range: impl RangeBounds<K>) -> Self::SafeIterator

fn keys(&'a self) -> Self::Keys

Returns an iterator over each key in the map.

fn values(&'a self) -> Self::Values

Returns an iterator over each value in the map.

impl<J, K, U, V> TryExtend<(J, U)> for DBMap<K, V>

where J: Borrow<K>, U: Borrow<V>, K: Serialize, V: Serialize,

type Error = TypedStoreError

Error type.

fn try_extend<T>(&mut self, iter: &mut T) -> Result<(), Self::Error>

where T: Iterator<Item = (J, U)>,

Try to extend the collection from the given iterator.

fn try_extend_from_slice(&mut self, slice: &[(J, U)]) -> Result<(), Self::Error>

Try to extend the collection from the given slice.

impl<K: Send, V: Send> Send for DBMap<K, V>