Databricks Scala Spark API < Back

Packages

package root

Definition Classes
root
package org

Definition Classes
root
package apache

Definition Classes
org
package spark
Core Spark functionality.
Core Spark functionality. org.apache.spark.SparkContext serves as the main entry point to Spark, while org.apache.spark.rdd.RDD is the data type representing a distributed collection, and provides most parallel operations.
In addition, org.apache.spark.rdd.PairRDDFunctions contains operations available only on RDDs of key-value pairs, such as groupByKey and join; org.apache.spark.rdd.DoubleRDDFunctions contains operations available only on RDDs of Doubles; and org.apache.spark.rdd.SequenceFileRDDFunctions contains operations available on RDDs that can be saved as SequenceFiles. These operations are automatically available on any RDD of the right type (e.g. RDD[(Int, Int)] through implicit conversions.
Java programmers should reference the org.apache.spark.api.java package for Spark programming APIs in Java.
Classes and methods marked with Experimental are user-facing features which have not been officially adopted by the Spark project. These are subject to change or removal in minor releases.
Classes and methods marked with Developer API are intended for advanced users want to extend Spark through lower level interfaces. These are subject to changes or removal in minor releases.

Definition Classes
apache
package sql
Allows the execution of relational queries, including those expressed in SQL using Spark.
Allows the execution of relational queries, including those expressed in SQL using Spark.

Definition Classes
spark
package streaming

Definition Classes
sql
DataStreamReader
DataStreamWriter
GroupState
GroupStateTimeout
OutputMode
SinkProgress
SourceProgress
StateOperatorProgress
StreamingQuery
StreamingQueryException
StreamingQueryListener
StreamingQueryManager
StreamingQueryProgress
StreamingQueryStatus
TestGroupState
Trigger

org.apache.spark.sql.streaming

StreamingQueryListener

Companion object StreamingQueryListener

abstract class StreamingQueryListener extends AnyRef

Interface for listening to events related to StreamingQueries.

Annotations: @Evolving()
Since: 2.0.0
Note: The methods are not thread-safe as they may be called from different threads.

Linear Supertypes

Ordering

Alphabetic
By Inheritance

Inherited

StreamingQueryListener
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new StreamingQueryListener()

Abstract Value Members

abstract def onQueryProgress(event: QueryProgressEvent): Unit
Called when there is some status update (ingestion rate updated, etc.)
Called when there is some status update (ingestion rate updated, etc.)

Since
2.0.0
Note
This method is asynchronous. The status in StreamingQuery will always be latest no matter when this method is called. Therefore, the status of StreamingQuery may be changed before/when you process the event. E.g., you may find StreamingQuery is terminated when you are processing QueryProgressEvent.
abstract def onQueryStarted(event: QueryStartedEvent): Unit
Called when a query is started.
Called when a query is started.

Since
2.0.0
Note
This is called synchronously with DataStreamWriter.start(), that is, onQueryStart will be called on all listeners before DataStreamWriter.start() returns the corresponding StreamingQuery. Please don't block this method as it will block your query.
abstract def onQueryTerminated(event: QueryTerminatedEvent): Unit
Called when a query is stopped, with or without error.
Called when a query is stopped, with or without error.

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( ... ) @native()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@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
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped