| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <title>Query Management — PySpark 3.3.1 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/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/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="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="pyspark.sql.streaming.StreamingQuery.awaitTermination" href="api/pyspark.sql.streaming.StreamingQuery.awaitTermination.html" /> |
| <link rel="prev" title="pyspark.sql.streaming.DataStreamWriter.trigger" href="api/pyspark.sql.streaming.DataStreamWriter.trigger.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="../../getting_started/index.html">Getting Started</a> |
| </li> |
| |
| <li class="nav-item "> |
| <a class="nav-link" href="../../user_guide/index.html">User Guide</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 Guide</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="index.html">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="active"> |
| <a href="">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</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> |
| |
| |
| |
| |
| |
| |
| |
| |
| </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="query-management"> |
| <h1>Query Management<a class="headerlink" href="#query-management" title="Permalink to this headline">¶</a></h1> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.awaitTermination.html#pyspark.sql.streaming.StreamingQuery.awaitTermination" title="pyspark.sql.streaming.StreamingQuery.awaitTermination"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.awaitTermination</span></code></a>([timeout])</p></td> |
| <td><p>Waits for the termination of <cite>this</cite> query, either by <code class="xref py py-func docutils literal notranslate"><span class="pre">query.stop()</span></code> or by an exception.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.exception.html#pyspark.sql.streaming.StreamingQuery.exception" title="pyspark.sql.streaming.StreamingQuery.exception"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.exception</span></code></a>()</p></td> |
| <td><p><div class="versionadded"> |
| <p><span class="versionmodified added">New in version 2.1.0.</span></p> |
| </div> |
| </p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.explain.html#pyspark.sql.streaming.StreamingQuery.explain" title="pyspark.sql.streaming.StreamingQuery.explain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.explain</span></code></a>([extended])</p></td> |
| <td><p>Prints the (logical and physical) plans to the console for debugging purpose.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.id.html#pyspark.sql.streaming.StreamingQuery.id" title="pyspark.sql.streaming.StreamingQuery.id"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.id</span></code></a></p></td> |
| <td><p>Returns the unique id of this query that persists across restarts from checkpoint data.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.isActive.html#pyspark.sql.streaming.StreamingQuery.isActive" title="pyspark.sql.streaming.StreamingQuery.isActive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.isActive</span></code></a></p></td> |
| <td><p>Whether this streaming query is currently active or not.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.lastProgress.html#pyspark.sql.streaming.StreamingQuery.lastProgress" title="pyspark.sql.streaming.StreamingQuery.lastProgress"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.lastProgress</span></code></a></p></td> |
| <td><p>Returns the most recent <code class="xref py py-class docutils literal notranslate"><span class="pre">StreamingQueryProgress</span></code> update of this streaming query or None if there were no progress updates</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.name.html#pyspark.sql.streaming.StreamingQuery.name" title="pyspark.sql.streaming.StreamingQuery.name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.name</span></code></a></p></td> |
| <td><p>Returns the user-specified name of the query, or null if not specified.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.processAllAvailable.html#pyspark.sql.streaming.StreamingQuery.processAllAvailable" title="pyspark.sql.streaming.StreamingQuery.processAllAvailable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.processAllAvailable</span></code></a>()</p></td> |
| <td><p>Blocks until all available data in the source has been processed and committed to the sink.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.recentProgress.html#pyspark.sql.streaming.StreamingQuery.recentProgress" title="pyspark.sql.streaming.StreamingQuery.recentProgress"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.recentProgress</span></code></a></p></td> |
| <td><p>Returns an array of the most recent [[StreamingQueryProgress]] updates for this query.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.runId.html#pyspark.sql.streaming.StreamingQuery.runId" title="pyspark.sql.streaming.StreamingQuery.runId"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.runId</span></code></a></p></td> |
| <td><p>Returns the unique id of this query that does not persist across restarts.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.status.html#pyspark.sql.streaming.StreamingQuery.status" title="pyspark.sql.streaming.StreamingQuery.status"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.status</span></code></a></p></td> |
| <td><p>Returns the current status of the query.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQuery.stop.html#pyspark.sql.streaming.StreamingQuery.stop" title="pyspark.sql.streaming.StreamingQuery.stop"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQuery.stop</span></code></a>()</p></td> |
| <td><p>Stop this streaming query.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.active.html#pyspark.sql.streaming.StreamingQueryManager.active" title="pyspark.sql.streaming.StreamingQueryManager.active"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQueryManager.active</span></code></a></p></td> |
| <td><p>Returns a list of active queries associated with this SQLContext</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.awaitAnyTermination.html#pyspark.sql.streaming.StreamingQueryManager.awaitAnyTermination" title="pyspark.sql.streaming.StreamingQueryManager.awaitAnyTermination"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQueryManager.awaitAnyTermination</span></code></a>([…])</p></td> |
| <td><p>Wait until any of the queries on the associated SQLContext has terminated since the creation of the context, or since <code class="xref py py-func docutils literal notranslate"><span class="pre">resetTerminated()</span></code> was called.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.get.html#pyspark.sql.streaming.StreamingQueryManager.get" title="pyspark.sql.streaming.StreamingQueryManager.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQueryManager.get</span></code></a>(id)</p></td> |
| <td><p>Returns an active query from this SQLContext or throws exception if an active query with this name doesn’t exist.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.streaming.StreamingQueryManager.resetTerminated.html#pyspark.sql.streaming.StreamingQueryManager.resetTerminated" title="pyspark.sql.streaming.StreamingQueryManager.resetTerminated"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StreamingQueryManager.resetTerminated</span></code></a>()</p></td> |
| <td><p>Forget about past terminated queries so that <code class="xref py py-func docutils literal notranslate"><span class="pre">awaitAnyTermination()</span></code> can be used again to wait for new terminations.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class='prev-next-bottom'> |
| |
| <a class='left-prev' id="prev-link" href="api/pyspark.sql.streaming.DataStreamWriter.trigger.html" title="previous page">pyspark.sql.streaming.DataStreamWriter.trigger</a> |
| <a class='right-next' id="next-link" href="api/pyspark.sql.streaming.StreamingQuery.awaitTermination.html" title="next page">pyspark.sql.streaming.StreamingQuery.awaitTermination</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> |
