Struct StreamingQueryManager 

pub struct StreamingQueryManager { /* private fields */ }

Manager for active streaming queries.

Mirrors pyspark.sql.connect.streaming.StreamingQueryManager, including a native client-side listener bus (so Rust clients get the listener feature too).

Implementations

impl StreamingQueryManager

pub fn add_listener( &self, listener: Arc<dyn StreamingQueryListener>, ) -> Result<String>

Register a client-side listener. Returns an id that can be passed to StreamingQueryManager::remove_listener. Starts the background dispatch thread when it is the first listener. Mirrors StreamingQueryManager.addListener.

pub fn remove_listener(&self, id: &str) -> Result<()>

Remove a client-side listener by id. Stops the background dispatch thread when the last listener is removed. Mirrors StreamingQueryManager.removeListener.

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

Remove all client-side listeners and stop the dispatch thread. Mirrors StreamingQueryManager.close.

pub fn active(&self) -> Result<Vec<StreamingQuery>>

Get all active streaming queries.

pub fn get(&self, id: &str) -> Result<Option<StreamingQuery>>

Get a specific streaming query by ID.

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

Wait for any streaming query to terminate with optional timeout in seconds.

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

Reset terminated streaming queries.

pub fn register_python_listener( &self, payload: PythonUDFPayload, ) -> Result<String>

Register a server-side listener from a cloudpickled PythonUDF payload (the server runs it in a Python worker). This is distinct from the client-side listener bus (add_listener); it sends the AddListener manager command and returns the server listener id.

pub fn unregister_python_listener(&self, listener_id: &str) -> Result<()>

Remove a server-side listener registered via register_python_listener, by id.

pub fn listener_event_stream(&self) -> Result<ListenerEventStream>

Stream listener events from the server incrementally (live). Returns a ListenerEventStream that yields events as they arrive.