read_state_metadata
テーブル値関数
適用対象: Databricks SQL Databricks Runtime 14.3 以降
ストリーミング クエリ状態のメタデータを表す行を含むテーブルを返します。
ストリーミング クエリ ステートフル演算子のメタデータを読み取るためのテーブル値関数。 バッチ クエリとしての実行のみをサポートします。
構文
read_state_metadata(path)
引数
この関数には、オプション キーの名前付きパラメーター呼び出しが必要です。
path
: ストリーミング クエリ チェックポイントの場所のパスを含むSTRING
リテラル。
返品
状態メタデータのテーブルには、次のスキーマがあります。 すべての列は NOT 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');