Skip to main content

execute_streaming_sql

Function execute_streaming_sql 

Source
pub async fn execute_streaming_sql(
    sql: &str,
    ctx: &SessionContext,
    planner: &mut StreamingPlanner,
) -> Result<StreamingSqlResult, Error>
Expand description

Executes a streaming SQL statement end-to-end.

This function performs the full pipeline:

  1. Parse SQL with streaming extensions (CREATE SOURCE/SINK, windows, etc.)
  2. Plan via StreamingPlanner
  3. For DDL: return the streaming plan as DdlResult
  4. For queries with streaming features: create LogicalPlan via DataFusion, execute, and return stream + QueryPlan metadata
  5. For standard SQL: pass through to DataFusion directly

§Arguments

  • sql - The SQL statement to execute
  • ctx - DataFusion session context (should have streaming functions registered)
  • planner - Streaming planner with registered sources/sinks

§Errors

Returns Error if parsing, planning, or execution fails.