name (StreamingQuery)

Returns the user-specified name of the query, or None if not specified. Set via df.writeStream.queryName("query").start(). If set, this name must be unique across all active queries.

Returns

str or None

Examples

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