Query Management

StreamingQuery.awaitTermination ([timeout])

等待 查询的终止,无论是通过 query.stop() 还是通过异常。

StreamingQuery.exception ()

新增于版本 2.1.0。

StreamingQuery.explain ([extended])

打印(逻辑和物理)计划到控制台以进行调试目的。

StreamingQuery.id

返回此查询的唯一ID,该ID在从检查点数据重新启动时保持不变。

StreamingQuery.isActive

此流查询当前是否处于活动状态。

StreamingQuery.lastProgress

返回此流查询的最新 StreamingQueryProgress 更新,如果没有进度更新则返回 None

StreamingQuery.name

返回用户指定的查询名称,如果未指定则返回null。

StreamingQuery.processAllAvailable ()

阻塞直到源中所有可用数据都已处理并提交到接收器。

StreamingQuery.recentProgress

返回此查询的最近 [[StreamingQueryProgress]] 更新数组。

StreamingQuery.runId

返回此查询的唯一ID,该ID不会在重启后保持不变。

StreamingQuery.status

返回查询的当前状态。

StreamingQuery.stop ()

停止此流查询。

StreamingQueryManager.active

返回与此 SparkSession 关联的活动查询列表

StreamingQueryManager.addListener (监听器)

注册一个 StreamingQueryListener 以接收 StreamingQuery 生命周期事件的回调。

StreamingQueryManager.awaitAnyTermination ([…])

等待直到与关联的 SparkSession 上的任何查询在上下文创建后终止,或自调用 resetTerminated() 以来终止。

StreamingQueryManager.get (id)

返回从此 SparkSession 激活的查询。

StreamingQueryManager.removeListener (listener)

注销一个 StreamingQueryListener

StreamingQueryManager.resetTerminated ()

忘记过去已终止的查询,以便可以再次使用 awaitAnyTermination() 来等待新的终止。