Struct tikv::storage::RocksEngine

pub struct RocksEngine {
    core: Arc<Mutex<RocksEngineCore>>,
    sched: Scheduler<Task>,
    engines: Engines<RocksEngine, RocksEngine>,
    not_leader: Arc<AtomicBool>,
}

The RocksEngine is based on RocksDB.

This is intended for testing use only.

Fields

core: Arc<Mutex<RocksEngineCore>>

sched: Scheduler<Task>

engines: Engines<RocksEngine, RocksEngine>

not_leader: Arc<AtomicBool>

Implementations

impl RocksEngine

pub fn new(
    path: &str,
    cfs: &[&'static str],
    cfs_opts: Option<Vec<CFOptions<'_>, Global>>,
    shared_block_cache: bool,
    io_rate_limiter: Option<Arc<IORateLimiter>>
) -> Result<RocksEngine, Error>

pub fn trigger_not_leader(&self)

pub fn pause(&self, dur: Duration)

pub fn engines(&self) -> Engines<RocksEngine, RocksEngine>

pub fn get_rocksdb(&self) -> RocksEngine

pub fn stop(&self)

Trait Implementations

impl Clone for RocksEngine

pub fn clone(&self) -> RocksEngine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RocksEngine

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

Formats the value using the given formatter.

impl Display for RocksEngine

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

Formats the value using the given formatter.

impl Engine for RocksEngine

type Snap = Arc<RocksSnapshot>

type Local = RocksEngine

pub fn kv_engine(&self) -> RocksEngine

Local storage engine.

pub fn snapshot_on_kv_engine(
    &self,
    &[u8],
    &[u8]
) -> Result<<RocksEngine as Engine>::Snap, Error>

pub fn modify_on_kv_engine(
    &self,
    modifies: Vec<Modify, Global>
) -> Result<(), Error>

Write modifications into internal local engine directly.

pub fn async_write(
    &self,
    ctx: &Context,
    batch: WriteData,
    cb: Box<dyn FnOnce((CbContext, Result<(), Error>)) + 'static + Send, Global>
) -> Result<(), Error>

pub fn async_write_ext(
    &self,
    &Context,
    batch: WriteData,
    cb: Box<dyn FnOnce((CbContext, Result<(), Error>)) + 'static + Send, Global>,
    proposed_cb: Option<Box<dyn FnOnce() + 'static + Send, Global>>,
    committed_cb: Option<Box<dyn FnOnce() + 'static + Send, Global>>
) -> Result<(), Error>

Writes data to the engine asynchronously with some extensions.

pub fn async_snapshot(
    &self,
    SnapContext<'_>,
    cb: Box<dyn FnOnce((CbContext, Result<<RocksEngine as Engine>::Snap, Error>)) + 'static + Send, Global>
) -> Result<(), Error>

pub fn write(&self, ctx: &Context, batch: WriteData) -> Result<(), Error>

pub fn release_snapshot(&self)

pub fn snapshot(&self, ctx: SnapContext<'_>) -> Result<Self::Snap, Error>

pub fn put(
    &self,
    ctx: &Context,
    key: Key,
    value: Vec<u8, Global>
) -> Result<(), Error>

pub fn put_cf(
    &self,
    ctx: &Context,
    cf: &'static str,
    key: Key,
    value: Vec<u8, Global>
) -> Result<(), Error>

pub fn delete(&self, ctx: &Context, key: Key) -> Result<(), Error>

pub fn delete_cf(
    &self,
    ctx: &Context,
    cf: &'static str,
    key: Key
) -> Result<(), Error>

pub fn get_mvcc_properties_cf(
    &self,
    &'static str,
    _safe_point: TimeStamp,
    _start: &[u8],
    _end: &[u8]
) -> Option<MvccProperties>