Struct tikv::coprocessor_v2::raw_storage_impl::RawStorageImpl

pub struct RawStorageImpl<'a, E: Engine, L: LockManager> {
    context: Context,
    storage: &'a Storage<E, L>,
}

Implementation of the RawStorage trait.

It wraps TiKV’s Storage into an API that is exposed to coprocessor plugins. The RawStorageImpl should be constructed for every invocation of a CoprocessorPlugin as it wraps a Context that is unique for every request.

Fields

context: Context

storage: &'a Storage<E, L>

Implementations

impl<'a, E: Engine, L: LockManager> RawStorageImpl<'a, E, L>

pub fn new(context: Context, storage: &'a Storage<E, L>) -> Self

Constructs a new RawStorageImpl that wraps a given Context and Storage.

Trait Implementations

impl<E: Engine, L: LockManager> RawStorage for RawStorageImpl<'_, E, L>

fn get<'life0, 'async_trait>(
    &'life0 self,
    key: Key
) -> Pin<Box<dyn Future<Output = PluginResult<Option<Value>>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves the value for a given key from the storage on the current node. Returns Option::None if the key is not present in the database.

fn batch_get<'life0, 'async_trait>(
    &'life0 self,
    keys: Vec<Key>
) -> Pin<Box<dyn Future<Output = PluginResult<Vec<KvPair>>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Same as RawStorage::get(), but retrieves values for multiple keys at once.

fn scan<'life0, 'async_trait>(
    &'life0 self,
    key_range: Range<Key>
) -> Pin<Box<dyn Future<Output = PluginResult<Vec<Value>>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Same as RawStorage::get(), but accepts a key_range such that values for keys in [key_range.start, key_range.end) are retrieved. The upper bound of the key_range is exclusive.

fn put<'life0, 'async_trait>(
    &'life0 self,
    key: Key,
    value: Value
) -> Pin<Box<dyn Future<Output = PluginResult<()>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Inserts a new key-value pair into the storage on the current node.

fn batch_put<'life0, 'async_trait>(
    &'life0 self,
    kv_pairs: Vec<KvPair>
) -> Pin<Box<dyn Future<Output = PluginResult<()>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Same as RawStorage::put(), but inserts multiple key-value pairs at once.

fn delete<'life0, 'async_trait>(
    &'life0 self,
    key: Key
) -> Pin<Box<dyn Future<Output = PluginResult<()>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes a key-value pair from the storage on the current node given a key. Returns [Result::Ok] if the key was successfully deleted.

fn batch_delete<'life0, 'async_trait>(
    &'life0 self,
    keys: Vec<Key>
) -> Pin<Box<dyn Future<Output = PluginResult<()>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Same as RawStorage::delete(), but deletes multiple key-value pairs at once.

fn delete_range<'life0, 'async_trait>(
    &'life0 self,
    key_range: Range<Key>
) -> Pin<Box<dyn Future<Output = PluginResult<()>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Same as RawStorage::delete(), but deletes multiple key-values pairs at once given a key_range. All records with keys in [key_range.start, key_range.end) will be deleted. The upper bound of the key_range is exclusive.