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

Check if the query is actively running.

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

Get the current status of the query.

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

Stop the streaming query.

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

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

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

Get the last streaming progress, if available.

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

Get recent streaming progress results.

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

Process all available data in the streaming query.

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

Print the execution plan of the streaming query.

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

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.

impl StreamingQueryExt for StreamingQuery

fn is_active_async(&self) -> impl Future<Output = Result<bool>> + Send + 'static

Async StreamingQuery::is_active.

fn status_async( &self, ) -> impl Future<Output = Result<StreamingQueryStatus>> + Send + 'static

Async StreamingQuery::status.

fn stop_async(&self) -> impl Future<Output = Result<()>> + Send + 'static

Async StreamingQuery::stop.

fn await_termination_async( &self, timeout_sec: Option<f64>, ) -> impl Future<Output = Result<Option<bool>>> + Send + 'static

Async StreamingQuery::await_termination.

fn exception_async( &self, ) -> impl Future<Output = Result<Option<StreamingQueryException>>> + Send + 'static

Async StreamingQuery::exception.

fn last_progress_async( &self, ) -> impl Future<Output = Result<Option<String>>> + Send + 'static

Async StreamingQuery::last_progress.

fn recent_progress_async( &self, ) -> impl Future<Output = Result<Vec<String>>> + Send + 'static

Async StreamingQuery::recent_progress.

fn process_all_available_async( &self, ) -> impl Future<Output = Result<()>> + Send + 'static

Async StreamingQuery::process_all_available.

fn explain_async( &self, extended: bool, ) -> impl Future<Output = Result<String>> + Send + 'static

Async StreamingQuery::explain.