read_state_metadata 表值函数

  • 项目

适用于：check marked yes Databricks Runtime 14.3 及更高版本

返回一个表，其中包含表示流式处理查询状态元数据的行。

用于读取流式处理查询有状态运算符元数据的表值函数。 它仅支持作为批查询运行。

语法

read_state_metadata(path)

参数

此函数需要用于选项键的命名参数调用。

  • path：包含流式处理查询检查点位置路径的 STRING 文本。

返回

状态元数据表具有以下架构。 所有列均不为 NULL。

  • operatorId INT NOT NULL

    有状态流式处理运算符的整数 ID。

  • operatorName STRING NOT NULL

    有状态流式处理运算符的名称。

  • stateStoreName STRING NOT NULL

    运算符的状态存储的名称。

  • numPartitions INT NOT NULL

    状态存储的分区数。

  • minBatchId BIGINT NOT NULL

    可用于查询状态的最小批 ID。 如果采用检查点的流式处理查询正在运行，则该值可能无效，因为它会导致清理运行。

  • maxBatchId BIGINT NOT NULL

    可用于查询状态的最大批 ID。 如果采用检查点的流式处理查询正在运行，则该值可能无效，因为该查询将提交更多的批。

示例

- Read state metadata from the checkpoint
> SELECT * FROM read_state_metadata('/checkpoint/path');