pyspark.sql.streaming.DataStreamReader.text

DataStreamReader.text(path: str, wholetext: bool = False, lineSep: Optional[str] = None, pathGlobFilter: Union[bool, str, None] = None, recursiveFileLookup: Union[bool, str, None] = None) → DataFrame

Loads a text file stream and returns a DataFrame whose schema starts with a string column named “value”, and followed by partitioned columns if there are any. The text files must be encoded as UTF-8.

By default, each line in the text file is a new row in the resulting DataFrame.

Parameters

pathstr or list

string, or list of strings, for input path(s).

Other Parameters

Extra options

For the extra options, refer to Data Source Option in the version you use.

Notes

This API is evolving.

Examples

>>> text_sdf = spark.readStream.text(tempfile.mkdtemp())
>>> text_sdf.isStreaming
True
>>> "value" in str(text_sdf.schema)
True

previous

pyspark.sql.streaming.DataStreamReader.schema

next

pyspark.sql.streaming.DataStreamWriter.foreach