Struct StreamingQueryResult 

pub struct StreamingQueryResult { /* private fields */ }

Implementations

impl StreamingQueryResult

pub fn new(stream: ResultStream, runtime: Arc<ExecutionRuntime>) -> Self

Wrap a ResultStream into a thread-safe handle.

pub fn new_with_schema( stream: ResultStream, runtime: Arc<ExecutionRuntime>, col_names: Vec<String>, ) -> Self

Wrap a stream with the schema fixed by the physical output contract. This keeps empty results observable without waiting for a first chunk.

pub fn from_execution_result(result: ExecutionResult) -> Self

Create a pre-materialized result from an ExecutionResult.

The result is returned as a single chunk on the first next_chunk() call. Useful for EXPLAIN/PROFILE results that are already materialized.

pub fn next_chunk(&self) -> Result<Option<DataChunk>, QueryError>

Pull the next chunk of results.

Returns Ok(None) when the stream is exhausted. Returns an error if the query has been cancelled.

pub fn cancel(&self)

Cancel the query execution.

pub fn is_cancelled(&self) -> bool

Check whether the query has been cancelled.

pub fn close(&self) -> Result<(), QueryError>

Close the stream and release resources.

pub fn collect(&self) -> Result<DataSet, QueryError>

Consume all remaining chunks and materialise into a DataSet.

Routes through LocalChunkCollector, the single terminal collection logic shared with convert_chunks_to_dataset and ResultStream::collect.

pub fn column_names(&self) -> Option<Vec<String>>

Return column names if known.

For materialized results, column names are available immediately. For streaming results, they are available after the first chunk is pulled (or None if no chunk was ever produced).

pub fn runtime(&self) -> &ExecutionRuntime

Access the underlying execution runtime (for profiling, cancel, etc.)

pub fn runtime_downgrade(&self) -> Weak<ExecutionRuntime>

Return a Weak reference to the execution runtime for KILL QUERY registration.

pub fn set_on_drop(&self, f: Box<dyn FnOnce() + Send>)

Register a cleanup callback that fires when this handle is dropped.

Used by the API layer to deregister the query from the session when the stream ends (via either completion, error, or client disconnect).

pub fn set_transaction_finalizer( &self, commit: Box<dyn FnOnce() + Send>, abort: Box<dyn FnOnce() + Send>, )

Register a transaction finalizer that fires when the stream is dropped.

• commit: called when the stream is fully consumed without error.
• abort: called on error, cancellation, or premature drop.

Only one finalizer can be registered. The on_drop callback is used internally to invoke the appropriate branch.

pub fn set_transaction_finalizer_with_result( &self, commit: Box<dyn FnOnce() -> Result<(), String> + Send>, abort: Box<dyn FnOnce() -> Result<(), String> + Send>, )

Register a finalizer whose error is returned at stream exhaustion. A finalizer triggered by Drop logs the error because no result can be returned after ownership has been released.

pub fn set_fallback_column_names(&self, names: Vec<String>)

Set fallback column names that are available even before the first chunk is pulled (or when the result set is empty).

Only takes effect when no chunk has been received yet (i.e. the cached column names are None). Once a chunk arrives its column names take precedence and the fallback is ignored.

Trait Implementations

impl Clone for StreamingQueryResult

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for StreamingQueryResult

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.