awaitTermination(): Unit
awaitTermination(timeoutMs: Long): Boolean
StreamingQuery Contract
StreamingQuery
is the contract of streaming queries that are executed continuously and concurrently (i.e. on a separate thread).
Note
|
StreamingQuery is called continuous query or streaming query.
|
Note
|
StreamingQuery is a Scala trait with the only implementation being StreamExecution (and less importanly StreamingQueryWrapper for serializing a non-serializable StreamExecution ).
|
Method | Description |
---|---|
|
Used when…FIXME |
|
Used when…FIXME |
|
Used when…FIXME |
|
The unique identifier of the streaming query (that does not change across restarts unlike runId) Used when…FIXME |
|
Indicates whether the streaming query is active ( Used when…FIXME |
|
The last StreamingQueryProgress of the streaming query Used when…FIXME |
|
The name of the query that is unique across all active queries Used when…FIXME |
|
Pauses (blocks) the current thread until the streaming query has no more data to be processed or has been stopped Intended for testing |
|
Collection of the recent StreamingQueryProgress updates. Used when…FIXME |
|
The unique identifier of the current execution of the streaming query (that is different every restart unlike id) Used when…FIXME |
|
Used when…FIXME |
|
StreamingQueryStatus of the streaming query (as Used when…FIXME |
|
Stops the streaming query |
StreamingQuery
can be in two states:
-
active (started)
-
inactive (stopped)
If inactive, StreamingQuery
may have transitioned into the state due to an StreamingQueryException
(that is available under exception
).
StreamingQuery
tracks current state of all the sources, i.e. SourceStatus
, as sourceStatuses
.
StreamingQuery
can be stopped by stop
or an exception.