Struct DB

pub struct DB { /* private fields */ }

A RocksDB database.

See crate level documentation for a simple usage example.

Implementations

impl DB

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 snapshot(&self) -> Snapshot<'_>

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 GetColumnFamilys for DB

fn get_cfs(&self) -> &BTreeMap<String, ColumnFamily>

fn get_mut_cfs(&mut self) -> &mut BTreeMap<String, ColumnFamily>

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

Return the underlying column family handle.

impl Handle<rocksdb_t> for DB

fn handle(&self) -> *mut rocksdb_t

impl Iterate for DB

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

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

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

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

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

Opens an interator 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.

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

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

impl IterateCF for DB

fn get_raw_iter_cf<'a: 'b, 'b>( &'a self, cf_handle: &ColumnFamily, readopts: &ReadOptions, ) -> Result<DBRawIterator<'b>, Error>

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

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

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

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

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

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

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

impl Open for DB

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

Open a database with default options.

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

Open the database with the specified options.

fn open_with_descriptor<P: AsRef<Path>>( opts: &Options, path: P, descriptor: Self::Descriptor, ) -> Result<Self, Error>

impl OpenCF for DB

fn open_cf<P, I, N>(opts: &Options, path: P, cfs: I) -> Result<Self, Error>

where P: AsRef<Path>, I: IntoIterator<Item = N>, N: AsRef<str>,

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

fn open_cf_descriptors<P, I>( opts: &Options, path: P, cfs: I, ) -> Result<Self, Error>

where P: AsRef<Path>, I: IntoIterator<Item = ColumnFamilyDescriptor>,

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

fn open_cf_descriptors_with_descriptor<P, I>( opts: &Options, path: P, cfs: I, descriptor: Self::Descriptor, ) -> Result<Self, Error>

where P: AsRef<Path>, I: IntoIterator<Item = ColumnFamilyDescriptor>,

impl Read for DB

impl Send for DB

impl Sync for DB

impl Write for DB