pyspark.sql.streaming.
DataStreamWriter
Interface used to write a streaming DataFrame to external storage systems (e.g. file systems, key-value stores, etc). Use DataFrame.writeStream to access this.
DataFrame
DataFrame.writeStream
Note
Evolving.
New in version 2.0.
__init__
Initialize self. See help(type(self)) for accurate signature.
Methods
__init__(df)
Initialize self.
foreach(f)
foreach
Sets the output of the streaming query to be processed using the provided writer f.
f
foreachBatch(func)
foreachBatch
Sets the output of the streaming query to be processed using the provided function.
format(source)
format
Specifies the underlying output data source.
option(key, value)
option
Adds an output option for the underlying data source.
options(**options)
options
Adds output options for the underlying data source.
outputMode(outputMode)
outputMode
Specifies how data of a streaming DataFrame/Dataset is written to a streaming sink.
partitionBy(*cols)
partitionBy
Partitions the output by the given columns on the file system.
queryName(queryName)
queryName
Specifies the name of the StreamingQuery that can be started with start().
StreamingQuery
start()
start([path, format, outputMode, …])
start
Streams the contents of the DataFrame to a data source.
trigger([processingTime, once, continuous])
trigger
Set the trigger for the stream query.