| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <title>Structured Streaming — PySpark 3.4.2 documentation</title> |
| |
| <link rel="stylesheet" href="../../_static/css/index.73d71520a4ca3b99cfee5594769eaaae.css"> |
| |
| |
| <link rel="stylesheet" |
| href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> |
| |
| |
| |
| <link rel="stylesheet" |
| href="../../_static/vendor/open-sans_all/1.44.1/index.css"> |
| <link rel="stylesheet" |
| href="../../_static/vendor/lato_latin-ext/1.44.1/index.css"> |
| |
| |
| <link rel="stylesheet" href="../../_static/basic.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/css/pyspark.css" /> |
| |
| <link rel="preload" as="script" href="../../_static/js/index.3da636dd464baa7582d2.js"> |
| |
| <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/underscore.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/language_data.js"></script> |
| <script src="../../_static/clipboard.min.js"></script> |
| <script src="../../_static/copybutton.js"></script> |
| <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> |
| <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script> |
| <link rel="canonical" href="https://spark.apache.org/docs/latest/api/python/reference/pyspark.ss/index.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="Core Classes" href="core_classes.html" /> |
| <link rel="prev" title="pyspark.pandas.extensions.register_index_accessor" href="../pyspark.pandas/api/pyspark.pandas.extensions.register_index_accessor.html" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="docsearch:language" content="en" /> |
| </head> |
| <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> |
| |
| <nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"> |
| <div class="container-xl"> |
| |
| <a class="navbar-brand" href="../../index.html"> |
| |
| <img src="../../_static/spark-logo-reverse.png" class="logo" alt="logo" /> |
| |
| </a> |
| <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| |
| <div id="navbar-menu" class="col-lg-9 collapse navbar-collapse"> |
| <ul id="navbar-main-elements" class="navbar-nav mr-auto"> |
| |
| |
| <li class="nav-item "> |
| <a class="nav-link" href="../../index.html">Overview</a> |
| </li> |
| |
| <li class="nav-item "> |
| <a class="nav-link" href="../../getting_started/index.html">Getting Started</a> |
| </li> |
| |
| <li class="nav-item "> |
| <a class="nav-link" href="../../user_guide/index.html">User Guides</a> |
| </li> |
| |
| <li class="nav-item active"> |
| <a class="nav-link" href="../index.html">API Reference</a> |
| </li> |
| |
| <li class="nav-item "> |
| <a class="nav-link" href="../../development/index.html">Development</a> |
| </li> |
| |
| <li class="nav-item "> |
| <a class="nav-link" href="../../migration_guide/index.html">Migration Guides</a> |
| </li> |
| |
| |
| </ul> |
| |
| |
| |
| |
| <ul class="navbar-nav"> |
| |
| |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| |
| <div class="container-xl"> |
| <div class="row"> |
| |
| <div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> |
| <i class="icon fas fa-search"></i> |
| <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > |
| </form> |
| <nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> |
| |
| <div class="bd-toc-item active"> |
| |
| |
| <ul class="nav bd-sidenav"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.sql/index.html">Spark SQL</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.pandas/index.html">Pandas API on Spark</a> |
| </li> |
| |
| |
| |
| |
| <li class="active"> |
| <a href="">Structured Streaming</a> |
| <ul> |
| |
| <li class=""> |
| <a href="core_classes.html">Core Classes</a> |
| </li> |
| |
| <li class=""> |
| <a href="io.html">Input/Output</a> |
| </li> |
| |
| <li class=""> |
| <a href="query_management.html">Query Management</a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.ml.html">MLlib (DataFrame-based)</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.streaming.html">Spark Streaming (Legacy)</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.mllib.html">MLlib (RDD-based)</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.html">Spark Core</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.resource.html">Resource Management</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.errors.html">Errors</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| </ul> |
| |
| </nav> |
| </div> |
| |
| |
| |
| <div class="d-none d-xl-block col-xl-2 bd-toc"> |
| |
| |
| <nav id="bd-toc-nav"> |
| <ul class="nav section-nav flex-column"> |
| |
| </ul> |
| </nav> |
| |
| |
| |
| </div> |
| |
| |
| |
| <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> |
| |
| <div> |
| |
| <div class="section" id="structured-streaming"> |
| <h1>Structured Streaming<a class="headerlink" href="#structured-streaming" title="Permalink to this headline">ΒΆ</a></h1> |
| <p>This page gives an overview of all public Structed Streaming API.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="core_classes.html">Core Classes</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.html">pyspark.sql.streaming.DataStreamReader</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.html">pyspark.sql.streaming.DataStreamWriter</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.html">pyspark.sql.streaming.StreamingQuery</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.html">pyspark.sql.streaming.StreamingQueryManager</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryListener.html">pyspark.sql.streaming.StreamingQueryListener</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="io.html">Input/Output</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.csv.html">pyspark.sql.streaming.DataStreamReader.csv</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.format.html">pyspark.sql.streaming.DataStreamReader.format</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.json.html">pyspark.sql.streaming.DataStreamReader.json</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.load.html">pyspark.sql.streaming.DataStreamReader.load</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.option.html">pyspark.sql.streaming.DataStreamReader.option</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.options.html">pyspark.sql.streaming.DataStreamReader.options</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.orc.html">pyspark.sql.streaming.DataStreamReader.orc</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.parquet.html">pyspark.sql.streaming.DataStreamReader.parquet</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.schema.html">pyspark.sql.streaming.DataStreamReader.schema</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.table.html">pyspark.sql.streaming.DataStreamReader.table</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamReader.text.html">pyspark.sql.streaming.DataStreamReader.text</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.foreach.html">pyspark.sql.streaming.DataStreamWriter.foreach</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.foreachBatch.html">pyspark.sql.streaming.DataStreamWriter.foreachBatch</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.format.html">pyspark.sql.streaming.DataStreamWriter.format</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.option.html">pyspark.sql.streaming.DataStreamWriter.option</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.options.html">pyspark.sql.streaming.DataStreamWriter.options</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.outputMode.html">pyspark.sql.streaming.DataStreamWriter.outputMode</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.partitionBy.html">pyspark.sql.streaming.DataStreamWriter.partitionBy</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.queryName.html">pyspark.sql.streaming.DataStreamWriter.queryName</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.start.html">pyspark.sql.streaming.DataStreamWriter.start</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.toTable.html">pyspark.sql.streaming.DataStreamWriter.toTable</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.DataStreamWriter.trigger.html">pyspark.sql.streaming.DataStreamWriter.trigger</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="query_management.html">Query Management</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.awaitTermination.html">pyspark.sql.streaming.StreamingQuery.awaitTermination</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.exception.html">pyspark.sql.streaming.StreamingQuery.exception</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.explain.html">pyspark.sql.streaming.StreamingQuery.explain</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.id.html">pyspark.sql.streaming.StreamingQuery.id</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.isActive.html">pyspark.sql.streaming.StreamingQuery.isActive</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.lastProgress.html">pyspark.sql.streaming.StreamingQuery.lastProgress</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.name.html">pyspark.sql.streaming.StreamingQuery.name</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.processAllAvailable.html">pyspark.sql.streaming.StreamingQuery.processAllAvailable</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.recentProgress.html">pyspark.sql.streaming.StreamingQuery.recentProgress</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.runId.html">pyspark.sql.streaming.StreamingQuery.runId</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.status.html">pyspark.sql.streaming.StreamingQuery.status</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.stop.html">pyspark.sql.streaming.StreamingQuery.stop</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.active.html">pyspark.sql.streaming.StreamingQueryManager.active</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.addListener.html">pyspark.sql.streaming.StreamingQueryManager.addListener</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.awaitAnyTermination.html">pyspark.sql.streaming.StreamingQueryManager.awaitAnyTermination</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.get.html">pyspark.sql.streaming.StreamingQueryManager.get</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.removeListener.html">pyspark.sql.streaming.StreamingQueryManager.removeListener</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.resetTerminated.html">pyspark.sql.streaming.StreamingQueryManager.resetTerminated</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class='prev-next-bottom'> |
| |
| <a class='left-prev' id="prev-link" href="../pyspark.pandas/api/pyspark.pandas.extensions.register_index_accessor.html" title="previous page">pyspark.pandas.extensions.register_index_accessor</a> |
| <a class='right-next' id="next-link" href="core_classes.html" title="next page">Core Classes</a> |
| |
| </div> |
| |
| </main> |
| |
| |
| </div> |
| </div> |
| |
| |
| <script src="../../_static/js/index.3da636dd464baa7582d2.js"></script> |
| |
| |
| <footer class="footer mt-5 mt-md-0"> |
| <div class="container"> |
| <p> |
| © Copyright .<br/> |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/> |
| </p> |
| </div> |
| </footer> |
| </body> |
| </html> |
