abstract class StreamingQueryManager extends AnyRef
A class to manage all the StreamingQuery active in a SparkSession
.
- Annotations
- @Evolving()
- Since
2.0.0
- Alphabetic
- By Inheritance
- StreamingQueryManager
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new StreamingQueryManager()
Abstract Value Members
- abstract 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
- abstract def addListener(listener: StreamingQueryListener): Unit
Register a org.apache.spark.sql.streaming.StreamingQueryListener to receive up-calls for life cycle events of StreamingQuery.
Register a org.apache.spark.sql.streaming.StreamingQueryListener to receive up-calls for life cycle events of StreamingQuery.
- Since
2.0.0
- abstract 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 returntrue
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
org.apache.spark.sql.streaming.StreamingQueryException
if any query has terminated with an exception
- abstract 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
org.apache.spark.sql.streaming.StreamingQueryException
if any query has terminated with an exception
- abstract 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
- abstract 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
- abstract def listListeners(): Array[StreamingQueryListener]
List all org.apache.spark.sql.streaming.StreamingQueryListeners attached to this StreamingQueryManager.
List all org.apache.spark.sql.streaming.StreamingQueryListeners attached to this StreamingQueryManager.
- Since
3.0.0
- abstract def removeListener(listener: StreamingQueryListener): Unit
Deregister a org.apache.spark.sql.streaming.StreamingQueryListener.
Deregister a org.apache.spark.sql.streaming.StreamingQueryListener.
- Since
2.0.0
- abstract 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
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)