Struct tikv_kv::RocksEngine

[+] Show declaration

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

[−] Expand description

The RocksEngine is based on RocksDB.

This is intended for testing use only.

Fields

core: Arc<Mutex<RocksEngineCore>>

sched: Scheduler<Task>

engines: Engines<BaseRocksEngine, BaseRocksEngine>

not_leader: Arc<AtomicBool>

Implementations

impl RocksEngine[−]

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

pub fn trigger_not_leader(&self)

pub fn pause(&self, dur: Duration)

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

pub fn get_rocksdb(&self) -> BaseRocksEngine

pub fn stop(&self)

Trait Implementations

impl Clone for RocksEngine[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Display for RocksEngine[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Engine for RocksEngine[+]

[+] Show hidden undocumented items

type Snap = Arc<RocksSnapshot>

type Local = BaseRocksEngine

fn kv_engine(&self) -> BaseRocksEngine[−]

Local storage engine.

fn snapshot_on_kv_engine(&self, _: &[u8], _: &[u8]) -> Result<Self::Snap>

fn modify_on_kv_engine(&self, modifies: Vec<Modify>) -> Result<()>[−]

Write modifications into internal local engine directly.

fn async_write(
    &self,
    ctx: &Context,
    batch: WriteData,
    cb: Callback<()>
) -> Result<()>

fn async_write_ext(
    &self,
    _: &Context,
    batch: WriteData,
    cb: Callback<()>,
    proposed_cb: Option<ExtCallback>,
    committed_cb: Option<ExtCallback>
) -> Result<()>[−]

Writes data to the engine asynchronously with some extensions.

fn async_snapshot(
    &self,
    _: SnapContext<'_>,
    cb: Callback<Self::Snap>
) -> Result<()>

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

fn release_snapshot(&self)

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

fn put(&self, ctx: &Context, key: Key, value: Value) -> Result<()>

fn put_cf(
    &self,
    ctx: &Context,
    cf: CfName,
    key: Key,
    value: Value
) -> Result<()>

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

fn delete_cf(&self, ctx: &Context, cf: CfName, key: Key) -> Result<()>

fn get_mvcc_properties_cf(
    &self,
    _: CfName,
    _safe_point: TimeStamp,
    _start: &[u8],
    _end: &[u8]
) -> Option<MvccProperties>