| |
| |
| <!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.cache_manager module — 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.interactive_runner module" href="apache_beam.runners.interactive.interactive_runner.html"/> |
| <link rel="prev" title="apache_beam.runners.interactive.display.pipeline_graph_renderer module" href="apache_beam.runners.interactive.display.pipeline_graph_renderer.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.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> »</li> |
| |
| <li><a href="apache_beam.runners.html">apache_beam.runners package</a> »</li> |
| |
| <li><a href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a> »</li> |
| |
| <li>apache_beam.runners.interactive.cache_manager module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.interactive.cache_manager.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.cache_manager"> |
| <span id="apache-beam-runners-interactive-cache-manager-module"></span><h1>apache_beam.runners.interactive.cache_manager module<a class="headerlink" href="#module-apache_beam.runners.interactive.cache_manager" title="Permalink to this headline">¶</a></h1> |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.cache_manager.CacheManager"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.cache_manager.</code><code class="descname">CacheManager</code><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#CacheManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.CacheManager" 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>Abstract class for caching PCollections.</p> |
| <p>A PCollection cache is identified by labels, which consist of a prefix (either |
| ‘full’ or ‘sample’) and a cache_label which is a hash of the PCollection |
| derivation.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.CacheManager.exists"> |
| <code class="descname">exists</code><span class="sig-paren">(</span><em>*labels</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#CacheManager.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.CacheManager.exists" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns if the PCollection cache exists.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.CacheManager.is_latest_version"> |
| <code class="descname">is_latest_version</code><span class="sig-paren">(</span><em>version</em>, <em>*labels</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#CacheManager.is_latest_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.CacheManager.is_latest_version" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns if the given version number is the latest.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.CacheManager.read"> |
| <code class="descname">read</code><span class="sig-paren">(</span><em>*labels</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#CacheManager.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.CacheManager.read" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return the PCollection as a list as well as the version number.</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">Returns:</th><td class="field-body">(List[PCollection]) |
| (int) the version number</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>It is possible that the version numbers from read() and_latest_version() |
| are different. This usually means that the cache’s been evicted (thus |
| unavailable => read() returns version = -1), but it had reached version n |
| before eviction.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.CacheManager.source"> |
| <code class="descname">source</code><span class="sig-paren">(</span><em>*labels</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#CacheManager.source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.CacheManager.source" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a beam.io.Source that reads the PCollection cache.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.CacheManager.sink"> |
| <code class="descname">sink</code><span class="sig-paren">(</span><em>*labels</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#CacheManager.sink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.CacheManager.sink" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a beam.io.Sink that writes the PCollection cache.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.CacheManager.cleanup"> |
| <code class="descname">cleanup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#CacheManager.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.CacheManager.cleanup" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Cleans up all the PCollection caches.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.cache_manager.FileBasedCacheManager"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.cache_manager.</code><code class="descname">FileBasedCacheManager</code><span class="sig-paren">(</span><em>cache_dir=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#FileBasedCacheManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.FileBasedCacheManager" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.runners.interactive.cache_manager.CacheManager" title="apache_beam.runners.interactive.cache_manager.CacheManager"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.runners.interactive.cache_manager.CacheManager</span></code></a></p> |
| <p>Maps PCollections to local temp files for materialization.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.FileBasedCacheManager.exists"> |
| <code class="descname">exists</code><span class="sig-paren">(</span><em>*labels</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#FileBasedCacheManager.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.FileBasedCacheManager.exists" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.FileBasedCacheManager.read"> |
| <code class="descname">read</code><span class="sig-paren">(</span><em>*labels</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#FileBasedCacheManager.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.FileBasedCacheManager.read" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.FileBasedCacheManager.source"> |
| <code class="descname">source</code><span class="sig-paren">(</span><em>*labels</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#FileBasedCacheManager.source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.FileBasedCacheManager.source" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.FileBasedCacheManager.sink"> |
| <code class="descname">sink</code><span class="sig-paren">(</span><em>*labels</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#FileBasedCacheManager.sink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.FileBasedCacheManager.sink" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.FileBasedCacheManager.cleanup"> |
| <code class="descname">cleanup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#FileBasedCacheManager.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.FileBasedCacheManager.cleanup" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.cache_manager.ReadCache"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.cache_manager.</code><code class="descname">ReadCache</code><span class="sig-paren">(</span><em>cache_manager</em>, <em>label</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#ReadCache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.ReadCache" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p> |
| <p>A PTransform that reads the PCollections from the cache.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.ReadCache.expand"> |
| <code class="descname">expand</code><span class="sig-paren">(</span><em>pbegin</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#ReadCache.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.ReadCache.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.cache_manager.WriteCache"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.cache_manager.</code><code class="descname">WriteCache</code><span class="sig-paren">(</span><em>cache_manager</em>, <em>label</em>, <em>sample=False</em>, <em>sample_size=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#WriteCache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.WriteCache" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p> |
| <p>A PTransform that writes the PCollections to the cache.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.WriteCache.expand"> |
| <code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#WriteCache.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.WriteCache.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.cache_manager.SafeFastPrimitivesCoder"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.cache_manager.</code><code class="descname">SafeFastPrimitivesCoder</code><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#SafeFastPrimitivesCoder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.SafeFastPrimitivesCoder" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.coders.coders.html#apache_beam.coders.coders.Coder" title="apache_beam.coders.coders.Coder"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.coders.coders.Coder</span></code></a></p> |
| <p>This class add an quote/unquote step to escape special characters.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.SafeFastPrimitivesCoder.encode"> |
| <code class="descname">encode</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#SafeFastPrimitivesCoder.encode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.SafeFastPrimitivesCoder.encode" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.cache_manager.SafeFastPrimitivesCoder.decode"> |
| <code class="descname">decode</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/cache_manager.html#SafeFastPrimitivesCoder.decode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.cache_manager.SafeFastPrimitivesCoder.decode" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </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.interactive_runner.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.interactive_runner module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.runners.interactive.display.pipeline_graph_renderer.html" class="btn btn-neutral" title="apache_beam.runners.interactive.display.pipeline_graph_renderer module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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> |