| |
| |
| <!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.trivial_runner module — Apache Beam 2.52.0 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.testing package" href="apache_beam.testing.html" /> |
| <link rel="prev" title="apache_beam.runners.sdf_utils module" href="apache_beam.runners.sdf_utils.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 class="version"> |
| 2.52.0 |
| </div> |
| |
| |
| |
| |
| <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"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.pipeline_context.html">apache_beam.runners.pipeline_context module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.render.html">apache_beam.runners.render module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.runner.html">apache_beam.runners.runner module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.sdf_utils.html">apache_beam.runners.sdf_utils module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.runners.trivial_runner module</a></li> |
| </ul> |
| </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.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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml 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> »</li> |
| |
| <li><a href="apache_beam.runners.html">apache_beam.runners package</a> »</li> |
| |
| <li>apache_beam.runners.trivial_runner module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.trivial_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.trivial_runner"> |
| <span id="apache-beam-runners-trivial-runner-module"></span><h1>apache_beam.runners.trivial_runner module<a class="headerlink" href="#module-apache_beam.runners.trivial_runner" title="Permalink to this headline">¶</a></h1> |
| <dl class="class"> |
| <dt id="apache_beam.runners.trivial_runner.TrivialRunner"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.trivial_runner.</code><code class="descname">TrivialRunner</code><a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#TrivialRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.TrivialRunner" 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>A bare-bones batch Python pipeline runner illistrating how to use the |
| RunnerAPI and FnAPI to execute pipelines.</p> |
| <p>Note that this runner is primarily for pedagogical purposes and is missing |
| several features in order to keep it as simple as possible. Where possible |
| pointers are provided which this should serve as a useful starting point.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.TrivialRunner.run_portable_pipeline"> |
| <code class="descname">run_portable_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/trivial_runner.html#TrivialRunner.run_portable_pipeline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.TrivialRunner.run_portable_pipeline" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.TrivialRunner.execute_transform"> |
| <code class="descname">execute_transform</code><span class="sig-paren">(</span><em>transform_id</em>, <em>execution_state</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#TrivialRunner.execute_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.TrivialRunner.execute_transform" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Execute a single transform.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.TrivialRunner.execute_executable_stage"> |
| <code class="descname">execute_executable_stage</code><span class="sig-paren">(</span><em>transform_proto</em>, <em>execution_state</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#TrivialRunner.execute_executable_stage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.TrivialRunner.execute_executable_stage" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.TrivialRunner.group_by_key_and_window"> |
| <code class="descname">group_by_key_and_window</code><span class="sig-paren">(</span><em>input_pcoll</em>, <em>output_pcoll</em>, <em>execution_state</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#TrivialRunner.group_by_key_and_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.TrivialRunner.group_by_key_and_window" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Groups the elements of input_pcoll, placing their output in output_pcoll.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.TrivialRunner.supported_requirements"> |
| <code class="descname">supported_requirements</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → Iterable[str]<a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#TrivialRunner.supported_requirements"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.TrivialRunner.supported_requirements" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.trivial_runner.ExecutionState"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.trivial_runner.</code><code class="descname">ExecutionState</code><span class="sig-paren">(</span><em>optimized_pipeline</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#ExecutionState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.ExecutionState" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>A helper class holding various values and context during execution.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.ExecutionState.register_process_bundle_descriptor"> |
| <code class="descname">register_process_bundle_descriptor</code><span class="sig-paren">(</span><em>process_bundle_descriptor: org.apache.beam.model.fn_execution.v1.beam_fn_api_pb2.ProcessBundleDescriptor</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#ExecutionState.register_process_bundle_descriptor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.ExecutionState.register_process_bundle_descriptor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.ExecutionState.get_pcollection_contents"> |
| <code class="descname">get_pcollection_contents</code><span class="sig-paren">(</span><em>pcoll_id: str</em><span class="sig-paren">)</span> → List[bytes]<a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#ExecutionState.get_pcollection_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.ExecutionState.get_pcollection_contents" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.ExecutionState.set_pcollection_contents"> |
| <code class="descname">set_pcollection_contents</code><span class="sig-paren">(</span><em>pcoll_id: str, chunks: List[bytes]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#ExecutionState.set_pcollection_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.ExecutionState.set_pcollection_contents" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.ExecutionState.new_id"> |
| <code class="descname">new_id</code><span class="sig-paren">(</span><em>prefix=''</em><span class="sig-paren">)</span> → str<a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#ExecutionState.new_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.ExecutionState.new_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.ExecutionState.windowed_coder"> |
| <code class="descname">windowed_coder</code><span class="sig-paren">(</span><em>pcollection_id: str</em><span class="sig-paren">)</span> → apache_beam.coders.coders.Coder<a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#ExecutionState.windowed_coder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.ExecutionState.windowed_coder" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.ExecutionState.windowing_strategy"> |
| <code class="descname">windowing_strategy</code><span class="sig-paren">(</span><em>pcollection_id: str</em><span class="sig-paren">)</span> → apache_beam.transforms.core.Windowing<a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#ExecutionState.windowing_strategy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.ExecutionState.windowing_strategy" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.trivial_runner.ExecutionState.windowed_coder_id"> |
| <code class="descname">windowed_coder_id</code><span class="sig-paren">(</span><em>pcollection_id: str</em><span class="sig-paren">)</span> → str<a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#ExecutionState.windowed_coder_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.ExecutionState.windowed_coder_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.trivial_runner.is_primitive_transform"> |
| <code class="descclassname">apache_beam.runners.trivial_runner.</code><code class="descname">is_primitive_transform</code><span class="sig-paren">(</span><em>transform: org.apache.beam.model.pipeline.v1.beam_runner_api_pb2.PTransform</em><span class="sig-paren">)</span> → bool<a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#is_primitive_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.is_primitive_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.trivial_runner.only_element"> |
| <code class="descclassname">apache_beam.runners.trivial_runner.</code><code class="descname">only_element</code><span class="sig-paren">(</span><em>iterable: Iterable[T]</em><span class="sig-paren">)</span> → T<a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#only_element"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.only_element" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.trivial_runner.decode_all"> |
| <code class="descclassname">apache_beam.runners.trivial_runner.</code><code class="descname">decode_all</code><span class="sig-paren">(</span><em>encoded_elements: bytes</em>, <em>coder: apache_beam.coders.coders.Coder</em><span class="sig-paren">)</span> → Iterator[Any]<a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#decode_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.decode_all" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.trivial_runner.encode_all"> |
| <code class="descclassname">apache_beam.runners.trivial_runner.</code><code class="descname">encode_all</code><span class="sig-paren">(</span><em>elements: Iterator[T], coder: apache_beam.coders.coders.Coder</em><span class="sig-paren">)</span> → bytes<a class="reference internal" href="_modules/apache_beam/runners/trivial_runner.html#encode_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.trivial_runner.encode_all" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.testing.html" class="btn btn-neutral float-right" title="apache_beam.testing package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.runners.sdf_utils.html" class="btn btn-neutral float-left" title="apache_beam.runners.sdf_utils 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/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> |
