Class: StreamingQuery

eclairjs/sql/streaming.StreamingQuery

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

Constructor

new StreamingQuery()

Since:
  • EclairJS 0.7 Spark 2.0.0
Source:

Methods

awaitTermination(timeoutMsopt) → {Promise.<boolean>}

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:
Name Type Attributes Description
timeoutMs number <optional>
Since:
  • EclairJS 0.7 Spark 2.0.0
Source:
Throws:
StreamingQueryException, if `this` query has terminated with an exception
Returns:
Type
Promise.<boolean>

exception() → {StreamingQueryException}

Returns the StreamingQueryException if the query was terminated by an exception.
Since:
  • EclairJS 0.7 Spark 2.0.0
Source:
Returns:
Type
StreamingQueryException

explain(extendedopt) → {Promise.<Void>}

Prints the physical plan to the console for debugging purposes.
Parameters:
Name Type Attributes Description
extended boolean <optional>
 whether to do extended explain or not
Since:
  • EclairJS 0.7 Spark 2.0.0
Source:
Returns:
A Promise that resolves to nothing.
Type
Promise.<Void>

id() → {Promise.<number>}

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.
Since:
  • EclairJS 0.7 Spark 2.0.0
Source:
Returns:
Type
Promise.<number>

isActive() → {Promise.<boolean>}

Whether the query is currently active or not
Since:
  • EclairJS 0.7 Spark 2.0.0
Source:
Returns:
Type
Promise.<boolean>

name() → {Promise.<string>}

Returns the name of the query. This name is unique across all active queries. This can be set in the [[org.apache.spark.sql.DataStreamWriter DataStreamWriter]] as `dataframe.writeStream.queryName("query").start()`.
Since:
  • EclairJS 0.7 Spark 2.0.0
Source:
Returns:
Type
Promise.<string>

processAllAvailable() → {Promise.<Void>}

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:
  • EclairJS 0.7 Spark 2.0.0
Source:
Returns:
A Promise that resolves to nothing.
Type
Promise.<Void>

sinkStatus() → {SinkStatus}

Returns current status of the sink.
Source:
Returns:
Type
SinkStatus

sourceStatuses() → {Array.<SourceStatus>}

Returns current status of all the sources.
Since:
  • EclairJS 0.7 Spark 2.0.0
Source:
Returns:
Type
Array.<SourceStatus>

sparkSession() → {SparkSession}

Returns the SparkSession associated with `this`.
Since:
  • EclairJS 0.7 Spark 2.0.0
Source:
Returns:
Type
SparkSession

stop() → {Promise.<Void>}

Stops the execution of this query if it is running. This method blocks until the threads performing execution has stopped.
Since:
  • EclairJS 0.7 Spark 2.0.0
Source:
Returns:
A Promise that resolves to nothing.
Type
Promise.<Void>