StreamingQuery (Spark 2.0.1 JavaDoc)

```
public interface StreamingQuery
```
:: Experimental :: A handle to a query that is executing continuously in the background as new data arrives. All these methods are thread-safe.

Since:

2.0.0

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`awaitTermination()` Waits for the termination of `this` query, either by `query.stop()` or by an exception.
`boolean`	`awaitTermination(long timeoutMs)` Waits for the termination of `this` query, either by `query.stop()` or by an exception.
`scala.Option<StreamingQueryException>`	`exception()` Returns the `StreamingQueryException` if the query was terminated by an exception.
`void`	`explain()` Prints the physical plan to the console for debugging purposes.
`void`	`explain(boolean extended)` Prints the physical plan to the console for debugging purposes.
`long`	`id()` Returns the unique id of this query.
`boolean`	`isActive()` Whether the query is currently active or not
`String`	`name()` Returns the name of the query.
`void`	`processAllAvailable()` Blocks until all available data in the source has been processed and committed to the sink.
`SinkStatus`	`sinkStatus()` Returns current status of the sink.
`SourceStatus[]`	`sourceStatuses()` Returns current status of all the sources.
`SparkSession`	`sparkSession()` Returns the `SparkSession` associated with `this`.
`void`	`stop()` Stops the execution of this query if it is running.

- Method Detail
  - name
```
String name()
```
    Returns the name of the query. This name is unique across all active queries. This can be set in the DataStreamWriter as dataframe.writeStream.queryName("query").start().
    
    Returns:
    (undocumented)
    Since:
    
    2.0.0
  - id
```
long id()
```
    Returns the unique id of this query. This id is automatically generated and is unique across all queries that have been started in the current process.
    
    Returns:
    (undocumented)
    Since:
    
    2.0.0
  - sparkSession
```
SparkSession sparkSession()
```
    Returns the SparkSession associated with this.
    
    Returns:
    (undocumented)
    Since:
    
    2.0.0
  - isActive
```
boolean isActive()
```
    Whether the query is currently active or not
    
    Returns:
    (undocumented)
    Since:
    
    2.0.0
  - exception
```
scala.Option<StreamingQueryException> exception()
```
    Returns the StreamingQueryException if the query was terminated by an exception.
    
    Returns:
    (undocumented)
    Since:
    
    2.0.0
  - sourceStatuses
```
SourceStatus[] sourceStatuses()
```
    Returns current status of all the sources.
    
    Returns:
    (undocumented)
    Since:
    
    2.0.0
  - sinkStatus
```
SinkStatus sinkStatus()
```
    Returns current status of the sink.
  - awaitTermination
```
void awaitTermination()
```
    Waits for the termination of this query, either by query.stop() or by an exception. If the query has terminated with an exception, then the exception will be thrown.
    If the query has terminated, then all subsequent calls to this method will either return immediately (if the query was terminated by stop()), or throw the exception immediately (if the query has terminated with exception).
    
    Throws:
    
    StreamingQueryException, - if this query has terminated with an exception.
    Since:
    
    2.0.0
  - awaitTermination
```
boolean awaitTermination(long timeoutMs)
```
    Waits for the termination of this query, either by query.stop() or by an exception. If the query has terminated with an exception, then the exception will be thrown. Otherwise, it returns whether the query has terminated or not within the timeoutMs milliseconds.
    If the query has terminated, then all subsequent calls to this method will either return true immediately (if the query was terminated by stop()), or throw the exception immediately (if the query has terminated with exception).
    
    Parameters:
    timeoutMs - (undocumented)
    
    Returns:
    (undocumented)
    
    Throws:
    
    StreamingQueryException, - if this query has terminated with an exception
    Since:
    
    2.0.0
  - processAllAvailable
```
void processAllAvailable()
```
    Blocks until all available data in the source has been processed and committed to the sink. This method is intended for testing. Note that in the case of continually arriving data, this method may block forever. Additionally, this method is only guaranteed to block until data that has been synchronously appended data to a Source prior to invocation. (i.e. getOffset must immediately reflect the addition).
    
    Since:
    
    2.0.0
  - stop
```
void stop()
```
    Stops the execution of this query if it is running. This method blocks until the threads performing execution has stopped.
    
    Since:
    
    2.0.0
  - explain
```
void explain()
```
    Prints the physical plan to the console for debugging purposes.
    
    Since:
    
    2.0.0
  - explain
```
void explain(boolean extended)
```
    Prints the physical plan to the console for debugging purposes.
    
    Parameters:
    extended - whether to do extended explain or not
    Since:
    
    2.0.0

Interface StreamingQuery

Method Summary

Method Detail

name

id

sparkSession

isActive

exception

sourceStatuses

sinkStatus

awaitTermination

awaitTermination

processAllAvailable

stop

explain

explain