Skip to content

Commit 2d26bd8

Browse files
committed
fix docs
1 parent 3843395 commit 2d26bd8

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

R/pkg/R/DataFrame.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3715,8 +3715,8 @@ setMethod("isStreaming",
37153715
#' '1 minute'. This is a trigger that runs a query periodically based on the processing
37163716
#' time. If value is '0 seconds', the query will run as fast as possible, this is the
37173717
#' default. Only one trigger can be set.
3718-
#' @param trigger.once a logical, must be set to \code{TRUE}. This is a trigger that process only
3719-
#' one batch of data in a streaming query then terminate the query. Only one trigger can be
3718+
#' @param trigger.once a logical, must be set to \code{TRUE}. This is a trigger that processes only
3719+
#' one batch of data in a streaming query then terminates the query. Only one trigger can be
37203720
#' set.
37213721
#' @param ... additional external data source specific named options.
37223722
#'

python/pyspark/sql/streaming.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -793,6 +793,10 @@ def trigger(self, processingTime=None, once=None):
793793
.. note:: Evolving.
794794
795795
:param processingTime: a processing time interval as a string, e.g. '5 seconds', '1 minute'.
796+
Set a trigger that runs a query periodically based on the processing
797+
time. Only one trigger can be set.
798+
:param once: if set to True, set a trigger that processes only one batch of data in a
799+
streaming query then terminates the query. Only one trigger can be set.
796800
797801
>>> # trigger the query for execution every 5 seconds
798802
>>> writer = sdf.writeStream.trigger(processingTime='5 seconds')

sql/core/src/main/scala/org/apache/spark/sql/execution/streaming/Triggers.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import org.apache.spark.annotation.{Experimental, InterfaceStability}
2121
import org.apache.spark.sql.streaming.Trigger
2222

2323
/**
24-
* A [[Trigger]] that process only one batch of data in a streaming query then terminates
24+
* A [[Trigger]] that processes only one batch of data in a streaming query then terminates
2525
* the query.
2626
*/
2727
@Experimental

0 commit comments

Comments
 (0)