Struct rocksdb::DB

pub struct DB { /* fields omitted */ }

A RocksDB database.

See crate level documentation for a simple usage example.

Implementations

impl DB

pub fn open_default<P: AsRef<Path>>(path: P) -> Result<DB, Error>

Opens a database with default options.

pub fn open<P: AsRef<Path>>(opts: &Options, path: P) -> Result<DB, Error>

Opens the database with the specified options.

pub fn open_for_read_only<P: AsRef<Path>>(
    opts: &Options,
    path: P,
    error_if_log_file_exist: bool
) -> Result<DB, Error>

Opens the database for read only with the specified options.

pub fn open_as_secondary<P: AsRef<Path>>(
    opts: &Options,
    primary_path: P,
    secondary_path: P
) -> Result<DB, Error>

Opens the database as a secondary.

pub fn open_with_ttl<P: AsRef<Path>>(
    opts: &Options,
    path: P,
    ttl: Duration
) -> Result<DB, Error>

Opens the database with a Time to Live compaction filter.

pub fn open_cf<P, I, N>(opts: &Options, path: P, cfs: I) -> Result<DB, Error> where
    P: AsRef<Path>,
    I: IntoIterator<Item = N>,
    N: AsRef<str>, 

Opens a database with the given database options and column family names.

Column families opened using this function will be created with default Options.

pub fn open_cf_for_read_only<P, I, N>(
    opts: &Options,
    path: P,
    cfs: I,
    error_if_log_file_exist: bool
) -> Result<DB, Error> where
    P: AsRef<Path>,
    I: IntoIterator<Item = N>,
    N: AsRef<str>, 

Opens a database for read only with the given database options and column family names.

pub fn open_cf_as_secondary<P, I, N>(
    opts: &Options,
    primary_path: P,
    secondary_path: P,
    cfs: I
) -> Result<DB, Error> where
    P: AsRef<Path>,
    I: IntoIterator<Item = N>,
    N: AsRef<str>, 

Opens the database as a secondary with the given database options and column family names.

pub fn open_cf_descriptors<P, I>(
    opts: &Options,
    path: P,
    cfs: I
) -> Result<DB, Error> where
    P: AsRef<Path>,
    I: IntoIterator<Item = ColumnFamilyDescriptor>, 

Opens a database with the given database options and column family descriptors.

pub fn list_cf<P: AsRef<Path>>(
    opts: &Options,
    path: P
) -> Result<Vec<String>, Error>

pub fn destroy<P: AsRef<Path>>(opts: &Options, path: P) -> Result<(), Error>

pub fn repair<P: AsRef<Path>>(opts: &Options, path: P) -> Result<(), Error>

pub fn path(&self) -> &Path

pub fn flush_opt(&self, flushopts: &FlushOptions) -> Result<(), Error>

Flushes database memtables to SST files on the disk.

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

Flushes database memtables to SST files on the disk using default options.

pub fn flush_cf_opt(
    &self,
    cf: &ColumnFamily,
    flushopts: &FlushOptions
) -> Result<(), Error>

Flushes database memtables to SST files on the disk for a given column family.

pub fn flush_cf(&self, cf: &ColumnFamily) -> Result<(), Error>

Flushes database memtables to SST files on the disk for a given column family using default options.

pub fn write_opt(
    &self,
    batch: WriteBatch,
    writeopts: &WriteOptions
) -> Result<(), Error>

pub fn write(&self, batch: WriteBatch) -> Result<(), Error>

pub fn write_without_wal(&self, batch: WriteBatch) -> Result<(), Error>

pub fn get_opt<K: AsRef<[u8]>>(
    &self,
    key: K,
    readopts: &ReadOptions
) -> Result<Option<Vec<u8>>, Error>

Return the bytes associated with a key value with read options. If you only intend to use the vector returned temporarily, consider using get_pinned_opt to avoid unnecessary memory copy.

pub fn get<K: AsRef<[u8]>>(&self, key: K) -> Result<Option<Vec<u8>>, Error>

Return the bytes associated with a key value. If you only intend to use the vector returned temporarily, consider using get_pinned to avoid unnecessary memory copy.

