Struct ckb_rocksdb::DB

pub struct DB { /* fields omitted */ }

A RocksDB database.

See crate level documentation for a simple usage example.

Methods

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(&self, readopts: &ReadOptions) -> DBRawIterator

Important traits for DBIterator<'a>

impl<'a> Iterator for DBIterator<'a> type Item = (Box<[u8]>, Box<[u8]>);

fn get_iter(&self, readopts: &ReadOptions, mode: IteratorMode) -> DBIterator

Important traits for DBIterator<'a>

impl<'a> Iterator for DBIterator<'a> type Item = (Box<[u8]>, Box<[u8]>);

fn iterator_opt(&self, mode: IteratorMode, readopts: &ReadOptions) -> DBIterator

Important traits for DBIterator<'a>

impl<'a> Iterator for DBIterator<'a> type Item = (Box<[u8]>, Box<[u8]>);

fn iterator(&self, mode: IteratorMode) -> DBIterator

Important traits for DBIterator<'a>

impl<'a> Iterator for DBIterator<'a> type Item = (Box<[u8]>, Box<[u8]>);

fn full_iterator(&self, mode: IteratorMode) -> DBIterator

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.

Important traits for DBIterator<'a>

impl<'a> Iterator for DBIterator<'a> type Item = (Box<[u8]>, Box<[u8]>);

fn prefix_iterator(&self, prefix: &[u8]) -> DBIterator

fn raw_iterator(&self) -> DBRawIterator

impl IterateCF for DB

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

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

fn iterator_cf_opt(
    &self,
    cf_handle: &ColumnFamily,
    mode: IteratorMode,
    readopts: &ReadOptions
) -> Result<DBIterator, 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(
    &self,
    cf_handle: &ColumnFamily,
    mode: IteratorMode
) -> Result<DBIterator, Error>

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

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

fn raw_iterator_cf(
    &self,
    cf_handle: &ColumnFamily
) -> Result<DBRawIterator, 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