Struct engine_rocks::write_batch::RocksWriteBatchVec

pub struct RocksWriteBatchVec {
    db: Arc<DB>,
    wbs: Vec<RawWriteBatch>,
    save_points: Vec<usize>,
    index: usize,
    cur_batch_size: usize,
    batch_size_limit: usize,
}

RocksWriteBatchVec is for method multi_batch_write of RocksDB, which splits a large WriteBatch into many smaller ones and then any thread could help to deal with these small WriteBatch when it is calling AwaitState and wait to become leader of WriteGroup. multi_batch_write will perform much better than traditional pipelined_write when TiKV writes very large data into RocksDB. We will remove this feature when unordered_write of RocksDB becomes more stable and becomes compatible with Titan.

Fields

db: Arc<DB>

wbs: Vec<RawWriteBatch>

save_points: Vec<usize>

index: usize

cur_batch_size: usize

batch_size_limit: usize

Implementations

impl RocksWriteBatchVec

pub fn new(
    db: Arc<DB>,
    batch_size_limit: usize,
    cap: usize
) -> RocksWriteBatchVec

pub fn as_inner(&self) -> &[RawWriteBatch]

pub fn as_raw(&self) -> &RawWriteBatch

pub fn get_db(&self) -> &DB

fn check_switch_batch(&mut self)

check_switch_batch will split a large WriteBatch into many smaller ones. This is to avoid a large WriteBatch blocking write_thread too long.

Trait Implementations

impl Mutable for RocksWriteBatchVec

fn put(&mut self, key: &[u8], value: &[u8]) -> Result<()>

Write a key/value in the default column family

fn put_cf(&mut self, cf: &str, key: &[u8], value: &[u8]) -> Result<()>

Write a key/value in a given column family

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

Delete a key/value in the default column family

fn delete_cf(&mut self, cf: &str, key: &[u8]) -> Result<()>

Delete a key/value in a given column family

fn delete_range(&mut self, begin_key: &[u8], end_key: &[u8]) -> Result<()>

Delete a range of key/values in the default column family

fn delete_range_cf(
    &mut self,
    cf: &str,
    begin_key: &[u8],
    end_key: &[u8]
) -> Result<()>

Delete a range of key/values in a given column family

pub fn put_msg<M>(&mut self, key: &[u8], m: &M) -> Result<(), Error> where
    M: Message, 

pub fn put_msg_cf<M>(
    &mut self,
    cf: &str,
    key: &[u8],
    m: &M
) -> Result<(), Error> where
    M: Message, 

impl WriteBatch<RocksEngine> for RocksWriteBatchVec

fn with_capacity(e: &RocksEngine, cap: usize) -> RocksWriteBatchVec

Create a WriteBatch with a given command capacity

fn write_opt(&self, opts: &WriteOptions) -> Result<()>

Commit the WriteBatch to disk with the given options

fn data_size(&self) -> usize

The data size of a write batch

fn count(&self) -> usize

The number of commands in this batch

fn is_empty(&self) -> bool

Whether any commands have been issued to this batch

fn should_write_to_engine(&self) -> bool

Whether the number of commands exceeds WRITE_BATCH_MAX_KEYS

fn clear(&mut self)

Clears the WriteBatch of all commands

fn set_save_point(&mut self)

Push a save point onto the save point stack

fn pop_save_point(&mut self) -> Result<()>

Pop a save point from the save point stack

fn rollback_to_save_point(&mut self) -> Result<()>

Revert all commands issued since the last save point

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

Commit the WriteBatch to disk atomically