Trait LocalStateStore

pub trait LocalStateStore: StaticSendSync {
    type FlushedSnapshotReader: StateStoreRead;
    type Iter<'a>: StateStoreIter + 'a;
    type RevIter<'a>: StateStoreIter + 'a;

    // Required methods
    fn get(
        &self,
        key: TableKey<Bytes>,
        read_options: ReadOptions,
    ) -> impl StorageFuture<'_, Option<Bytes>>;
    fn iter(
        &self,
        key_range: TableKeyRange,
        read_options: ReadOptions,
    ) -> impl StorageFuture<'_, Self::Iter<'_>>;
    fn rev_iter(
        &self,
        key_range: TableKeyRange,
        read_options: ReadOptions,
    ) -> impl StorageFuture<'_, Self::RevIter<'_>>;
    fn new_flushed_snapshot_reader(&self) -> Self::FlushedSnapshotReader;
    fn get_table_watermark(&self, vnode: VirtualNode) -> Option<Bytes>;
    fn insert(
        &mut self,
        key: TableKey<Bytes>,
        new_val: Bytes,
        old_val: Option<Bytes>,
    ) -> StorageResult<()>;
    fn delete(
        &mut self,
        key: TableKey<Bytes>,
        old_val: Bytes,
    ) -> StorageResult<()>;
    fn flush(&mut self) -> impl StorageFuture<'_, usize>;
    fn try_flush(&mut self) -> impl StorageFuture<'_, ()>;
    fn epoch(&self) -> u64;
    fn is_dirty(&self) -> bool;
    fn init(&mut self, opts: InitOptions) -> impl StorageFuture<'_, ()>;
    fn seal_current_epoch(
        &mut self,
        next_epoch: u64,
        opts: SealCurrentEpochOptions,
    );
    fn update_vnode_bitmap(&mut self, vnodes: Arc<Bitmap>) -> Arc<Bitmap>;
}

A state store that is dedicated for streaming operator, which only reads the uncommitted data written by itself. Each local state store is not Clone, and is owned by a streaming state table.

Required Associated Types

type FlushedSnapshotReader: StateStoreRead

type Iter<'a>: StateStoreIter + 'a

type RevIter<'a>: StateStoreIter + 'a

Required Methods

fn get( &self, key: TableKey<Bytes>, read_options: ReadOptions, ) -> impl StorageFuture<'_, Option<Bytes>>

Point gets a value from the state store. The result is based on the latest written snapshot.

fn iter( &self, key_range: TableKeyRange, read_options: ReadOptions, ) -> impl StorageFuture<'_, Self::Iter<'_>>

Opens and returns an iterator for given prefix_hint and full_key_range Internally, prefix_hint will be used to for checking bloom_filter and full_key_range used for iter. (if the prefix_hint not None, it should be be included in key_range) The returned iterator will iterate data based on the latest written snapshot.

fn rev_iter( &self, key_range: TableKeyRange, read_options: ReadOptions, ) -> impl StorageFuture<'_, Self::RevIter<'_>>

fn new_flushed_snapshot_reader(&self) -> Self::FlushedSnapshotReader

fn get_table_watermark(&self, vnode: VirtualNode) -> Option<Bytes>

Get last persisted watermark for a given vnode.

fn insert( &mut self, key: TableKey<Bytes>, new_val: Bytes, old_val: Option<Bytes>, ) -> StorageResult<()>

Inserts a key-value entry associated with a given epoch into the state store.

fn delete(&mut self, key: TableKey<Bytes>, old_val: Bytes) -> StorageResult<()>

Deletes a key-value entry from the state store. Only the key-value entry with epoch smaller than the given epoch will be deleted.

fn flush(&mut self) -> impl StorageFuture<'_, usize>

fn try_flush(&mut self) -> impl StorageFuture<'_, ()>

fn epoch(&self) -> u64

fn is_dirty(&self) -> bool

fn init(&mut self, opts: InitOptions) -> impl StorageFuture<'_, ()>

Initializes the state store with given epoch pair. Typically we will use epoch.curr as the initialized epoch, Since state table will begin as empty. In some cases like replicated state table, state table may not be empty initially, as such we need to wait for epoch.prev checkpoint to complete, hence this interface is made async.

fn seal_current_epoch(&mut self, next_epoch: u64, opts: SealCurrentEpochOptions)

Updates the monotonically increasing write epoch to new_epoch. All writes after this function is called will be tagged with new_epoch. In other words, the previous write epoch is sealed.

fn update_vnode_bitmap(&mut self, vnodes: Arc<Bitmap>) -> Arc<Bitmap>

Object Safety

This trait is not object safe.

Implementors

impl LocalStateStore for LocalHummockStorage

type FlushedSnapshotReader = LocalHummockFlushedSnapshotReader

type Iter<'a> = HummockStorageIteratorInner<'a>

type RevIter<'a> = HummockStorageRevIteratorInner<'a>

impl LocalStateStore for PanicStateStore

type FlushedSnapshotReader = PanicStateStore

type Iter<'a> = PanicStateStoreIter<(FullKey<Bytes>, Bytes)>

type RevIter<'a> = PanicStateStoreIter<(FullKey<Bytes>, Bytes)>

impl LocalStateStore for StateStorePointer<Box<dyn DynLocalStateStore>>

type FlushedSnapshotReader = StateStorePointer<Arc<dyn DynStateStoreRead>>

type Iter<'a> = Box<dyn DynStateStoreIter<(FullKey<Bytes>, Bytes)> + 'a>

type RevIter<'a> = Box<dyn DynStateStoreIter<(FullKey<Bytes>, Bytes)> + 'a>

impl<A: LocalStateStore, E: LocalStateStore> LocalStateStore for VerifyStateStore<A, E>

type FlushedSnapshotReader = VerifyStateStore<<A as LocalStateStore>::FlushedSnapshotReader, <E as LocalStateStore>::FlushedSnapshotReader>

type Iter<'a> = impl StateStoreIter + 'a

type RevIter<'a> = impl StateStoreIter + 'a

impl<R: RangeKv> LocalStateStore for RangeKvLocalStateStore<R>

type FlushedSnapshotReader = RangeKvStateStore<R>

type Iter<'a> = impl StateStoreIter + 'a

type RevIter<'a> = impl StateStoreIter + 'a

impl<S: LocalStateStore> LocalStateStore for MonitoredStateStore<S>

type FlushedSnapshotReader = MonitoredStateStore<<S as LocalStateStore>::FlushedSnapshotReader>

type Iter<'a> = impl StateStoreIter + 'a

type RevIter<'a> = impl StateStoreIter + 'a