Struct mz_persist_client::internal::apply::Applier
source · pub struct Applier<K, V, T, D> {
pub(crate) cfg: PersistConfig,
pub(crate) metrics: Arc<Metrics>,
pub(crate) shard_metrics: Arc<ShardMetrics>,
pub(crate) state_versions: Arc<StateVersions>,
shared_states: Arc<StateCache>,
pubsub_sender: Arc<dyn PubSubSender>,
pub(crate) shard_id: ShardId,
state: Arc<LockingTypedState<K, V, T, D>>,
}
Expand description
An applier of persist commands.
This struct exists mainly to allow us to very narrowly bound the surface area that directly interacts with state.
Fields§
§cfg: PersistConfig
§metrics: Arc<Metrics>
§shard_metrics: Arc<ShardMetrics>
§state_versions: Arc<StateVersions>
§pubsub_sender: Arc<dyn PubSubSender>
§shard_id: ShardId
§state: Arc<LockingTypedState<K, V, T, D>>
Implementations§
source§impl<K, V, T, D> Applier<K, V, T, D>
impl<K, V, T, D> Applier<K, V, T, D>
pub async fn new( cfg: PersistConfig, shard_id: ShardId, metrics: Arc<Metrics>, state_versions: Arc<StateVersions>, shared_states: Arc<StateCache>, pubsub_sender: Arc<dyn PubSubSender>, diagnostics: Diagnostics, ) -> Result<Self, Box<CodecMismatch>>
sourcepub fn watch(&self) -> StateWatch<K, V, T, D>
pub fn watch(&self) -> StateWatch<K, V, T, D>
Returns a new StateWatch for changes to this Applier’s State.
sourcepub async fn fetch_upper<R, F: FnMut(&Antichain<T>) -> R>(&mut self, f: F) -> R
pub async fn fetch_upper<R, F: FnMut(&Antichain<T>) -> R>(&mut self, f: F) -> R
Fetches the latest state from Consensus and passes its upper
to the provided closure.
sourcepub fn clone_upper(&self) -> Antichain<T>
pub fn clone_upper(&self) -> Antichain<T>
A point-in-time read/clone of upper
from the current state.
Due to sharing state with other handles, successive reads to this fn or any other may
see a different version of state, even if this Applier has not explicitly fetched and
updated to the latest state. Successive calls will always return values such that
PartialOrder::less_equal(call1, call2)
hold true.
pub(crate) fn upper<R, F: FnMut(SeqNo, &Antichain<T>) -> R>(&self, f: F) -> R
pub(crate) fn schemas<R>( &self, f: impl FnMut(SeqNo, &BTreeMap<SchemaId, EncodedSchemas>) -> R, ) -> R
pub(crate) fn schema_cache(&self) -> SchemaCache<K, V, T, D>
sourcepub fn seqno(&self) -> SeqNo
pub fn seqno(&self) -> SeqNo
A point-in-time read of seqno
from the current state.
Due to sharing state with other handles, successive reads to this fn or any other may
see a different version of state, even if this Applier has not explicitly fetched and
updated to the latest state. Successive calls will always return values such that
call1 <= call2
hold true.
sourcepub fn seqno_since(&self) -> SeqNo
pub fn seqno_since(&self) -> SeqNo
A point-in-time read of seqno_since
from the current state.
Due to sharing state with other handles, successive reads to this fn or any other may
see a different version of state, even if this Applier has not explicitly fetched and
updated to the latest state. Successive calls will always return values such that
call1 <= call2
hold true.
sourcepub fn is_finalized(&self) -> bool
pub fn is_finalized(&self) -> bool
A point-in-time read from the current state. (We declare a shard ‘finalized’ if it’s both become an unreadable tombstone and the state itself is has been emptied out.)
Due to sharing state with other handles, successive reads to this fn or any other may see a different version of state, even if this Applier has not explicitly fetched and updated to the latest state. Once this fn returns true, it will always return true.
sourcepub fn check_since_upper_both_empty(&self) -> Result<(), InvalidUsage<T>>
pub fn check_since_upper_both_empty(&self) -> Result<(), InvalidUsage<T>>
Returns whether the current’s state since
and upper
are both empty.
Due to sharing state with other handles, successive reads to this fn or any other may see a different version of state, even if this Applier has not explicitly fetched and updated to the latest state. Once this fn returns true, it will always return true.
sourcepub fn rollups_lte_seqno(&self, seqno: SeqNo) -> Vec<(SeqNo, PartialRollupKey)>
pub fn rollups_lte_seqno(&self, seqno: SeqNo) -> Vec<(SeqNo, PartialRollupKey)>
Returns all rollups that are <= the given seqno
.
Due to sharing state with other handles, successive reads to this fn or any other may see a different version of state, even if this Applier has not explicitly fetched and updated to the latest state.
pub fn all_fueled_merge_reqs(&self) -> Vec<FueledMergeReq<T>>
pub fn snapshot( &self, as_of: &Antichain<T>, ) -> Result<Vec<HollowBatch<T>>, SnapshotErr<T>>
pub fn all_batches(&self) -> Vec<HollowBatch<T>>
pub fn verify_listen( &self, as_of: &Antichain<T>, ) -> Result<Result<(), Upper<T>>, Since<T>>
pub fn next_listen_batch( &self, frontier: &Antichain<T>, ) -> Result<HollowBatch<T>, SeqNo>
pub async fn write_rollup_for_state(&self) -> Option<EncodedRollup>
pub async fn apply_unbatched_cmd<R, E, WorkFn: FnMut(SeqNo, &PersistConfig, &mut StateCollections<T>) -> ControlFlow<E, R>>( &mut self, cmd: &CmdMetrics, work_fn: WorkFn, ) -> Result<(SeqNo, Result<R, E>, RoutineMaintenance), Indeterminate>
async fn apply_unbatched_cmd_locked<R, E, WorkFn: FnMut(SeqNo, &PersistConfig, &mut StateCollections<T>) -> ControlFlow<E, R>>( state: &LockingTypedState<K, V, T, D>, cmd: &CmdMetrics, work_fn: &mut WorkFn, cfg: &PersistConfig, metrics: &Metrics, shard_metrics: &ShardMetrics, state_versions: &StateVersions, ) -> ApplyCmdResult<K, V, T, D, R, E>
fn compute_next_state_locked<R, E, WorkFn: FnMut(SeqNo, &PersistConfig, &mut StateCollections<T>) -> ControlFlow<E, R>>( state: &TypedState<K, V, T, D>, work_fn: &mut WorkFn, metrics: &Metrics, cmd: &CmdMetrics, cfg: &PersistConfig, ) -> Result<NextState<K, V, T, D, R>, (SeqNo, E)>
pub fn update_state(&mut self, new_state: TypedState<K, V, T, D>)
sourcepub async fn fetch_and_update_state(&self, seqno_hint: Option<SeqNo>)
pub async fn fetch_and_update_state(&self, seqno_hint: Option<SeqNo>)
Fetches and updates to the latest state. Uses an optional hint to early-out if any more recent version of state is observed (e.g. updated by another handle), without making any calls to Consensus or Blob.
Trait Implementations§
Auto Trait Implementations§
impl<K, V, T, D> Freeze for Applier<K, V, T, D>
impl<K, V, T, D> !RefUnwindSafe for Applier<K, V, T, D>
impl<K, V, T, D> Send for Applier<K, V, T, D>
impl<K, V, T, D> Sync for Applier<K, V, T, D>
impl<K, V, T, D> Unpin for Applier<K, V, T, D>
impl<K, V, T, D> !UnwindSafe for Applier<K, V, T, D>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> FutureExt for T
impl<T> FutureExt for T
source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> ProgressEventTimestamp for T
impl<T> ProgressEventTimestamp for T
source§impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
source§fn into_rust(self) -> Result<R, TryFromProtoError>
fn into_rust(self) -> Result<R, TryFromProtoError>
RustType::from_proto
.source§fn from_rust(rust: &R) -> P
fn from_rust(rust: &R) -> P
RustType::into_proto
.source§impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
source§fn plus_equals(&mut self, rhs: &&'a S)
fn plus_equals(&mut self, rhs: &&'a S)
std::ops::AddAssign
, for types that do not implement AddAssign
.