pyspark.sql.DataFrame.isStreaming

property DataFrame.isStreaming

Returns True if this DataFrame contains one or more sources that continuously return data as it arrives. A DataFrame that reads data from a streaming source must be executed as a StreamingQuery using the start() method in DataStreamWriter. Methods that return a single answer, (e.g., count() or collect()) will throw an AnalysisException when there is a streaming source present.

New in version 2.0.0.

Changed in version 3.4.0: Supports Spark Connect.

Returns

bool

Whether it’s streaming DataFrame or not.

Notes

This API is evolving.

Examples

>>> df = spark.readStream.format("rate").load()
>>> df.isStreaming
True

previous

pyspark.sql.DataFrame.isLocal

next

pyspark.sql.DataFrame.join