Databricks Scala Spark API
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.
- Alphabetic
- By Inheritance
- StreamingQueryListener
- AnyRef
- Any
- Hide All
- Show All
- 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,onQueryStartwill be called on all listeners beforeDataStreamWriter.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 ()