org.apache.spark.sql.streaming

Class Trigger

Object

org.apache.spark.sql.streaming.Trigger

Direct Known Subclasses:

ProcessingTime

@InterfaceStability.Evolving
public class Trigger
extends Object

Policy used to indicate how often results should be produced by a [[StreamingQuery]].

Since:

2.0.0

Constructor Summary

Constructors

Constructor and Description
Trigger()

Method Summary

Modifier and Type	Method and Description
static Trigger	Once() A trigger that process only one batch of data in a streaming query then terminates the query.
static Trigger	ProcessingTime(scala.concurrent.duration.Duration interval) (Scala-friendly) A trigger policy that runs a query periodically based on an interval in processing time.
static Trigger	ProcessingTime(long intervalMs) A trigger policy that runs a query periodically based on an interval in processing time.
static Trigger	ProcessingTime(long interval, java.util.concurrent.TimeUnit timeUnit) (Java-friendly) A trigger policy that runs a query periodically based on an interval in processing time.
static Trigger	ProcessingTime(String interval) A trigger policy that runs a query periodically based on an interval in processing time.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Trigger

public Trigger()

Method Detail

ProcessingTime

public static Trigger ProcessingTime(long intervalMs)

A trigger policy that runs a query periodically based on an interval in processing time. If `interval` is 0, the query will run as fast as possible.

Since:

2.2.0

ProcessingTime

public static Trigger ProcessingTime(long interval,
                                     java.util.concurrent.TimeUnit timeUnit)

(Java-friendly) A trigger policy that runs a query periodically based on an interval in processing time. If `interval` is 0, the query will run as fast as possible. {{{ import java.util.concurrent.TimeUnit df.writeStream.trigger(ProcessingTime.create(10, TimeUnit.SECONDS)) }}}

Since:

2.2.0

ProcessingTime

public static Trigger ProcessingTime(scala.concurrent.duration.Duration interval)

(Scala-friendly) A trigger policy that runs a query periodically based on an interval in processing time. If `duration` is 0, the query will run as fast as possible. {{{ import scala.concurrent.duration._ df.writeStream.trigger(ProcessingTime(10.seconds)) }}}

Since:

2.2.0

ProcessingTime

public static Trigger ProcessingTime(String interval)

A trigger policy that runs a query periodically based on an interval in processing time. If `interval` is effectively 0, the query will run as fast as possible. {{{ df.writeStream.trigger(Trigger.ProcessingTime("10 seconds")) }}}

Since:

2.2.0

Once

public static Trigger Once()

A trigger that process only one batch of data in a streaming query then terminates the query.

Since:

2.2.0