RealTimeTrigger¶

RealTimeTrigger is a Trigger with a positive batch duration in MicroBatchExecution stream execution engine.

RealTimeTrigger is executed using ProcessingTimeExecutor (when MicroBatchExecution is requested for a TriggerExecutor).

When requested to create a streaming query, StreamingQueryManager asserts that the batch duration is at least the value of spark.sql.streaming.realTimeMode.minBatchDuration configuration property.

When requested to start a streaming query, DataStreamWriter asserts that a sink is allowed.

Creating Instance¶

RealTimeTrigger takes the following to be created:

• Batch duration (in millis)

RealTimeTrigger is created using apply or create utility methods.

RealTimeTrigger.apply¶

apply(): RealTimeTrigger
apply(
  batchDuration: String): RealTimeTrigger
apply(
  batchDuration: Duration): RealTimeTrigger

apply creates a RealTimeTrigger.

RealTimeTrigger.create¶

create(
  batchDuration: String): RealTimeTrigger
create(
  batchDuration: Long,
  unit: TimeUnit): RealTimeTrigger

create creates a RealTimeTrigger.