Skip to main content

get (StreamingQueryManager)

Returns an active streaming query from this SparkSession by its unique ID.

Syntax​

get(id)

Parameters​

Parameter

Type

Description

id

str

The unique ID of the query.

Parameter

Type

Description

id

str

The unique ID of the query.

Returns​

StreamingQuery

Notes​

An exception is thrown if an active query with the given ID does not exist.

Examples​

Python
sdf = spark.readStream.format("rate").load()
sq = sdf.writeStream.format('memory').queryName('this_query').start()
sq = spark.streams.get(sq.id)
sq.isActive
# True
sq.stop()