..  Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

..    http://www.apache.org/licenses/LICENSE-2.0

..  Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.


====================
Structured Streaming
====================

Core Classes
------------

.. currentmodule:: pyspark.sql.streaming

.. autosummary::
    :toctree: api/

    DataStreamReader
    DataStreamWriter
    ForeachBatchFunction
    StreamingQuery
    StreamingQueryException
    StreamingQueryManager

Input and Output
----------------

.. currentmodule:: pyspark.sql.streaming

.. autosummary::
    :toctree: api/

    DataStreamReader.csv
    DataStreamReader.format
    DataStreamReader.json
    DataStreamReader.load
    DataStreamReader.option
    DataStreamReader.options
    DataStreamReader.orc
    DataStreamReader.parquet
    DataStreamReader.schema
    DataStreamReader.text
    DataStreamWriter.foreach
    DataStreamWriter.foreachBatch
    DataStreamWriter.format
    DataStreamWriter.option
    DataStreamWriter.options
    DataStreamWriter.outputMode
    DataStreamWriter.partitionBy
    DataStreamWriter.queryName
    DataStreamWriter.start
    DataStreamWriter.trigger

Query Management
----------------

.. currentmodule:: pyspark.sql.streaming

.. autosummary::
    :toctree: api/

    StreamingQuery.awaitTermination
    StreamingQuery.exception
    StreamingQuery.explain
    StreamingQuery.id
    StreamingQuery.isActive
    StreamingQuery.lastProgress
    StreamingQuery.name
    StreamingQuery.processAllAvailable
    StreamingQuery.recentProgress
    StreamingQuery.runId
    StreamingQuery.status
    StreamingQuery.stop
    StreamingQueryManager.active
    StreamingQueryManager.awaitAnyTermination
    StreamingQueryManager.get
    StreamingQueryManager.resetTerminated