Struct rocksdb::TransactionDB

pub struct TransactionDB<T: ThreadMode = SingleThreaded> { /* private fields */ }

RocksDB TransactionDB.

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

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

use rocksdb::{DB, Options, TransactionDB, SingleThreaded};
let path = "_path_for_transaction_db";
{
    let db: TransactionDB = TransactionDB::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> TransactionDB<T>

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,
    txn_db_opts: &TransactionDBOptions,
    path: P
) -> Result<Self, Error>

Opens the database with the specified options.

pub fn open_cf<P, I, N>(
    opts: &Options,
    txn_db_opts: &TransactionDBOptions,
    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,
    txn_db_opts: &TransactionDBOptions,
    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 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 transaction(&self) -> Transaction<'_, Self>

Creates a transaction with default options.

pub fn transaction_opt<'a>(
    &'a self,
    write_opts: &WriteOptions,
    txn_opts: &TransactionOptions
) -> Transaction<'a, Self>

Creates a transaction with options.

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

Get all prepared transactions for recovery.

This function is expected to call once after open database. User should commit or rollback all transactions before start other transactions.

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

Returns the bytes associated with a key value.

pub fn get_cf<K: AsRef<[u8]>>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K
) -> Result<Option<Vec<u8>>, Error>

Returns the bytes associated with a key value and the given column family.

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

Returns the bytes associated with a key value with read options.

pub fn get_cf_opt<K: AsRef<[u8]>>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K,
    readopts: &ReadOptions
) -> Result<Option<Vec<u8>>, Error>

Returns the bytes associated with a key value and the given column family with read options.

pub fn get_pinned<K: AsRef<[u8]>>(
    &self,
    key: K
) -> Result<Option<DBPinnableSlice<'_>>, Error>

pub fn get_pinned_cf<K: AsRef<[u8]>>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K
) -> Result<Option<DBPinnableSlice<'_>>, Error>

Returns the bytes associated with a key value and the given column family.

pub fn get_pinned_opt<K: AsRef<[u8]>>(
    &self,
    key: K,
    readopts: &ReadOptions
) -> Result<Option<DBPinnableSlice<'_>>, Error>

Returns the bytes associated with a key value with read options.

pub fn get_pinned_cf_opt<K: AsRef<[u8]>>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K,
    readopts: &ReadOptions
) -> Result<Option<DBPinnableSlice<'_>>, Error>

Returns the bytes associated with a key value and the given column family with read options.

pub fn multi_get<K, I>(&self, keys: I) -> Vec<Result<Option<Vec<u8>>, Error>>where
    K: AsRef<[u8]>,
    I: IntoIterator<Item = K>,

Return the values associated with the given keys.

pub fn multi_get_opt<K, I>(
    &self,
    keys: I,
    readopts: &ReadOptions
) -> Vec<Result<Option<Vec<u8>>, Error>>where
    K: AsRef<[u8]>,
    I: IntoIterator<Item = K>,

Return the values associated with the given keys using read options.

pub fn multi_get_cf<'a, 'b: 'a, K, I, W>(
    &'a self,
    keys: I
) -> Vec<Result<Option<Vec<u8>>, Error>>where
    K: AsRef<[u8]>,
    I: IntoIterator<Item = (&'b W, K)>,
    W: 'b + AsColumnFamilyRef,

Return the values associated with the given keys and column families.

pub fn multi_get_cf_opt<'a, 'b: 'a, K, I, W>(
    &'a self,
    keys: I,
    readopts: &ReadOptions
) -> Vec<Result<Option<Vec<u8>>, Error>>where
    K: AsRef<[u8]>,
    I: IntoIterator<Item = (&'b W, K)>,
    W: 'b + AsColumnFamilyRef,

Return the values associated with the given keys and column families using read options.

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

pub fn put_cf<K, V>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K,
    value: V
) -> Result<(), Error>where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>,

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

pub fn put_cf_opt<K, V>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K,
    value: V,
    writeopts: &WriteOptions
) -> Result<(), Error>where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>,

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

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

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

pub fn merge_cf<K, V>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K,
    value: V
) -> Result<(), Error>where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>,

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

pub fn merge_cf_opt<K, V>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K,
    value: V,
    writeopts: &WriteOptions
) -> Result<(), Error>where
    K: AsRef<[u8]>,
    V: AsRef<[u8]>,

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

pub fn delete_cf<K: AsRef<[u8]>>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K
) -> Result<(), Error>

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

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

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

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

