blob: 2f1dd3f765e12d188048de551cdce5c3f48ec661 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.runners.interactive.interactive_runner module &mdash; Apache Beam documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.runners.interactive.pipeline_fragment module" href="apache_beam.runners.interactive.pipeline_fragment.html" />
<link rel="prev" title="apache_beam.runners.interactive.interactive_environment module" href="apache_beam.runners.interactive.interactive_environment.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Apache Beam
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.html#subpackages">Subpackages</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.interactive.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="apache_beam.runners.html">apache_beam.runners package</a> &raquo;</li>
<li><a href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a> &raquo;</li>
<li>apache_beam.runners.interactive.interactive_runner module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.runners.interactive.interactive_runner.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-apache_beam.runners.interactive.interactive_runner">
<span id="apache-beam-runners-interactive-interactive-runner-module"></span><h1>apache_beam.runners.interactive.interactive_runner module<a class="headerlink" href="#module-apache_beam.runners.interactive.interactive_runner" title="Permalink to this headline"></a></h1>
<p>A runner that allows running of Beam pipelines interactively.</p>
<p>This module is experimental. No backwards-compatibility guarantees.</p>
<dl class="class">
<dt id="apache_beam.runners.interactive.interactive_runner.InteractiveRunner">
<em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.interactive_runner.</code><code class="descname">InteractiveRunner</code><span class="sig-paren">(</span><em>underlying_runner=None</em>, <em>render_option=None</em>, <em>skip_display=True</em>, <em>force_compute=True</em>, <em>blocking=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#InteractiveRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.InteractiveRunner" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.runners.runner.html#apache_beam.runners.runner.PipelineRunner" title="apache_beam.runners.runner.PipelineRunner"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.runners.runner.PipelineRunner</span></code></a></p>
<p>An interactive runner for Beam Python pipelines.</p>
<p>Allows interactively building and running Beam Python pipelines.</p>
<p>Constructor of InteractiveRunner.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>underlying_runner</strong> – (runner.PipelineRunner)</li>
<li><strong>render_option</strong> – (str) this parameter decides how the pipeline graph is
rendered. See display.pipeline_graph_renderer for available options.</li>
<li><strong>skip_display</strong> – (bool) whether to skip display operations when running the
pipeline. Useful if running large pipelines when display is not
needed.</li>
<li><strong>force_compute</strong> – (bool) whether sequential pipeline runs can use cached data
of PCollections computed from the previous runs including show API
invocation from interactive_beam module. If True, always run the whole
pipeline and compute data for PCollections forcefully. If False, use
available data and run minimum pipeline fragment to only compute data
not available.</li>
<li><strong>blocking</strong> – (bool) whether the pipeline run should be blocking or not.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="apache_beam.runners.interactive.interactive_runner.InteractiveRunner.is_fnapi_compatible">
<code class="descname">is_fnapi_compatible</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#InteractiveRunner.is_fnapi_compatible"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.InteractiveRunner.is_fnapi_compatible" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.interactive_runner.InteractiveRunner.set_render_option">
<code class="descname">set_render_option</code><span class="sig-paren">(</span><em>render_option</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#InteractiveRunner.set_render_option"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.InteractiveRunner.set_render_option" title="Permalink to this definition"></a></dt>
<dd><p>Sets the rendering option.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>render_option</strong> – (str) this parameter decides how the pipeline graph is
rendered. See display.pipeline_graph_renderer for available options.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.interactive_runner.InteractiveRunner.start_session">
<code class="descname">start_session</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#InteractiveRunner.start_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.InteractiveRunner.start_session" title="Permalink to this definition"></a></dt>
<dd><p>Start the session that keeps back-end managers and workers alive.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.interactive_runner.InteractiveRunner.end_session">
<code class="descname">end_session</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#InteractiveRunner.end_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.InteractiveRunner.end_session" title="Permalink to this definition"></a></dt>
<dd><p>End the session that keeps backend managers and workers alive.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.interactive_runner.InteractiveRunner.apply">
<code class="descname">apply</code><span class="sig-paren">(</span><em>transform</em>, <em>pvalueish</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#InteractiveRunner.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.InteractiveRunner.apply" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.interactive_runner.InteractiveRunner.run_pipeline">
<code class="descname">run_pipeline</code><span class="sig-paren">(</span><em>pipeline</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#InteractiveRunner.run_pipeline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.InteractiveRunner.run_pipeline" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.interactive.interactive_runner.PipelineResult">
<em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.interactive_runner.</code><code class="descname">PipelineResult</code><span class="sig-paren">(</span><em>underlying_result</em>, <em>pipeline_instrument</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#PipelineResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.PipelineResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.runners.runner.html#apache_beam.runners.runner.PipelineResult" title="apache_beam.runners.runner.PipelineResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.runners.runner.PipelineResult</span></code></a></p>
<p>Provides access to information about a pipeline.</p>
<p>Constructor of PipelineResult.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>underlying_result</strong> – (PipelineResult) the result returned by the underlying
runner running the pipeline.</li>
<li><strong>pipeline_instrument</strong> – (PipelineInstrument) pipeline instrument describing
the pipeline being executed with interactivity applied and related
metadata including where the interactivity-backing cache lies.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="apache_beam.runners.interactive.interactive_runner.PipelineResult.state">
<code class="descname">state</code><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.PipelineResult.state" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.interactive_runner.PipelineResult.wait_until_finish">
<code class="descname">wait_until_finish</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#PipelineResult.wait_until_finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.PipelineResult.wait_until_finish" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.interactive_runner.PipelineResult.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>pcoll</em>, <em>include_window_info=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#PipelineResult.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.PipelineResult.get" title="Permalink to this definition"></a></dt>
<dd><p>Materializes the PCollection into a list.</p>
<p>If include_window_info is True, then returns the elements as
WindowedValues. Otherwise, return the element as itself.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.interactive_runner.PipelineResult.read">
<code class="descname">read</code><span class="sig-paren">(</span><em>pcoll</em>, <em>include_window_info=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#PipelineResult.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.PipelineResult.read" title="Permalink to this definition"></a></dt>
<dd><p>Reads the PCollection one element at a time from cache.</p>
<p>If include_window_info is True, then returns the elements as
WindowedValues. Otherwise, return the element as itself.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.interactive_runner.PipelineResult.cancel">
<code class="descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/interactive_runner.html#PipelineResult.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.interactive_runner.PipelineResult.cancel" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.runners.interactive.pipeline_fragment.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.pipeline_fragment module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.runners.interactive.interactive_environment.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.interactive_environment module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>