| |
| |
| <!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.dataframe.expressions module — 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.dataframe.frame_base module" href="apache_beam.dataframe.frame_base.html" /> |
| <link rel="prev" title="apache_beam.dataframe.doctests module" href="apache_beam.dataframe.doctests.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 current"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.dataframe.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.convert.html">apache_beam.dataframe.convert module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.doctests.html">apache_beam.dataframe.doctests module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.dataframe.expressions module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.frame_base.html">apache_beam.dataframe.frame_base module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.frames.html">apache_beam.dataframe.frames module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.io.html">apache_beam.dataframe.io module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.pandas_top_level_functions.html">apache_beam.dataframe.pandas_top_level_functions module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.partitionings.html">apache_beam.dataframe.partitionings module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.schemas.html">apache_beam.dataframe.schemas module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.transforms.html">apache_beam.dataframe.transforms module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners 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> |
| </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.dataframe.html">apache_beam.dataframe package</a> »</li> |
| |
| <li>apache_beam.dataframe.expressions module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.dataframe.expressions.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.dataframe.expressions"> |
| <span id="apache-beam-dataframe-expressions-module"></span><h1>apache_beam.dataframe.expressions module<a class="headerlink" href="#module-apache_beam.dataframe.expressions" title="Permalink to this headline">¶</a></h1> |
| <dl class="class"> |
| <dt id="apache_beam.dataframe.expressions.Session"> |
| <em class="property">class </em><code class="descclassname">apache_beam.dataframe.expressions.</code><code class="descname">Session</code><span class="sig-paren">(</span><em>bindings=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#Session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.Session" 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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>A session represents a mapping of expressions to concrete values.</p> |
| <p>The bindings typically include required placeholders, but may be any |
| intermediate expression as well.</p> |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.Session.evaluate"> |
| <code class="descname">evaluate</code><span class="sig-paren">(</span><em>expr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#Session.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.Session.evaluate" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.Session.lookup"> |
| <code class="descname">lookup</code><span class="sig-paren">(</span><em>expr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#Session.lookup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.Session.lookup" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.dataframe.expressions.PartitioningSession"> |
| <em class="property">class </em><code class="descclassname">apache_beam.dataframe.expressions.</code><code class="descname">PartitioningSession</code><span class="sig-paren">(</span><em>bindings=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#PartitioningSession"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.PartitioningSession" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.dataframe.expressions.Session" title="apache_beam.dataframe.expressions.Session"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.dataframe.expressions.Session</span></code></a></p> |
| <p>An extension of Session that enforces actual partitioning of inputs.</p> |
| <p>Each expression is evaluated multiple times for various supported |
| partitionings determined by its <cite>requires_partition_by</cite> specification. For |
| each tested partitioning, the input is partitioned and the expression is |
| evaluated on each partition separately, as if this were actually executed in |
| a parallel manner.</p> |
| <p>For each input partitioning, the results are verified to be partitioned |
| appropriately according to the expression’s <cite>preserves_partition_by</cite> |
| specification.</p> |
| <p>For testing only.</p> |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.PartitioningSession.evaluate"> |
| <code class="descname">evaluate</code><span class="sig-paren">(</span><em>expr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#PartitioningSession.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.PartitioningSession.evaluate" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.dataframe.expressions.output_partitioning"> |
| <code class="descclassname">apache_beam.dataframe.expressions.</code><code class="descname">output_partitioning</code><span class="sig-paren">(</span><em>expr</em>, <em>input_partitioning</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#output_partitioning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.output_partitioning" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return the expected output partitioning for <cite>expr</cite> when it’s input is |
| partitioned by <cite>input_partitioning</cite>.</p> |
| <p>For internal use only; No backward compatibility guarantees</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.dataframe.expressions.Expression"> |
| <em class="property">class </em><code class="descclassname">apache_beam.dataframe.expressions.</code><code class="descname">Expression</code><span class="sig-paren">(</span><em>name: str</em>, <em>proxy: T</em>, <em>_id: Optional[str] = None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#Expression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.Expression" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Generic" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">typing.Generic</span></code></a></p> |
| <p>An expression is an operation bound to a set of arguments.</p> |
| <p>An expression represents a deferred tree of operations, which can be |
| evaluated at a specific bindings of root expressions to values.</p> |
| <p>requires_partition_by indicates the upper bound of a set of partitionings that |
| are acceptable inputs to this expression. The expression should be able to |
| produce the correct result when given input(s) partitioned by its |
| requires_partition_by attribute, or by any partitoning that is _not_ |
| a subpartitioning of it.</p> |
| <p>preserves_partition_by indicates the upper bound of a set of partitionings |
| that can be preserved by this expression. When the input(s) to this expression |
| are partitioned by preserves_partition_by, or by any partitioning that is |
| _not_ a subpartitioning of it, this expression should produce output(s) |
| partitioned by the same partitioning.</p> |
| <p>However, if the partitioning of an expression’s input is a subpartitioning of |
| the partitioning that it preserves, the output is presumed to have no |
| particular partitioning (i.e. Arbitrary()).</p> |
| <p>For example, let’s look at an “element-wise operation”, that has no |
| partitioning requirement, and preserves any partitioning given to it:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">requires_partition_by</span> <span class="o">=</span> <span class="n">Arbitrary</span><span class="p">()</span> <span class="o">-----------------------------+</span> |
| <span class="o">|</span> |
| <span class="o">+-----------+-------------+----------</span> <span class="o">...</span> <span class="o">----+---------|</span> |
| <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> |
| <span class="n">Singleton</span><span class="p">()</span> <span class="o"><</span> <span class="n">Index</span><span class="p">([</span><span class="n">i</span><span class="p">])</span> <span class="o"><</span> <span class="n">Index</span><span class="p">([</span><span class="n">i</span><span class="p">,</span> <span class="n">j</span><span class="p">])</span> <span class="o"><</span> <span class="o">...</span> <span class="o"><</span> <span class="n">Index</span><span class="p">()</span> <span class="o"><</span> <span class="n">Arbitrary</span><span class="p">()</span> |
| <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> |
| <span class="o">+-----------+-------------+----------</span> <span class="o">...</span> <span class="o">----+---------|</span> |
| <span class="o">|</span> |
| <span class="n">preserves_partition_by</span> <span class="o">=</span> <span class="n">Arbitrary</span><span class="p">()</span> <span class="o">----------------------------+</span> |
| </pre></div> |
| </div> |
| <p>As a more interesting example, consider this expression, which requires Index |
| partitioning, and preserves just Singleton partitioning:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">requires_partition_by</span> <span class="o">=</span> <span class="n">Index</span><span class="p">()</span> <span class="o">-----------------------+</span> |
| <span class="o">|</span> |
| <span class="o">+-----------+-------------+----------</span> <span class="o">...</span> <span class="o">----|</span> |
| <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> |
| <span class="n">Singleton</span><span class="p">()</span> <span class="o"><</span> <span class="n">Index</span><span class="p">([</span><span class="n">i</span><span class="p">])</span> <span class="o"><</span> <span class="n">Index</span><span class="p">([</span><span class="n">i</span><span class="p">,</span> <span class="n">j</span><span class="p">])</span> <span class="o"><</span> <span class="o">...</span> <span class="o"><</span> <span class="n">Index</span><span class="p">()</span> <span class="o"><</span> <span class="n">Arbitrary</span><span class="p">()</span> |
| <span class="o">|</span> |
| <span class="o">|</span> |
| <span class="n">preserves_partition_by</span> <span class="o">=</span> <span class="n">Singleton</span><span class="p">()</span> |
| </pre></div> |
| </div> |
| <p>Note that any non-Arbitrary partitioning is an acceptable input for this |
| expression. However, unless the inputs are Singleton-partitioned, the |
| expression makes no guarantees about the partitioning of the output.</p> |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.Expression.proxy"> |
| <code class="descname">proxy</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → T<a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#Expression.proxy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.Expression.proxy" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.Expression.placeholders"> |
| <code class="descname">placeholders</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#Expression.placeholders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.Expression.placeholders" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns all the placeholders that self depends on.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.Expression.evaluate_at"> |
| <code class="descname">evaluate_at</code><span class="sig-paren">(</span><em>session: apache_beam.dataframe.expressions.Session</em><span class="sig-paren">)</span> → T<a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#Expression.evaluate_at"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.Expression.evaluate_at" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the result of self with the bindings given in session.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.Expression.requires_partition_by"> |
| <code class="descname">requires_partition_by</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → apache_beam.dataframe.partitionings.Partitioning<a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#Expression.requires_partition_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.Expression.requires_partition_by" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the partitioning, if any, require to evaluate this expression.</p> |
| <p>Returns partitioning.Arbitrary() to require no partitioning is required.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.Expression.preserves_partition_by"> |
| <code class="descname">preserves_partition_by</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → apache_beam.dataframe.partitionings.Partitioning<a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#Expression.preserves_partition_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.Expression.preserves_partition_by" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the partitioning, if any, preserved by this expression.</p> |
| <p>This gives an upper bound on the partitioning of its ouput. The actual |
| partitioning of the output may be less strict (e.g. if the input was |
| less partitioned).</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.dataframe.expressions.PlaceholderExpression"> |
| <em class="property">class </em><code class="descclassname">apache_beam.dataframe.expressions.</code><code class="descname">PlaceholderExpression</code><span class="sig-paren">(</span><em>proxy</em>, <em>reference=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#PlaceholderExpression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.PlaceholderExpression" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.dataframe.expressions.Expression" title="apache_beam.dataframe.expressions.Expression"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.dataframe.expressions.Expression</span></code></a></p> |
| <p>An expression whose value must be explicitly bound in the session.</p> |
| <p>Initialize a placeholder expression.</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>proxy</strong> – A proxy object with the type expected to be bound to this |
| expression. Used for type checking at pipeline construction time.</td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.PlaceholderExpression.placeholders"> |
| <code class="descname">placeholders</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#PlaceholderExpression.placeholders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.PlaceholderExpression.placeholders" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.PlaceholderExpression.args"> |
| <code class="descname">args</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#PlaceholderExpression.args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.PlaceholderExpression.args" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.PlaceholderExpression.evaluate_at"> |
| <code class="descname">evaluate_at</code><span class="sig-paren">(</span><em>session</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#PlaceholderExpression.evaluate_at"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.PlaceholderExpression.evaluate_at" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.PlaceholderExpression.requires_partition_by"> |
| <code class="descname">requires_partition_by</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#PlaceholderExpression.requires_partition_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.PlaceholderExpression.requires_partition_by" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.PlaceholderExpression.preserves_partition_by"> |
| <code class="descname">preserves_partition_by</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#PlaceholderExpression.preserves_partition_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.PlaceholderExpression.preserves_partition_by" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.dataframe.expressions.ConstantExpression"> |
| <em class="property">class </em><code class="descclassname">apache_beam.dataframe.expressions.</code><code class="descname">ConstantExpression</code><span class="sig-paren">(</span><em>value</em>, <em>proxy=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ConstantExpression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ConstantExpression" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.dataframe.expressions.Expression" title="apache_beam.dataframe.expressions.Expression"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.dataframe.expressions.Expression</span></code></a></p> |
| <p>An expression whose value is known at pipeline construction time.</p> |
| <p>Initialize a constant expression.</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>value</strong> – The constant value to be produced by this expression.</li> |
| <li><strong>proxy</strong> – (Optional) a proxy object with same type as <cite>value</cite> to use for |
| rapid type checking at pipeline construction time. If not provided, |
| <cite>value</cite> will be used directly.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.ConstantExpression.placeholders"> |
| <code class="descname">placeholders</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ConstantExpression.placeholders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ConstantExpression.placeholders" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.ConstantExpression.args"> |
| <code class="descname">args</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ConstantExpression.args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ConstantExpression.args" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.ConstantExpression.evaluate_at"> |
| <code class="descname">evaluate_at</code><span class="sig-paren">(</span><em>session</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ConstantExpression.evaluate_at"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ConstantExpression.evaluate_at" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.ConstantExpression.requires_partition_by"> |
| <code class="descname">requires_partition_by</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ConstantExpression.requires_partition_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ConstantExpression.requires_partition_by" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.ConstantExpression.preserves_partition_by"> |
| <code class="descname">preserves_partition_by</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ConstantExpression.preserves_partition_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ConstantExpression.preserves_partition_by" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.dataframe.expressions.ComputedExpression"> |
| <em class="property">class </em><code class="descclassname">apache_beam.dataframe.expressions.</code><code class="descname">ComputedExpression</code><span class="sig-paren">(</span><em>name</em>, <em>func</em>, <em>args</em>, <em>proxy=None</em>, <em>_id=None</em>, <em>requires_partition_by=Index</em>, <em>preserves_partition_by=Singleton</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ComputedExpression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ComputedExpression" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.dataframe.expressions.Expression" title="apache_beam.dataframe.expressions.Expression"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.dataframe.expressions.Expression</span></code></a></p> |
| <p>An expression whose value must be computed at pipeline execution time.</p> |
| <p>Initialize a computed expression.</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>name</strong> – The name of this expression.</li> |
| <li><strong>func</strong> – The function that will be used to compute the value of this |
| expression. Should accept arguments of the types returned when |
| evaluating the <cite>args</cite> expressions.</li> |
| <li><strong>args</strong> – The list of expressions that will be used to produce inputs to |
| <cite>func</cite>.</li> |
| <li><strong>proxy</strong> – (Optional) a proxy object with same type as the objects that this |
| ComputedExpression will produce at execution time. If not provided, a |
| proxy will be generated using <cite>func</cite> and the proxies of <cite>args</cite>.</li> |
| <li><strong>_id</strong> – (Optional) a string to uniquely identify this expression.</li> |
| <li><strong>requires_partition_by</strong> – The required (common) partitioning of the args.</li> |
| <li><strong>preserves_partition_by</strong> – The level of partitioning preserved.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.ComputedExpression.placeholders"> |
| <code class="descname">placeholders</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ComputedExpression.placeholders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ComputedExpression.placeholders" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.ComputedExpression.args"> |
| <code class="descname">args</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ComputedExpression.args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ComputedExpression.args" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.ComputedExpression.evaluate_at"> |
| <code class="descname">evaluate_at</code><span class="sig-paren">(</span><em>session</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ComputedExpression.evaluate_at"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ComputedExpression.evaluate_at" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.ComputedExpression.requires_partition_by"> |
| <code class="descname">requires_partition_by</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ComputedExpression.requires_partition_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ComputedExpression.requires_partition_by" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.dataframe.expressions.ComputedExpression.preserves_partition_by"> |
| <code class="descname">preserves_partition_by</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#ComputedExpression.preserves_partition_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.ComputedExpression.preserves_partition_by" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.dataframe.expressions.elementwise_expression"> |
| <code class="descclassname">apache_beam.dataframe.expressions.</code><code class="descname">elementwise_expression</code><span class="sig-paren">(</span><em>name</em>, <em>func</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#elementwise_expression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.elementwise_expression" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.dataframe.expressions.allow_non_parallel_operations"> |
| <code class="descclassname">apache_beam.dataframe.expressions.</code><code class="descname">allow_non_parallel_operations</code><span class="sig-paren">(</span><em>allow=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#allow_non_parallel_operations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.allow_non_parallel_operations" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="exception"> |
| <dt id="apache_beam.dataframe.expressions.NonParallelOperation"> |
| <em class="property">exception </em><code class="descclassname">apache_beam.dataframe.expressions.</code><code class="descname">NonParallelOperation</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/expressions.html#NonParallelOperation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.expressions.NonParallelOperation" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.dataframe.frame_base.html" class="btn btn-neutral float-right" title="apache_beam.dataframe.frame_base module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.dataframe.doctests.html" class="btn btn-neutral float-left" title="apache_beam.dataframe.doctests 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> |
