Skip to main content

EmitStrategy

Enum EmitStrategy 

Source
pub enum EmitStrategy {
    OnWatermark,
    Periodic(Duration),
    OnUpdate,
    OnWindowClose,
    Changelog,
    Final,
}
Expand description

Strategy for when window results should be emitted.

This controls the trade-off between result freshness and efficiency:

  • OnWatermark is most efficient but has highest latency
  • Periodic balances freshness and efficiency
  • OnUpdate provides lowest latency but highest overhead
  • OnWindowClose (F011B) is for append-only sinks
  • Changelog (F011B) emits Z-set weighted records for CDC
  • Final (F011B) suppresses all intermediate results

Variants§

§

OnWatermark

Emit final results when watermark passes window end (default).

This is the most efficient strategy as it only emits once per window. Results are guaranteed to be complete (within allowed lateness bounds). May emit retractions if late data arrives within lateness bounds.

§

Periodic(Duration)

Emit intermediate results at fixed intervals.

Useful for dashboards and monitoring where periodic updates are needed before the window closes. The final result is still emitted on watermark.

The duration specifies the interval between periodic emissions.

§

OnUpdate

Emit updated results after every state change.

This provides the lowest latency for result visibility but has the highest overhead. Each incoming event triggers an emission.

Use with caution for high-volume streams.

§

OnWindowClose

Emit ONLY when watermark passes window end. No intermediate emissions.

Critical for append-only sinks (Kafka, S3, Delta Lake, Iceberg). Unlike OnWatermark, this NEVER emits before window close, even with late data retractions. Late data is buffered until next window close.

Key difference from OnWatermark:

  • OnWatermark: May emit retractions for late data
  • OnWindowClose: Buffers late data, only emits final result

SQL: EMIT ON WINDOW CLOSE

§

Changelog

Emit changelog records with Z-set weights.

Every emission includes operation type and weight:

  • Insert (+1 weight)
  • Delete (-1 weight)
  • Update (retraction pair: -1 old, +1 new)

Required for:

  • CDC pipelines
  • Cascading materialized views (F060)
  • Downstream consumers that need to track changes

SQL: EMIT CHANGES

§

Final

Suppress ALL intermediate results, emit only finalized.

Similar to OnWindowClose but also suppresses:

  • Periodic emissions (even if Periodic was set elsewhere)
  • Late data retractions (drops late data entirely after window close)

Use for BI reporting where only final, exact results matter.

SQL: EMIT FINAL

Implementations§

Source§

impl EmitStrategy

Source

pub fn needs_periodic_timer(&self) -> bool

Returns true if this strategy requires periodic timer registration.

Source

pub fn periodic_interval(&self) -> Option<Duration>

Returns the periodic interval if this is a periodic strategy.

Source

pub fn emits_on_update(&self) -> bool

Returns true if results should be emitted on every update.

Source

pub fn emits_intermediate(&self) -> bool

Returns true if this strategy emits intermediate results.

Strategies that emit intermediate results (before window close):

  • OnUpdate: emits after every state change
  • Periodic: emits at fixed intervals

Strategies that do NOT emit intermediate results:

  • OnWatermark: waits for watermark
  • OnWindowClose: only emits when window closes
  • Changelog: depends on trigger, but typically on watermark
  • Final: only emits final result
Source

pub fn requires_changelog(&self) -> bool

Returns true if this strategy requires changelog/Z-set support.

The Changelog strategy requires the operator to track previous values and emit insert/delete/update records with weights.

Source

pub fn is_append_only_compatible(&self) -> bool

Returns true if this strategy is suitable for append-only sinks.

Append-only sinks (Kafka, S3, Delta Lake, Iceberg) cannot handle retractions or updates. Only these strategies are safe:

  • OnWindowClose: guarantees single emission per window
  • Final: suppresses all intermediate results
Source

pub fn generates_retractions(&self) -> bool

Returns true if late data should generate retractions.

Strategies that generate retractions for late data:

  • OnWatermark: may retract previous result
  • OnUpdate: immediately emits updated result
  • Changelog: emits -old/+new pair

Strategies that do NOT generate retractions:

  • OnWindowClose: buffers late data
  • Final: drops late data
  • Periodic: depends on whether window is still open
Source

pub fn suppresses_intermediate(&self) -> bool

Returns true if this strategy should suppress intermediate emissions.

Used to override periodic timers when a suppressing strategy is active.

Source

pub fn drops_late_data(&self) -> bool

Returns true if late data should be dropped entirely.

The Final strategy drops late data to ensure only exact, finalized results are emitted.

Trait Implementations§

Source§

impl Clone for EmitStrategy

Source§

fn clone(&self) -> EmitStrategy

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EmitStrategy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EmitStrategy

Source§

fn default() -> EmitStrategy

Returns the “default value” for a type. Read more
Source§

impl PartialEq for EmitStrategy

Source§

fn eq(&self, other: &EmitStrategy) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for EmitStrategy

Source§

impl StructuralPartialEq for EmitStrategy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,