Struct WriteBatchWithTransaction

pub struct WriteBatchWithTransaction<const TRANSACTION: bool> { /* private fields */ }

An atomic batch of write operations.

delete_range is not supported in Transaction.

Making an atomic commit of several writes:

use rust_rocksdb::{DB, Options, WriteBatchWithTransaction};

let tempdir = tempfile::Builder::new()
    .prefix("_path_for_rocksdb_storage1")
    .tempdir()
    .expect("Failed to create temporary path for the _path_for_rocksdb_storage1");
let path = tempdir.path();
{
    let db = DB::open_default(path).unwrap();
    let mut batch = WriteBatchWithTransaction::<false>::default();
    batch.put(b"my key", b"my value");
    batch.put(b"key2", b"value2");
    batch.put(b"key3", b"value3");

    // delete_range is supported when use without transaction
    batch.delete_range(b"key2", b"key3");

    db.write(batch); // Atomically commits the batch
}
let _ = DB::destroy(&Options::default(), path);

Implementations

impl<const TRANSACTION: bool> WriteBatchWithTransaction<TRANSACTION>

pub fn new() -> Self

Create a new WriteBatch without allocating memory.

pub fn with_capacity_bytes(capacity_bytes: usize) -> Self

Creates WriteBatch with the specified capacity in bytes. Allocates immediately.

pub fn from_data(data: &[u8]) -> Self

Construct with a reference to a byte array serialized by WriteBatch.

pub fn len(&self) -> usize

pub fn size_in_bytes(&self) -> usize

Return WriteBatch serialized size (in bytes).

pub fn data(&self) -> &[u8]

Return a reference to a byte array which represents a serialized version of the batch.

pub fn is_empty(&self) -> bool

pub fn iterate(&self, callbacks: &mut dyn WriteBatchIterator)

Iterate the put and delete operations within this write batch. Note that this does not return an Iterator but instead will invoke the put() and delete() member functions of the provided WriteBatchIterator trait implementation.

pub fn put<K, V>(&mut self, key: K, value: V)

where K: AsRef<[u8]>, V: AsRef<[u8]>,

Insert a value into the database under the given key.

pub fn put_cf<K, V>(&mut self, cf: &impl AsColumnFamilyRef, key: K, value: V)

where K: AsRef<[u8]>, V: AsRef<[u8]>,

Insert a value into the specific column family of the database under the given key.

pub fn put_cf_with_ts<K, V, S>( &mut self, cf: &impl AsColumnFamilyRef, key: K, ts: S, value: V, )

where K: AsRef<[u8]>, V: AsRef<[u8]>, S: AsRef<[u8]>,

Insert a value into the specific column family of the database under the given key with timestamp.

pub fn merge<K, V>(&mut self, key: K, value: V)

where K: AsRef<[u8]>, V: AsRef<[u8]>,

pub fn merge_cf<K, V>(&mut self, cf: &impl AsColumnFamilyRef, key: K, value: V)

where K: AsRef<[u8]>, V: AsRef<[u8]>,

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

Removes the database entry for key. Does nothing if the key was not found.

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

Removes the database entry in the specific column family for key. Does nothing if the key was not found.

pub fn delete_cf_with_ts<K: AsRef<[u8]>, S: AsRef<[u8]>>( &mut self, cf: &impl AsColumnFamilyRef, key: K, ts: S, )

Removes the database entry in the specific column family with timestamp for key. Does nothing if the key was not found.

pub fn put_log_data<V: AsRef<[u8]>>(&mut self, log_data: V)

pub fn clear(&mut self)

Clear all updates buffered in this batch.

impl WriteBatchWithTransaction<false>

pub fn delete_range<K: AsRef<[u8]>>(&mut self, from: K, to: K)

Remove database entries from start key to end key.

Removes the database entries in the range [“begin_key”, “end_key”), i.e., including “begin_key” and excluding “end_key”. It is not an error if no keys exist in the range [“begin_key”, “end_key”).

pub fn delete_range_cf<K: AsRef<[u8]>>( &mut self, cf: &impl AsColumnFamilyRef, from: K, to: K, )

Remove database entries in column family from start key to end key.

Removes the database entries in the range [“begin_key”, “end_key”), i.e., including “begin_key” and excluding “end_key”. It is not an error if no keys exist in the range [“begin_key”, “end_key”).

Trait Implementations

impl<const TRANSACTION: bool> Default for WriteBatchWithTransaction<TRANSACTION>

fn default() -> Self

Returns the “default value” for a type.

impl<const TRANSACTION: bool> Drop for WriteBatchWithTransaction<TRANSACTION>

fn drop(&mut self)

Executes the destructor for this type.

impl<const TRANSACTION: bool> Send for WriteBatchWithTransaction<TRANSACTION>