pub fn iterator_cf_opt<'a: 'b, 'b>(
    &'a self,
    cf_handle: &impl AsColumnFamilyRef,
    readopts: ReadOptions,
    mode: IteratorMode<'_>
) -> DBIteratorWithThreadMode<'b, Self>

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

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

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

pub fn prefix_iterator<'a: 'b, 'b, P: AsRef<[u8]>>(
    &'a self,
    prefix: P
) -> DBIteratorWithThreadMode<'b, Self>

pub fn iterator_cf<'a: 'b, 'b>(
    &'a self,
    cf_handle: &impl AsColumnFamilyRef,
    mode: IteratorMode<'_>
) -> DBIteratorWithThreadMode<'b, Self>

pub fn full_iterator_cf<'a: 'b, 'b>(
    &'a self,
    cf_handle: &impl AsColumnFamilyRef,
    mode: IteratorMode<'_>
) -> DBIteratorWithThreadMode<'b, Self>

pub fn prefix_iterator_cf<'a, P: AsRef<[u8]>>(
    &'a self,
    cf_handle: &impl AsColumnFamilyRef,
    prefix: P
) -> DBIteratorWithThreadMode<'a, Self>

pub fn raw_iterator<'a: 'b, 'b>(
    &'a self
) -> DBRawIteratorWithThreadMode<'b, Self>

Opens a raw iterator over the database, using the default read options

pub fn raw_iterator_cf<'a: 'b, 'b>(
    &'a self,
    cf_handle: &impl AsColumnFamilyRef
) -> DBRawIteratorWithThreadMode<'b, Self>

Opens a raw iterator over the given column family, using the default read options

pub fn raw_iterator_opt<'a: 'b, 'b>(
    &'a self,
    readopts: ReadOptions
) -> DBRawIteratorWithThreadMode<'b, Self>

Opens a raw iterator over the database, using the given read options

pub fn raw_iterator_cf_opt<'a: 'b, 'b>(
    &'a self,
    cf_handle: &impl AsColumnFamilyRef,
    readopts: ReadOptions
) -> DBRawIteratorWithThreadMode<'b, Self>

Opens a raw iterator over the given column family, using the given read options

pub fn snapshot(&self) -> SnapshotWithThreadMode<'_, Self>

impl TransactionDB<SingleThreaded>

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

Creates column family with given name and options.

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

Returns the underlying column family handle.

impl TransactionDB<MultiThreaded>

pub fn create_cf<N: AsRef<str>>(
    &self,
    name: N,
    opts: &Options
) -> Result<(), Error>

Creates column family with given name and options.

pub fn cf_handle(&self, name: &str) -> Option<Arc<BoundColumnFamily<'_>>>

Returns the underlying column family handle.

Trait Implementations

impl<T: ThreadMode> DBAccess for TransactionDB<T>

unsafe fn create_snapshot(&self) -> *const rocksdb_snapshot_t

unsafe fn release_snapshot(&self, snapshot: *const rocksdb_snapshot_t)

unsafe fn create_iterator(
    &self,
    readopts: &ReadOptions
) -> *mut rocksdb_iterator_t

unsafe fn create_iterator_cf(
    &self,
    cf_handle: *mut rocksdb_column_family_handle_t,
    readopts: &ReadOptions
) -> *mut rocksdb_iterator_t

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

fn get_cf_opt<K: AsRef<[u8]>>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K,
    readopts: &ReadOptions
) -> Result<Option<Vec<u8>>, Error>

fn get_pinned_opt<K: AsRef<[u8]>>(
    &self,
    key: K,
    readopts: &ReadOptions
) -> Result<Option<DBPinnableSlice<'_>>, Error>

fn get_pinned_cf_opt<K: AsRef<[u8]>>(
    &self,
    cf: &impl AsColumnFamilyRef,
    key: K,
    readopts: &ReadOptions
) -> Result<Option<DBPinnableSlice<'_>>, Error>

fn multi_get_opt<K, I>(
    &self,
    keys: I,
    readopts: &ReadOptions
) -> Vec<Result<Option<Vec<u8>>, Error>>where
    K: AsRef<[u8]>,
    I: IntoIterator<Item = K>,

fn multi_get_cf_opt<'b, K, I, W>(
    &self,
    keys_cf: I,
    readopts: &ReadOptions
) -> Vec<Result<Option<Vec<u8>>, Error>>where
    K: AsRef<[u8]>,
    I: IntoIterator<Item = (&'b W, K)>,
    W: AsColumnFamilyRef + 'b,

impl<T: ThreadMode> Drop for TransactionDB<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ThreadMode> Send for TransactionDB<T>

impl<T: ThreadMode> Sync for TransactionDB<T>