pub fn get_cf_opt<K: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    key: K,
    readopts: &ReadOptions
) -> Result<Option<Vec<u8>>, Error>

Return the bytes associated with a key value and the given column family with read options. If you only intend to use the vector returned temporarily, consider using get_pinned_cf_opt to avoid unnecessary memory.

pub fn get_cf<K: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    key: K
) -> Result<Option<Vec<u8>>, Error>

Return the bytes associated with a key value and the given column family. If you only intend to use the vector returned temporarily, consider using get_pinned_cf to avoid unnecessary memory.

pub fn get_pinned_opt<K: AsRef<[u8]>>(
    &self,
    key: K,
    readopts: &ReadOptions
) -> Result<Option<DBPinnableSlice<'_>>, Error>

Return the value associated with a key using RocksDB’s PinnableSlice so as to avoid unnecessary memory copy.

pub fn get_pinned<K: AsRef<[u8]>>(
    &self,
    key: K
) -> Result<Option<DBPinnableSlice<'_>>, Error>

Return the value associated with a key using RocksDB’s PinnableSlice so as to avoid unnecessary memory copy. Similar to get_pinned_opt but leverages default options.

pub fn get_pinned_cf_opt<K: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    key: K,
    readopts: &ReadOptions
) -> Result<Option<DBPinnableSlice<'_>>, Error>

Return the value associated with a key using RocksDB’s PinnableSlice so as to avoid unnecessary memory copy. Similar to get_pinned_opt but allows specifying ColumnFamily

pub fn get_pinned_cf<K: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    key: K
) -> Result<Option<DBPinnableSlice<'_>>, Error>

Return the value associated with a key using RocksDB’s PinnableSlice so as to avoid unnecessary memory copy. Similar to get_pinned_cf_opt but leverages default options.

pub fn multi_get<K, I>(&self, keys: I) -> Result<Vec<Vec<u8>>, Error> where
    K: AsRef<[u8]>,
    I: IntoIterator<Item = K>, 

Return the values associated with the given keys.

pub fn multi_get_opt<K, I>(
    &self,
    keys: I,
    readopts: &ReadOptions
) -> Result<Vec<Vec<u8>>, Error> where
    K: AsRef<[u8]>,
    I: IntoIterator<Item = K>, 

Return the values associated with the given keys using read options.

pub fn multi_get_cf<'c, K, I>(&self, keys: I) -> Result<Vec<Vec<u8>>, Error> where
    K: AsRef<[u8]>,
    I: IntoIterator<Item = (&'c ColumnFamily, K)>, 

Return the values associated with the given keys and column families.

pub fn multi_get_cf_opt<'c, K, I>(
    &self,
    keys: I,
    readopts: &ReadOptions
) -> Result<Vec<Vec<u8>>, Error> where
    K: AsRef<[u8]>,
    I: IntoIterator<Item = (&'c ColumnFamily, K)>, 

Return the values associated with the given keys and column families using read options.

pub fn create_cf<N: AsRef<str>>(
    &mut self,
    name: N,
    opts: &Options
) -> Result<(), Error>

pub fn drop_cf(&mut self, name: &str) -> Result<(), Error>

pub fn cf_handle(&self, name: &str) -> Option<&ColumnFamily>

Return the underlying column family handle.

pub fn iterator<'a: 'b, 'b>(&'a self, mode: IteratorMode<'_>) -> DBIterator<'b>

pub fn iterator_opt<'a: 'b, 'b>(
    &'a self,
    mode: IteratorMode<'_>,
    readopts: ReadOptions
) -> DBIterator<'b>

pub fn iterator_cf_opt<'a: 'b, 'b>(
    &'a self,
    cf_handle: &ColumnFamily,
    readopts: ReadOptions,
    mode: IteratorMode<'_>
) -> DBIterator<'b>

Opens an iterator using the provided ReadOptions. This is used when you want to iterate over a specific ColumnFamily with a modified ReadOptions

pub fn full_iterator<'a: 'b, 'b>(
    &'a self,
    mode: IteratorMode<'_>
) -> DBIterator<'b>

