Packages

c

org.apache.spark.sql.streaming

StreamingQueryManager

abstract class StreamingQueryManager extends AnyRef

A class to manage all the StreamingQuery active in a SparkSession.

Annotations
@Evolving()
Since

2.0.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamingQueryManager
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StreamingQueryManager()

Abstract Value Members

  1. 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

  2. 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

  3. 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 return true immediately (if the query was terminated by query.stop()), or throw the exception immediately (if the query was terminated with exception). Use resetTerminated() 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, then awaitAnyTermination() 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 the query.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

  4. 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 by query.stop()), or throw the exception immediately (if the query was terminated with exception). Use resetTerminated() 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, then awaitAnyTermination() 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 the query.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

  5. 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

  6. 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

  7. abstract def listListeners(): Array[StreamingQueryListener]

    List all org.apache.spark.sql.streaming.StreamingQueryListeners attached to this StreamingQueryManager.

  8. abstract def removeListener(listener: StreamingQueryListener): Unit

    Deregister a org.apache.spark.sql.streaming.StreamingQueryListener.

  9. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped