awaitTermination (StreamingQuery)

stop()または例外によって、このクエリの終了を待機します。 クエリが例外で終了した場合、例外がスローされます。 timeoutが設定されている場合は、タイムアウト時間内にクエリが終了したかどうかを返します。

クエリが既に終了している場合、後続の呼び出しは直ちに返されるか (正常に停止した場合)、または例外を直ちにスローします (例外で終了した場合)。

構文

awaitTermination(timeout=None)

パラメーター

パラメーター タイプ 説明
timeout int、省略可能 待機する秒数。 設定されていない場合は、無期限に待機します。

返品

bool または None

Trueが設定されている場合はFalseまたはtimeoutを返し、クエリがタイムアウト内で終了したかどうかを示します。 タイムアウトが設定されていない場合は None を返します。

例示

sdf = spark.readStream.format("rate").load()
sq = sdf.writeStream.format('memory').queryName('query_awaitTermination').start()
sq.awaitTermination(5)
# False
sq.stop()