Type Definition rocksdb::OptimisticTransactionDB

pub type OptimisticTransactionDB<T = SingleThreaded> = DBCommon<T, OptimisticTransactionDBInner>;

A type alias to RocksDB Optimistic Transaction DB.

Please read the official guide to learn more about RocksDB OptimisticTransactionDB.

The default thread mode for OptimisticTransactionDB is SingleThreaded if feature multi-threaded-cf is not enabled.

See DBCommon for full list of methods.

Examples

use rocksdb::{DB, Options, OptimisticTransactionDB, SingleThreaded};
let path = "_path_for_optimistic_transaction_db";
{
    let db: OptimisticTransactionDB = OptimisticTransactionDB::open_default(path).unwrap();
    db.put(b"my key", b"my value").unwrap();
     
    // create transaction
    let txn = db.transaction();
    txn.put(b"key2", b"value2");
    txn.put(b"key3", b"value3");
    txn.commit().unwrap();
}
let _ = DB::destroy(&Options::default(), path);

Implementations

impl<T: ThreadMode> OptimisticTransactionDB<T>

Methods of OptimisticTransactionDB.

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

Opens a database with default options.

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

Opens the database with the specified options.

pub 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>, 

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_descriptors<P, I>(
    opts: &Options,
    path: P,
    cfs: I
) -> Result<Self, Error> where
    P: AsRef<Path>,
    I: IntoIterator<Item = ColumnFamilyDescriptor>, 

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

pub fn transaction(&self) -> Transaction<'_, Self>

Creates a transaction with default options.

pub fn transaction_opt(
    &self,
    writeopts: &WriteOptions,
    otxn_opts: &OptimisticTransactionOptions
) -> Transaction<'_, Self>

Creates a transaction with default options.

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

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

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