Struct StreamingPlanner 

pub struct StreamingPlanner { /* private fields */ }

Streaming query planner

Implementations

impl StreamingPlanner

pub fn new() -> Self

Creates a new streaming planner

pub fn plan( &mut self, statement: &StreamingStatement, ) -> Result<StreamingPlan, PlanningError>

Plans a streaming statement.

Errors

Returns PlanningError if the statement cannot be planned.

pub fn plan_state_backed_join( &mut self, statement: &StreamingStatement, admission: &StateBackedJoinAdmission, ) -> Result<StreamingPlan, PlanningError>

Plan one query whose unbounded join shape has already been certified by the database as a durable state-backed incremental join.

This does not relax multi-way, join-type, temporal, or implicit-join validation. Raw stream callers must use Self::plan.

Errors

Returns PlanningError if the statement fails the remaining streaming checks.

pub fn unregister_query(&mut self, name: &str)

Remove query classification installed by a successful plan when the surrounding catalog transaction is rolled back or the query is dropped.

pub fn has_query(&self, name: &str) -> bool

Whether query classification state remains for a catalog object.

pub fn unregister_source(&mut self, name: &str)

Remove a source installed by a catalog transaction that was dropped or rolled back.

pub fn unregister_sink(&mut self, name: &str)

Remove a sink installed by a catalog transaction that was dropped or rolled back.

pub fn unregister_lookup_table(&mut self, name: &str)

Remove a lookup table installed by a catalog transaction that was dropped or rolled back.

pub fn get_source(&self, name: &str) -> Option<&SourceInfo>

Gets a registered source by name.

pub fn get_sink(&self, name: &str) -> Option<&SinkInfo>

Gets a registered sink by name.

pub fn list_sources(&self) -> Vec<&SourceInfo>

Lists all registered sources.

pub fn list_sinks(&self) -> Vec<&SinkInfo>

Lists all registered sinks.

pub fn get_lookup_table(&self, name: &str) -> Option<&LookupTableInfo>

Gets a registered lookup table by name.

pub fn list_lookup_tables(&self) -> Vec<&LookupTableInfo>

Lists all registered lookup tables.

pub fn lookup_tables_cloned(&self) -> HashMap<String, LookupTableInfo>

Returns a clone of the lookup tables map for optimizer rule construction.

pub async fn to_logical_plan( &self, plan: &QueryPlan, ctx: &SessionContext, ) -> Result<LogicalPlan, PlanningError>

Converts a query plan’s SQL statement into a DataFusion LogicalPlan. Window UDFs (TUMBLE, HOP, SESSION) must be registered on ctx via register_streaming_functions for windowed queries to resolve correctly.

Errors

Returns PlanningError if DataFusion cannot create the logical plan.

Trait Implementations

impl Default for StreamingPlanner

fn default() -> Self

Returns the “default value” for a type.