Skip to main content

LookupJoinOperator

Struct LookupJoinOperator 

Source
pub struct LookupJoinOperator { /* private fields */ }
Expand description

Lookup join operator that enriches streaming events with external table data.

This operator caches lookup results in the state store to minimize external lookups. The cache uses processing-time-based TTL for expiration.

§Async Lookup Handling

Since the Operator trait is synchronous, async table lookups must be handled externally. Use LookupJoinOperator::pending_lookups to get keys that need to be looked up, and LookupJoinOperator::provide_lookup to provide the results.

For simple synchronous use cases, use LookupJoinOperator::process_with_lookup which accepts a closure for lookups.

Implementations§

Source§

impl LookupJoinOperator

Source

pub fn new(config: LookupJoinConfig) -> Self

Creates a new lookup join operator.

Source

pub fn with_id(config: LookupJoinConfig, operator_id: String) -> Self

Creates a new lookup join operator with explicit ID.

Source

pub fn config(&self) -> &LookupJoinConfig

Returns the configuration.

Source

pub fn metrics(&self) -> &LookupJoinMetrics

Returns the metrics.

Source

pub fn reset_metrics(&mut self)

Resets the metrics.

Source

pub fn pending_lookups(&self) -> &[Vec<u8>]

Returns keys that need external lookup.

After processing events, check this for keys that weren’t in the cache. Provide lookup results via provide_lookup.

Source

pub fn provide_lookup( &mut self, key: &[u8], result: Option<&RecordBatch>, ctx: &mut OperatorContext<'_>, ) -> OutputVec

Provides a lookup result for a pending key.

Call this after performing the async lookup to complete processing of pending events.

§Returns

Output events that can now be emitted after the lookup result is available.

Source

pub fn process_with_lookup<F>( &mut self, event: &Event, ctx: &mut OperatorContext<'_>, lookup_fn: F, ) -> OutputVec
where F: FnOnce(&[u8]) -> Option<RecordBatch>,

Processes an event with a synchronous lookup function.

This is a convenience method for cases where lookups can be done synchronously (e.g., from an in-memory table).

Trait Implementations§

Source§

impl Operator for LookupJoinOperator

Source§

fn process(&mut self, event: &Event, ctx: &mut OperatorContext<'_>) -> OutputVec

Process an incoming event
Source§

fn on_timer(&mut self, timer: Timer, ctx: &mut OperatorContext<'_>) -> OutputVec

Handle timer expiration
Source§

fn checkpoint(&self) -> OperatorState

Checkpoint the operator’s state
Source§

fn restore(&mut self, state: OperatorState) -> Result<(), OperatorError>

Restore from a checkpoint Read more

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> 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, 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