Struct ckb_rocksdb::WriteBatch

source ·
pub struct WriteBatch { /* private fields */ }
Expand description

An atomic batch of write operations.

Making an atomic commit of several writes:

use ckb_rocksdb::{prelude::*, WriteBatch};

let path = "_path_for_rocksdb_storage1";

let db = DB::open_default(&path).unwrap();

let mut batch = WriteBatch::default();
batch.put(b"my key", b"my value");
batch.put(b"key2", b"value2");
batch.put(b"key3", b"value3");

db.write(&batch); // Atomically commits the batch

Implementations§

source§

impl WriteBatch

source

pub fn len(&self) -> usize

source

pub fn size_in_bytes(&self) -> usize

Return WriteBatch serialized size (in bytes).

source

pub fn is_empty(&self) -> bool

source

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

Insert a value into the database under the given key.

source

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

source

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

source

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

source

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

Remove the database entry for key.

Returns an error if the key was not found.

source

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

source

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

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”).

source

pub fn delete_range_cf<K: AsRef<[u8]>>( &mut self, cf: &ColumnFamily, from: K, to: K ) -> Result<(), Error>

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”).

source

pub fn clear(&mut self) -> Result<(), Error>

Clear all updates buffered in this batch.

Trait Implementations§

source§

impl Default for WriteBatch

source§

fn default() -> WriteBatch

Returns the “default value” for a type. Read more
source§

impl Drop for WriteBatch

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Handle<rocksdb_writebatch_t> for WriteBatch

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.