addListener (StreamingQueryManager)

Registers a StreamingQueryListener to receive lifecycle event callbacks for streaming queries.

Syntax

addListener(listener)

Parameters

Parameter	Type	Description
listener	StreamingQueryListener	The listener to register.

Returns

None

Notes

In Spark Connect mode, the provided listener does not have access to variables defined outside of it. Use self.spark instead of spark to access the session inside the listener in Connect mode.

Examples

Python

from pyspark.sql.streaming import StreamingQueryListener

class TestListener(StreamingQueryListener):
    def onQueryStarted(self, event):
        pass

    def onQueryProgress(self, event):
        pass

    def onQueryIdle(self, event):
        pass

    def onQueryTerminated(self, event):
        pass

test_listener = TestListener()
spark.streams.addListener(test_listener)
spark.streams.removeListener(test_listener)