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, skip_metrics_reporting: 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.

When skip_metrics_reporting is true, no periodic per-column-family metrics task is spawned; use this for deprecated tables and for large sets of rarely-touched column families.

pub fn cf_name(&self) -> &str

pub fn batch(&self) -> DBBatch

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

Flush the memtable of this table’s column family to SST files on disk.

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

Flush the memtables of every column family of the database to SST files on disk.

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 safe_iter_with_prefix<P>(&self, prefix: &P) -> DbIterator<'_, (K, V)>

where P: ?Sized + Serialize, K: DeserializeOwned, V: DeserializeOwned,

Forward iterator over every entry whose key begins with prefix.

prefix is serialized with be_fix_int_ser and must form a prefix of the column family’s key encoding — typically the leading field(s) of a tuple key. This avoids constructing artificial maximum keys to bound a composite-key scan.

pub fn safe_iter_with_prefix_from<P, C>( &self, prefix: &P, lower: Bound<&C>, ) -> DbIterator<'_, (K, V)>

where P: ?Sized + Serialize, C: ?Sized + Serialize, K: DeserializeOwned, V: DeserializeOwned,

Forward iterator over entries whose key begins with prefix, starting at the position lower gives within the prefix rather than at the first key under the prefix.

The bound value is not a full key: it is the entire remainder of the key that follows prefix (all the trailing fields of a tuple key, not a partial suffix). Both prefix and the bound value are serialized with be_fix_int_ser and concatenated, mirroring how a composite key is encoded. Included starts the scan at prefix ++ lower, Excluded strictly after that position (also when no such key exists), and Unbounded at the first key under the prefix. The scan bounds never leave the prefix (excluding the maximum remainder yields an empty scan, not the next prefix’s keys), so a paginated scan can resume from a cursor without an artificial maximum key for the upper bound.

pub fn safe_iter_with_prefix_after<P, C>( &self, prefix: &P, cursor: Option<&C>, ) -> DbIterator<'_, (K, V)>

where P: ?Sized + Serialize, C: ?Sized + Serialize, K: DeserializeOwned, V: DeserializeOwned,

Forward iterator over entries whose key begins with prefix, resuming strictly after cursor, or from the first key under the prefix when there is no cursor. cursor is the remainder of the key after prefix, as for Self::safe_iter_with_prefix_from.

pub fn safe_iter_with_prefix_reversed<P>( &self, prefix: &P, ) -> DbIterator<'_, (K, V)>

where P: ?Sized + Serialize, K: DeserializeOwned, V: DeserializeOwned,

Reverse counterpart of Self::safe_iter_with_prefix: the matching entries in descending key order (e.g. for “latest entry under a prefix”).

Trait Implementations

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

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

Returns a duplicate 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 schedule_delete_all(&self) -> Result<(), TypedStoreError>

Writes a range delete tombstone to delete all entries in the db map. The effect of this write is visible immediately, i.e. you won’t see old values when you do a lookup or scan.

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

Both directions derive their bounds from the same iterator_bounds_with_range, so they are guaranteed to cover the identical set of keys regardless of the bound inclusivity.

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

Iterates over all entries in key order.

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

Iterates over the half-open key range [lower_bound, upper_bound) — the lower bound is inclusive, the upper bound exclusive, and a None bound leaves that side unbounded. Equivalent to safe_range_iter(lower_bound..upper_bound).

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

Iterates over the keys within range, honoring the range’s own bound inclusivity (e.g. lo..hi excludes hi, lo..=hi includes it).