StreamingQuery 类

定义

命名空间:

Microsoft.Spark.Sql.Streaming

程序集:

Microsoft.Spark.dll

包:

Microsoft.Spark v1.0.0

新数据到达时在后台持续执行的查询句柄。

public sealed class StreamingQuery

type StreamingQuery = class

Public NotInheritable Class StreamingQuery

继承

Object

StreamingQuery

属性

Id	返回此查询的唯一 ID，该查询在从检查点数据重启时保留。 也就是说，首次启动查询时会生成此 ID，每次从检查点数据重启查询时，该 ID 将相同。 另请参阅：RunId。
Name	返回用户指定的查询名称，如果未指定，则返回 null。
RunId	返回此查询运行的唯一 ID。 也就是说，每次启动/重启查询都将生成唯一的 runId。 因此，每次从检查点重启查询时，查询将具有相同 Id 但不同的 RunId。

方法

AwaitTermination()	等待停止 () 或异常终止此查询。
AwaitTermination(Int64)	如果此查询在超时（以毫秒为单位）内终止，则返回 true。
Exception()	如果查询因异常终止，则 StreamingQueryException 为 ;否则为 null。
Explain(Boolean)	将物理计划打印到控制台以进行调试。
IsActive()	如果此查询正在主动运行，则返回 true。
ProcessAllAvailable()	阻止，直到源中的所有可用数据都已处理并提交到接收器。 此方法用于测试。 请注意，在不断到达数据的情况下，此方法可能会永久阻止。 此外，此方法仅保证在调用之前已同步追加数据到 org.apache.spark.sql.execution.streaming.Source 的数据阻止。 (即 getOffset 必须立即反映添加) 。
Stop()	如果此查询正在运行，则停止执行该查询。 此方法将一直阻止，直到执行执行的线程停止。