Opens an iterator with set_total_order_seek enabled. This must be used to iterate across prefixes when set_memtable_factory has been called with a Hash-based implementation.

pub fn prefix_iterator<'a: 'b, 'b, P: AsRef<[u8]>>(
    &'a self,
    prefix: P
) -> DBIterator<'b>

pub fn iterator_cf<'a: 'b, 'b>(
    &'a self,
    cf_handle: &ColumnFamily,
    mode: IteratorMode<'_>
) -> DBIterator<'b>

pub fn full_iterator_cf<'a: 'b, 'b>(
    &'a self,
    cf_handle: &ColumnFamily,
    mode: IteratorMode<'_>
) -> DBIterator<'b>

pub fn prefix_iterator_cf<'a: 'b, 'b, P: AsRef<[u8]>>(
    &'a self,
    cf_handle: &ColumnFamily,
    prefix: P
) -> DBIterator<'b>

pub fn raw_iterator<'a: 'b, 'b>(&'a self) -> DBRawIterator<'b>

Opens a raw iterator over the database, using the default read options

pub fn raw_iterator_cf<'a: 'b, 'b>(
    &'a self,
    cf_handle: &ColumnFamily
) -> DBRawIterator<'b>

Opens a raw iterator over the given column family, using the default read options

pub fn raw_iterator_opt<'a: 'b, 'b>(
    &'a self,
    readopts: ReadOptions
) -> DBRawIterator<'b>

Opens a raw iterator over the database, using the given read options

pub fn raw_iterator_cf_opt<'a: 'b, 'b>(
    &'a self,
    cf_handle: &ColumnFamily,
    readopts: ReadOptions
) -> DBRawIterator<'b>

Opens a raw iterator over the given column family, using the given read options

pub fn snapshot(&self) -> Snapshot<'_>

pub fn put_opt<K, V>(
    &self,
    key: K,
    value: V,
    writeopts: &WriteOptions
) -> Result<(), Error> where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>, 

pub fn put_cf_opt<K, V>(
    &self,
    cf: &ColumnFamily,
    key: K,
    value: V,
    writeopts: &WriteOptions
) -> Result<(), Error> where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>, 

pub fn merge_opt<K, V>(
    &self,
    key: K,
    value: V,
    writeopts: &WriteOptions
) -> Result<(), Error> where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>, 

pub fn merge_cf_opt<K, V>(
    &self,
    cf: &ColumnFamily,
    key: K,
    value: V,
    writeopts: &WriteOptions
) -> Result<(), Error> where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>, 

pub fn delete_opt<K: AsRef<[u8]>>(
    &self,
    key: K,
    writeopts: &WriteOptions
) -> Result<(), Error>

pub fn delete_cf_opt<K: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    key: K,
    writeopts: &WriteOptions
) -> Result<(), Error>

pub fn delete_range_cf_opt<K: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    from: K,
    to: K,
    writeopts: &WriteOptions
) -> Result<(), Error>

Removes the database entries in the range ["from", "to") using given write options.

pub fn put<K, V>(&self, key: K, value: V) -> Result<(), Error> where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>, 

pub fn put_cf<K, V>(
    &self,
    cf: &ColumnFamily,
    key: K,
    value: V
) -> Result<(), Error> where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>, 

pub fn merge<K, V>(&self, key: K, value: V) -> Result<(), Error> where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>, 

pub fn merge_cf<K, V>(
    &self,
    cf: &ColumnFamily,
    key: K,
    value: V
) -> Result<(), Error> where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>, 

pub fn delete<K: AsRef<[u8]>>(&self, key: K) -> Result<(), Error>

pub fn delete_cf<K: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    key: K
) -> Result<(), Error>

pub fn delete_range_cf<K: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    from: K,
    to: K
) -> Result<(), Error>

Removes the database entries in the range ["from", "to") using default write options.

pub fn compact_range<S: AsRef<[u8]>, E: AsRef<[u8]>>(
    &self,
    start: Option<S>,
    end: Option<E>
)

Runs a manual compaction on the Range of keys given. This is not likely to be needed for typical usage.

