Struct emerald_rocksdb::DB

pub struct DB { /* fields omitted */ }

A RocksDB database.

See crate level documentation for a simple usage example.

Methods

impl DB

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

Open a database with default options.

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

Open the database with the specified options.

pub fn open_cf<P: AsRef<Path>>(
    opts: &Options,
    path: P,
    cfs: &[&str]
) -> Result<DB, Error>

Open 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_descriptors<P: AsRef<Path>>(
    opts: &Options,
    path: P,
    cfs: Vec<ColumnFamilyDescriptor>
) -> Result<DB, Error>

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

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 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(
    &self,
    key: &[u8],
    readopts: &ReadOptions
) -> Result<Option<DBVector>, Error>

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

Return the bytes associated with a key value

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

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

pub fn create_cf(
    &mut self,
    name: &str,
    opts: &Options
) -> Result<ColumnFamily, 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.

Important traits for DBIterator

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

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

Important traits for DBIterator

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

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

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

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

pub fn raw_iterator(&self) -> DBRawIterator

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

pub fn snapshot(&self) -> Snapshot

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Send for DB

impl Sync for DB

impl Drop for DB

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for DB

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

Formats the value using the given formatter.