Class

org.apache.spark.sql.streaming

StreamingQueryManager

Related Doc: package streaming

Permalink

class StreamingQueryManager extends AnyRef

:: Experimental :: A class to manage all the StreamingQuery active on a SparkSession.

Annotations
@Experimental() @Evolving()
Source
StreamingQueryManager.scala
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. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def active: Array[StreamingQuery]

    Permalink

    Returns a list of active queries associated with this SQLContext

    Returns a list of active queries associated with this SQLContext

    Since

    2.0.0

  5. def addListener(listener: StreamingQueryListener): Unit

    Permalink

    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

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def awaitAnyTermination(timeoutMs: Long): Boolean

    Permalink

    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( ... )
    Since

    2.0.0

    Exceptions thrown

    StreamingQueryException if any query has terminated with an exception

  8. def awaitAnyTermination(): Unit

    Permalink

    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( ... )
    Since

    2.0.0

    Exceptions thrown

    StreamingQueryException if any query has terminated with an exception

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def get(id: String): StreamingQuery

    Permalink

    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

  14. def get(id: UUID): StreamingQuery

    Permalink

    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

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. def removeListener(listener: StreamingQueryListener): Unit

    Permalink

    Deregister a StreamingQueryListener.

    Deregister a StreamingQueryListener.

    Since

    2.0.0

  22. def resetTerminated(): Unit

    Permalink

    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

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped