nxcals.api.extraction.data.builders.DataFrame.writeStream

property DataFrame.writeStream: DataStreamWriter

Interface for saving the content of the streaming DataFrame out into external storage.

New in version 2.0.0.

Changed in version 3.5.0: Supports Spark Connect.

Notes

This API is evolving.

Return type:

DataStreamWriter

Examples

>>> import tempfile
>>> df = spark.readStream.format("rate").load()
>>> type(df.writeStream)
<class '...streaming.readwriter.DataStreamWriter'>

>>> with tempfile.TemporaryDirectory() as d:
...     # Create a table with Rate source.
...     df.writeStream.toTable(
...         "my_table", checkpointLocation=d)
<...streaming.query.StreamingQuery object at 0x...>