ストリーミング クエリのトリガーを設定します。 設定されていない場合、クエリは可能な限り高速に実行され、 processingTime='0 seconds'と同じです。 一度に設定できるトリガー パラメーターは 1 つだけです。
詳細については、「 構造化ストリーミング トリガー間隔の構成」を参照してください。
構文
trigger(*, processingTime=None, once=None, continuous=None, availableNow=None, realTime=None)
パラメーター
| パラメーター | タイプ | 説明 |
|---|---|---|
processingTime |
str、省略可能 | 処理時間間隔文字列 (たとえば、 '5 seconds'、 '1 minute')。 処理時間に基づいてマイクロバッチ クエリを定期的に実行します。 |
once |
bool、省略可能 |
True場合は、データのバッチを 1 つだけ処理し、クエリを終了します。 |
continuous |
str、省略可能 | 時間間隔文字列 (たとえば、 '5 seconds')。 指定されたチェックポイント間隔で連続クエリを実行します。 |
availableNow |
bool、省略可能 |
True場合は、使用可能なすべてのデータを複数のバッチで処理し、クエリを終了します。 |
realTime |
str、省略可能 | バッチ期間文字列 (たとえば、 '5 seconds')。 指定した期間にバッチを使用して、リアルタイム モードのクエリを実行します。 |
返品
DataStreamWriter
例示
df = spark.readStream.format("rate").load()
5 秒ごとに実行をトリガーします。
df.writeStream.trigger(processingTime='5 seconds')
# <...streaming.readwriter.DataStreamWriter object ...>
5 秒ごとに継続的な実行をトリガーします。
df.writeStream.trigger(continuous='5 seconds')
# <...streaming.readwriter.DataStreamWriter object ...>
使用可能なすべてのデータを複数のバッチで処理します。
df.writeStream.trigger(availableNow=True)
# <...streaming.readwriter.DataStreamWriter object ...>
5 秒ごとにリアルタイム実行をトリガーします。
df.writeStream.trigger(realTime='5 seconds')
# <...streaming.readwriter.DataStreamWriter object ...>