pyspark.sql.streaming.StreamingQuery.status

property StreamingQuery.status

Returns the current status of the query.

New in version 2.1.0.

Changed in version 3.5.0: Supports Spark Connect.

Returns

dict

The current status of the specified query.

Examples

>>> sdf = spark.readStream.format("rate").load()
>>> sq = sdf.writeStream.format('memory').queryName('this_query').start()

Get the current status of the query

>>> sq.status
{'message': '...', 'isDataAvailable': ..., 'isTriggerActive': ...}

>>> sq.stop()