class StreamingQueryManager extends Logging
A class to manage all the StreamingQuery active in a SparkSession.
- Annotations
- @Evolving()
- Source
- StreamingQueryManager.scala
- Since
2.0.0
- Alphabetic
- By Inheritance
- StreamingQueryManager
- Logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- implicit class LogStringContext extends AnyRef
- Definition Classes
- Logging
Value Members
- def active: Array[StreamingQuery]
Returns a list of active queries associated with this SQLContext
Returns a list of active queries associated with this SQLContext
- Since
2.0.0
- def addListener(listener: StreamingQueryListener): Unit
Register a StreamingQueryListener to receive up-calls for life cycle events of StreamingQuery.
Register a StreamingQueryListener to receive up-calls for life cycle events of StreamingQuery.
- Since
2.0.0
- def awaitAnyTermination(timeoutMs: Long): Boolean
Wait until any of the queries on the associated SQLContext has terminated since the creation of the context, or since
resetTerminated()was called.Wait until any of the queries on the associated SQLContext has terminated since the creation of the context, or since
resetTerminated()was called. Returns whether any query has terminated or not (multiple may have terminated). If any query has terminated with an exception, then the exception will be thrown.If a query has terminated, then subsequent calls to
awaitAnyTermination()will either returntrueimmediately (if the query was terminated byquery.stop()), or throw the exception immediately (if the query was terminated with exception). UseresetTerminated()to clear past terminations and wait for new terminations.In the case where multiple queries have terminated since
resetTermination()was called, if any query has terminated with exception, thenawaitAnyTermination()will throw any of the exception. For correctly documenting exceptions across multiple queries, users need to stop all of them after any of them terminates with exception, and then check thequery.exception()for each query.- Annotations
- @throws(scala.this.throws.<init>$default$1[org.apache.spark.sql.streaming.StreamingQueryException])
- Since
2.0.0
- Exceptions thrown
StreamingQueryExceptionif any query has terminated with an exception
- def awaitAnyTermination(): Unit
Wait until any of the queries on the associated SQLContext has terminated since the creation of the context, or since
resetTerminated()was called.Wait until any of the queries on the associated SQLContext has terminated since the creation of the context, or since
resetTerminated()was called. If any query was terminated with an exception, then the exception will be thrown.If a query has terminated, then subsequent calls to
awaitAnyTermination()will either return immediately (if the query was terminated byquery.stop()), or throw the exception immediately (if the query was terminated with exception). UseresetTerminated()to clear past terminations and wait for new terminations.In the case where multiple queries have terminated since
resetTermination()was called, if any query has terminated with exception, thenawaitAnyTermination()will throw any of the exception. For correctly documenting exceptions across multiple queries, users need to stop all of them after any of them terminates with exception, and then check thequery.exception()for each query.- Annotations
- @throws(scala.this.throws.<init>$default$1[org.apache.spark.sql.streaming.StreamingQueryException])
- Since
2.0.0
- Exceptions thrown
StreamingQueryExceptionif any query has terminated with an exception
- def get(id: String): StreamingQuery
Returns the query if there is an active query with the given id, or null.
Returns the query if there is an active query with the given id, or null.
- Since
2.1.0
- def get(id: UUID): StreamingQuery
Returns the query if there is an active query with the given id, or null.
Returns the query if there is an active query with the given id, or null.
- Since
2.1.0
- def listListeners(): Array[StreamingQueryListener]
List all StreamingQueryListeners attached to this StreamingQueryManager.
List all StreamingQueryListeners attached to this StreamingQueryManager.
- Since
3.0.0
- def removeListener(listener: StreamingQueryListener): Unit
Deregister a StreamingQueryListener.
Deregister a StreamingQueryListener.
- Since
2.0.0
- def resetTerminated(): Unit
Forget about past terminated queries so that
awaitAnyTermination()can be used again to wait for new terminations.Forget about past terminated queries so that
awaitAnyTermination()can be used again to wait for new terminations.- Since
2.0.0