Struct WriteBatch 

pub struct WriteBatch { /* private fields */ }

A batch of write operations (puts, deletes, and merges). All operations in the batch are applied atomically to the database. Put and delete operations replace earlier operations for the same key, while merge operations are preserved until a later put or delete replaces them.

Examples

    use slatedb::Db;
    use slatedb::WriteBatch;

    let object_store = Arc::new(InMemory::new());
    let db = Db::open("path/to/db", object_store).await?;

    let mut batch = WriteBatch::new();
    batch.put(b"key1", b"value1");
    batch.put(b"key2", b"value2");
    batch.delete(b"key3");

    db.write(batch).await;
    Ok(())

Note that the WriteBatch has an unlimited size. This means that batch writes can exceed l0_sst_size_bytes (when WAL is disabled). It also means that WAL SSTs could get large if there’s a large batch write.

Implementations

impl WriteBatch

pub fn new() -> Self

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

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

Put a key-value pair into the batch. Keys must not be empty.

Panics

• if the key is empty
• if the key size is larger than u16::MAX
• if the value size is larger than u32::MAX

pub fn put_with_options<K, V>(&mut self, key: K, value: V, options: &PutOptions)

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

Put a key-value pair into the batch. Keys must not be empty.

Panics

• if the key is empty
• if the key size is larger than u16::MAX
• if the value size is larger than u32::MAX

pub fn put_bytes(&mut self, key: Bytes, value: Bytes)

Put a key-value pair into the batch using owned Bytes, avoiding the copies that WriteBatch::put performs via Bytes::copy_from_slice. Prefer this form when the caller already holds the data as Bytes (e.g. from a prior read, a zero-copy buffer pool, or a client that produces Bytes directly). Keys must not be empty.

Panics

• if the key is empty
• if the key size is larger than u16::MAX
• if the value size is larger than u32::MAX

pub fn put_bytes_with_options( &mut self, key: Bytes, value: Bytes, options: &PutOptions, )

Put a key-value pair into the batch using owned Bytes with custom options. See WriteBatch::put_bytes for why this form exists.

Panics

• if the key is empty
• if the key size is larger than u16::MAX
• if the value size is larger than u32::MAX

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

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

Merge a key-value pair into the batch. Keys must not be empty.

pub fn merge_with_options<K, V>( &mut self, key: K, value: V, options: &MergeOptions, )

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

Merge a key-value pair into the batch with custom options.

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

Delete a key-value pair into the batch. Keys must not be empty.

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for WriteBatch

fn clone(&self) -> WriteBatch

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WriteBatch

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

Formats the value using the given formatter.

impl Default for WriteBatch

fn default() -> Self

Returns the “default value” for a type.