Struct StreamingQuery 

pub struct StreamingQuery { /* private fields */ }

A handle to an active streaming query.

Mirrors pyspark.sql.connect.streaming.StreamingQuery.

Implementations

impl StreamingQuery

pub fn id(&self) -> &str

Get the query ID.

pub fn run_id(&self) -> &str

Get the run ID.

pub fn name(&self) -> Option<&str>

Get the query name.

pub fn is_active(&self) -> Result<bool>

Check if the query is actively running.

pub fn status(&self) -> Result<StreamingQueryStatus>

Get the current status of the query.

pub fn stop(&self) -> Result<()>

Stop the streaming query.

pub fn await_termination( &self, timeout_sec: Option<f64>, ) -> Result<Option<bool>>

Wait for the query to terminate with optional timeout in seconds.

pub fn last_progress(&self) -> Result<Option<String>>

Get the last streaming progress, if available.

pub fn recent_progress(&self) -> Result<Vec<String>>

Get recent streaming progress results.

pub fn process_all_available(&self) -> Result<()>

Process all available data in the streaming query.

pub fn explain(&self, extended: bool) -> Result<String>

Print the execution plan of the streaming query.

pub fn exception(&self) -> Result<Option<StreamingQueryException>>

Get any exception that occurred in the streaming query.

Trait Implementations

impl Clone for StreamingQuery

fn clone(&self) -> StreamingQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.