blob: dc3e4daac15846d036a10013300662ca4a5d5fc9 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>pyspark.streaming.DStream.reduceByWindow &#8212; PySpark 3.4.3 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/api/pyspark.streaming.DStream.reduceByWindow.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="pyspark.streaming.DStream.repartition" href="pyspark.streaming.DStream.repartition.html" />
<link rel="prev" title="pyspark.streaming.DStream.reduceByKeyAndWindow" href="pyspark.streaming.DStream.reduceByKeyAndWindow.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="">
<a href="../pyspark.ss/index.html">Structured Streaming</a>
</li>
<li class="">
<a href="../pyspark.ml.html">MLlib (DataFrame-based)</a>
</li>
<li class="active">
<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="pyspark-streaming-dstream-reducebywindow">
<h1>pyspark.streaming.DStream.reduceByWindow<a class="headerlink" href="#pyspark-streaming-dstream-reducebywindow" title="Permalink to this headline"></a></h1>
<dl class="py method">
<dt id="pyspark.streaming.DStream.reduceByWindow">
<code class="sig-prename descclassname">DStream.</code><code class="sig-name descname">reduceByWindow</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">reduceFunc</span><span class="p">:</span> <span class="n">Callable<span class="p">[</span><span class="p">[</span>T<span class="p">, </span>T<span class="p">]</span><span class="p">, </span>T<span class="p">]</span></span></em>, <em class="sig-param"><span class="n">invReduceFunc</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>Callable<span class="p">[</span><span class="p">[</span>T<span class="p">, </span>T<span class="p">]</span><span class="p">, </span>T<span class="p">]</span><span class="p">]</span></span></em>, <em class="sig-param"><span class="n">windowDuration</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">slideDuration</span><span class="p">:</span> <span class="n">int</span></em><span class="sig-paren">)</span> &#x2192; pyspark.streaming.dstream.DStream<span class="p">[</span>T<span class="p">]</span><a class="reference internal" href="../../_modules/pyspark/streaming/dstream.html#DStream.reduceByWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.streaming.DStream.reduceByWindow" title="Permalink to this definition"></a></dt>
<dd><p>Return a new DStream in which each RDD has a single element generated by reducing all
elements in a sliding window over this DStream.</p>
<p>if <cite>invReduceFunc</cite> is not None, the reduction is done incrementally
using the old window’s reduced value :</p>
<ol class="arabic simple">
<li><p>reduce the new values that entered the window (e.g., adding new counts)</p></li>
</ol>
<p>2. “inverse reduce” the old values that left the window (e.g., subtracting old counts)
This is more efficient than <cite>invReduceFunc</cite> is None.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>reduceFunc</strong><span class="classifier">function</span></dt><dd><p>associative and commutative reduce function</p>
</dd>
<dt><strong>invReduceFunc</strong><span class="classifier">function</span></dt><dd><p>inverse reduce function of <cite>reduceFunc</cite>; such that for all y,
and invertible x:
<cite>invReduceFunc(reduceFunc(x, y), x) = y</cite></p>
</dd>
<dt><strong>windowDuration</strong><span class="classifier">int</span></dt><dd><p>width of the window; must be a multiple of this DStream’s
batching interval</p>
</dd>
<dt><strong>slideDuration</strong><span class="classifier">int</span></dt><dd><p>sliding interval of the window (i.e., the interval after which
the new DStream will generate RDDs); must be a multiple of this
DStream’s batching interval</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
</div>
</div>
<div class='prev-next-bottom'>
<a class='left-prev' id="prev-link" href="pyspark.streaming.DStream.reduceByKeyAndWindow.html" title="previous page">pyspark.streaming.DStream.reduceByKeyAndWindow</a>
<a class='right-next' id="next-link" href="pyspark.streaming.DStream.repartition.html" title="next page">pyspark.streaming.DStream.repartition</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>
&copy; Copyright .<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/>
</p>
</div>
</footer>
</body>
</html>