Struct rocksdb2::DB

pub struct DB { /* fields omitted */ }

A RocksDB database.

See crate level documentation for a simple usage example.

Methods

impl DB

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

Open a database with default options.

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

Open the database with the specified options.

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

Open a database with specified options and column family.

A column family must be created first by calling DB::create_cf.

Panics

• Panics if the column family doesn't exist.

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

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

fn path(&self) -> &Path

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

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

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

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

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

Return the bytes associated with a key value

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

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

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

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

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

Return the underlying column family handle.

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

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

fn raw_iterator(&self) -> DBRawIterator

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

fn snapshot(&self) -> Snapshot

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

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

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

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

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

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

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

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

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

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

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

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

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

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.