blob: fbb7c6305294e18a2197f2170add9fe0464ebbdd [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.pipeline_analyzer module &mdash; Apache Beam documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Apache Beam documentation" href="index.html"/>
<link rel="up" title="apache_beam.runners.interactive package" href="apache_beam.runners.interactive.html"/>
<link rel="next" title="apache_beam.runners.interactive.pipeline_instrument module" href="apache_beam.runners.interactive.pipeline_instrument.html"/>
<link rel="prev" title="apache_beam.runners.interactive.interactive_runner module" href="apache_beam.runners.interactive.interactive_runner.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<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.internal.html">apache_beam.internal 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.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.internal.html">apache_beam.runners.internal package</a></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.testing.html">apache_beam.testing package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.tools.html">apache_beam.tools package</a></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>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" 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.pipeline_analyzer module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.runners.interactive.pipeline_analyzer.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.pipeline_analyzer">
<span id="apache-beam-runners-interactive-pipeline-analyzer-module"></span><h1>apache_beam.runners.interactive.pipeline_analyzer module<a class="headerlink" href="#module-apache_beam.runners.interactive.pipeline_analyzer" title="Permalink to this headline"></a></h1>
<p>Analyzes and modifies the pipeline that utilize the PCollection cache.</p>
<p>This module is experimental. No backwards-compatibility guarantees.</p>
<dl class="class">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer">
<em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.pipeline_analyzer.</code><code class="descname">PipelineAnalyzer</code><span class="sig-paren">(</span><em>cache_manager</em>, <em>pipeline_proto</em>, <em>underlying_runner</em>, <em>options=None</em>, <em>desired_cache_labels=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineAnalyzer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>Constructor of PipelineAnanlyzer.</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>cache_manager</strong> – (CacheManager)</li>
<li><strong>pipeline_proto</strong> – (Pipeline proto)</li>
<li><strong>underlying_runner</strong> – (PipelineRunner)</li>
<li><strong>options</strong> – (PipelineOptions)</li>
<li><strong>desired_cache_labels</strong> – (Set[str]) a set of labels of the PCollection
queried by the user.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.pipeline_info">
<code class="descname">pipeline_info</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineAnalyzer.pipeline_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.pipeline_info" title="Permalink to this definition"></a></dt>
<dd><p>Return PipelineInfo of the original pipeline.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.pipeline_proto_to_execute">
<code class="descname">pipeline_proto_to_execute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineAnalyzer.pipeline_proto_to_execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.pipeline_proto_to_execute" title="Permalink to this definition"></a></dt>
<dd><p>Returns Pipeline proto to be executed.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.tl_referenced_pcoll_ids">
<code class="descname">tl_referenced_pcoll_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineAnalyzer.tl_referenced_pcoll_ids"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.tl_referenced_pcoll_ids" title="Permalink to this definition"></a></dt>
<dd><p>Returns a set of PCollection IDs referenced by top level PTransforms.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.tl_required_trans_ids">
<code class="descname">tl_required_trans_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineAnalyzer.tl_required_trans_ids"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.tl_required_trans_ids" title="Permalink to this definition"></a></dt>
<dd><p>Returns a set of required top level PTransform IDs.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.caches_used">
<code class="descname">caches_used</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineAnalyzer.caches_used"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.caches_used" title="Permalink to this definition"></a></dt>
<dd><p>Returns a set of PCollection IDs to read from cache.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.read_cache_ids">
<code class="descname">read_cache_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineAnalyzer.read_cache_ids"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.read_cache_ids" title="Permalink to this definition"></a></dt>
<dd><p>Return a set of ReadCache PTransform IDs inserted.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.write_cache_ids">
<code class="descname">write_cache_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineAnalyzer.write_cache_ids"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineAnalyzer.write_cache_ids" title="Permalink to this definition"></a></dt>
<dd><p>Return a set of WriteCache PTransform IDs inserted.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo">
<em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.pipeline_analyzer.</code><code class="descname">PipelineInfo</code><span class="sig-paren">(</span><em>proto</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>Provides access to pipeline metadata.</p>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.all_pcollections">
<code class="descname">all_pcollections</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineInfo.all_pcollections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.all_pcollections" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.leaf_pcollections">
<code class="descname">leaf_pcollections</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineInfo.leaf_pcollections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.leaf_pcollections" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.producer">
<code class="descname">producer</code><span class="sig-paren">(</span><em>pcoll_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineInfo.producer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.producer" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.cache_label">
<code class="descname">cache_label</code><span class="sig-paren">(</span><em>pcoll_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineInfo.cache_label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.cache_label" title="Permalink to this definition"></a></dt>
<dd><p>Returns the cache label given the PCollection ID.</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.Derivation">
<em class="property">class </em><code class="descname">Derivation</code><span class="sig-paren">(</span><em>inputs</em>, <em>transform_proto</em>, <em>output_tag</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineInfo.Derivation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.Derivation" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>Records derivation info of a PCollection. Helper for PipelineInfo.</p>
<p>Constructor of Derivation.</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>inputs</strong> – (Dict[str, Derivation]) maps PCollection names to Derivations.</li>
<li><strong>transform_proto</strong> – (Transform proto) the producing PTransform.</li>
<li><strong>output_tag</strong> – (str) local name of the PCollection in analysis.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.Derivation.cache_label">
<code class="descname">cache_label</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineInfo.Derivation.cache_label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.Derivation.cache_label" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.Derivation.json">
<code class="descname">json</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#PipelineInfo.Derivation.json"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.PipelineInfo.Derivation.json" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="apache_beam.runners.interactive.pipeline_analyzer.set_proto_map">
<code class="descclassname">apache_beam.runners.interactive.pipeline_analyzer.</code><code class="descname">set_proto_map</code><span class="sig-paren">(</span><em>proto_map</em>, <em>new_value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/pipeline_analyzer.html#set_proto_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.pipeline_analyzer.set_proto_map" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.runners.interactive.pipeline_instrument.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.pipeline_instrument module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.runners.interactive.interactive_runner.html" class="btn btn-neutral" title="apache_beam.runners.interactive.interactive_runner 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/snide/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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>