pub fn compact_range_opt<S: AsRef<[u8]>, E: AsRef<[u8]>>(
    &self,
    start: Option<S>,
    end: Option<E>,
    opts: &CompactOptions
)

Same as compact_range but with custom options.

pub fn compact_range_cf<S: AsRef<[u8]>, E: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    start: Option<S>,
    end: Option<E>
)

Runs a manual compaction on the Range of keys given on the given column family. This is not likely to be needed for typical usage.

pub fn compact_range_cf_opt<S: AsRef<[u8]>, E: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    start: Option<S>,
    end: Option<E>,
    opts: &CompactOptions
)

Same as compact_range_cf but with custom options.

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

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

pub fn property_value(&self, name: &str) -> Result<Option<String>, Error>

Retrieves a RocksDB property by name.

Full list of properties could be find here.

pub fn property_value_cf(
    &self,
    cf: &ColumnFamily,
    name: &str
) -> Result<Option<String>, Error>

Retrieves a RocksDB property by name, for a specific column family.

Full list of properties could be find here.

pub fn property_int_value(&self, name: &str) -> Result<Option<u64>, Error>

Retrieves a RocksDB property and casts it to an integer.

Full list of properties that return int values could be find here.

pub fn property_int_value_cf(
    &self,
    cf: &ColumnFamily,
    name: &str
) -> Result<Option<u64>, Error>

Retrieves a RocksDB property for a specific column family and casts it to an integer.

Full list of properties that return int values could be find here.

pub fn latest_sequence_number(&self) -> u64

The sequence number of the most recent transaction.

pub fn get_updates_since(&self, seq_number: u64) -> Result<DBWALIterator, Error>

Iterate over batches of write operations since a given sequence.

Produce an iterator that will provide the batches of write operations that have occurred since the given sequence (see latest_sequence_number()). Use the provided iterator to retrieve each (u64, WriteBatch) tuple, and then gather the individual puts and deletes using the WriteBatch::iterate() function.

Calling get_updates_since() with a sequence number that is out of bounds will return an error.

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

Tries to catch up with the primary by reading as much as possible from the log files.

pub fn ingest_external_file<P: AsRef<Path>>(
    &self,
    paths: Vec<P>
) -> Result<(), Error>

Loads a list of external SST files created with SstFileWriter into the DB with default opts

pub fn ingest_external_file_opts<P: AsRef<Path>>(
    &self,
    opts: &IngestExternalFileOptions,
    paths: Vec<P>
) -> Result<(), Error>

Loads a list of external SST files created with SstFileWriter into the DB

pub fn ingest_external_file_cf<P: AsRef<Path>>(
    &self,
    cf: &ColumnFamily,
    paths: Vec<P>
) -> Result<(), Error>

Loads a list of external SST files created with SstFileWriter into the DB for given Column Family with default opts

pub fn ingest_external_file_cf_opts<P: AsRef<Path>>(
    &self,
    cf: &ColumnFamily,
    opts: &IngestExternalFileOptions,
    paths: Vec<P>
) -> Result<(), Error>

Loads a list of external SST files created with SstFileWriter into the DB for given Column Family

pub fn live_files(&self) -> Result<Vec<LiveFile>, Error>

Returns a list of all table files with their level, start key and end key

pub fn delete_file_in_range<K: AsRef<[u8]>>(
    &self,
    from: K,
    to: K
) -> Result<(), Error>

Delete sst files whose keys are entirely in the given range.

Could leave some keys in the range which are in files which are not entirely in the range.

Note: L0 files are left regardless of whether they’re in the range.

Snapshots before the delete might not see the data in the given range.

pub fn delete_file_in_range_cf<K: AsRef<[u8]>>(
    &self,
    cf: &ColumnFamily,
    from: K,
    to: K
) -> Result<(), Error>

Same as delete_file_in_range but only for specific column family

pub fn cancel_all_background_work(&self, wait: bool)

Request stopping background work, if wait is true wait until it’s done.

Trait Implementations

impl Debug for DB

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

Formats the value using the given formatter.

impl Drop for DB

fn drop(&mut self)

Executes the destructor for this type.

impl Send for DB

impl Sync for DB