Struct MonitoredStateStore

pub struct MonitoredStateStore<S> {
    inner: Box<S>,
    storage_metrics: Arc<MonitoredStorageMetrics>,
}

A state store wrapper for monitoring metrics.

Fields

inner: Box<S>

storage_metrics: Arc<MonitoredStorageMetrics>

Implementations

impl<S> MonitoredStateStore<S>

pub fn new(inner: S, storage_metrics: Arc<MonitoredStorageMetrics>) -> Self

pub fn new_from_local( inner: S, storage_metrics: Arc<MonitoredStorageMetrics>, ) -> Self

impl<S> MonitoredStateStore<S>

async fn monitored_iter<'a, Item: IterItem, I: StateStoreIter<Item> + 'a, Stat: StateStoreIterStatsTrait<Item = Item>>( &'a self, table_id: TableId, iter_stream_future: impl Future<Output = StorageResult<I>> + 'a, ) -> StorageResult<MonitoredStateStoreIter<Item, I, Stat>>

pub fn inner(&self) -> &S

async fn monitored_get( &self, get_future: impl Future<Output = StorageResult<Option<Bytes>>>, table_id: TableId, key_len: usize, ) -> StorageResult<Option<Bytes>>

async fn monitored_get_keyed_row( &self, get_keyed_row_future: impl Future<Output = StorageResult<Option<StateStoreKeyedRow>>>, table_id: TableId, key_len: usize, ) -> StorageResult<Option<StateStoreKeyedRow>>

impl MonitoredStateStore<HummockStorage>

pub fn sstable_store(&self) -> SstableStoreRef

pub fn sstable_object_id_manager(&self) -> SstableObjectIdManagerRef

pub async fn sync( &self, sync_table_epochs: Vec<(HummockEpoch, HashSet<TableId>)>, ) -> StorageResult<SyncResult>

Trait Implementations

impl<S: Clone> Clone for MonitoredStateStore<S>

fn clone(&self) -> MonitoredStateStore<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

fn get( &self, key: TableKey<Bytes>, read_options: ReadOptions, ) -> impl Future<Output = StorageResult<Option<Bytes>>> + Send + '_

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 Future<Output = StorageResult<Self::Iter<'_>>> + Send + '_

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 Future<Output = StorageResult<Self::RevIter<'_>>> + Send + '_

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 Future<Output = StorageResult<usize>> + Send + '_

fn epoch(&self) -> u64

fn is_dirty(&self) -> bool

async fn init(&mut self, options: InitOptions) -> StorageResult<()>

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 try_flush(&mut self) -> impl Future<Output = StorageResult<()>> + Send + '_

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

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

Get last persisted watermark for a given vnode.

impl<S: StateStore> StateStore for MonitoredStateStore<S>

type Local = MonitoredStateStore<<S as StateStore>::Local>

fn try_wait_epoch( &self, epoch: HummockReadEpoch, options: TryWaitEpochOptions, ) -> impl Future<Output = StorageResult<()>> + Send + '_

If epoch is Committed, we will wait until the epoch is committed and its data is ready to read. If epoch is Current, we will only check if the data can be read with this epoch.

fn monitored( self, _storage_metrics: Arc<MonitoredStorageMetrics>, ) -> MonitoredStateStore<Self>

Creates a MonitoredStateStore from this state store, with given stats.

async fn new_local(&self, option: NewLocalOptions) -> Self::Local

impl<S: StateStoreRead> StateStoreRead for MonitoredStateStore<S>

type ChangeLogIter = impl StateStoreReadChangeLogIter

type Iter = impl StateStoreReadIter

type RevIter = impl StateStoreReadIter

fn get_keyed_row( &self, key: TableKey<Bytes>, epoch: u64, read_options: ReadOptions, ) -> impl Future<Output = StorageResult<Option<StateStoreKeyedRow>>> + '_

Point gets a value from the state store. The result is based on a snapshot corresponding to the given epoch. Both full key and the value are returned.

fn iter( &self, key_range: TableKeyRange, epoch: u64, read_options: ReadOptions, ) -> impl Future<Output = StorageResult<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 a snapshot corresponding to the given epoch.

fn rev_iter( &self, key_range: TableKeyRange, epoch: u64, read_options: ReadOptions, ) -> impl Future<Output = StorageResult<Self::RevIter>> + '_

fn iter_log( &self, epoch_range: (u64, u64), key_range: TableKeyRange, options: ReadLogOptions, ) -> impl Future<Output = StorageResult<Self::ChangeLogIter>> + Send + '_

fn get( &self, key: TableKey<Bytes>, epoch: u64, read_options: ReadOptions, ) -> impl Future<Output = StorageResult<Option<Bytes>>> + Send + '_

Point gets a value from the state store. The result is based on a snapshot corresponding to the given epoch. Only the value is returned.