Struct DBMap

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

An interface to a rocksDB database, keyed by a columnfamily

Fields

db: Arc<Database>

opts: ReadWriteOptions

Implementations

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

pub fn reopen( db: &Arc<Database>, 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 typed_store::rocks::*;
   use typed_store::metrics::DBMetrics;
   use tempfile::tempdir;
   use prometheus::Registry;
   use std::sync::Arc;
   use core::fmt::Error;
   #[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 cf_name(&self) -> &str

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 checkpoint_db(&self, path: &Path) -> Result<(), TypedStoreError>

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

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

pub fn reversed_safe_iter_with_bounds( &self, lower_bound: Option<K>, upper_bound: Option<K>, ) -> Result<DbIterator<'_, (K, V)>, TypedStoreError>

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

Creates a safe reversed iterator with optional bounds. Both upper bound and lower bound are included.

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 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 overriden in the config), so please use this function with caution

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

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 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) -> DbIterator<'a, (K, V)>

Same as iter but performs status check.

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

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

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