pydoc/2.47.0/_modules/apache_beam/runners/interactive/sql/sql_chain.html - beam-site - Git at Google



 <!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.sql.sql_chain &mdash; Apache Beam 2.47.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" />
 </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.47.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>
 <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"><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.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> &raquo;</li>

           <li><a href="../../../../index.html">Module code</a> &raquo;</li>

       <li>apache_beam.runners.interactive.sql.sql_chain</li>


       <li class="wy-breadcrumbs-aside">

       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <h1>Source code for apache_beam.runners.interactive.sql.sql_chain</h1><div class="highlight"><pre>
 <span></span><span class="c1">#</span>
 <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
 <span class="c1"># contributor license agreements.  See the NOTICE file distributed with</span>
 <span class="c1"># this work for additional information regarding copyright ownership.</span>
 <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
 <span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
 <span class="c1"># the License.  You may obtain a copy of the License at</span>
 <span class="c1">#</span>
 <span class="c1">#    http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="c1">#</span>
 <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
 <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
 <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c1"># See the License for the specific language governing permissions and</span>
 <span class="c1"># limitations under the License.</span>
 <span class="c1">#</span>

 <span class="sd">&quot;&quot;&quot;Module for tracking a chain of beam_sql magics applied.</span>

 <span class="sd">For internal use only; no backwards-compatibility guarantees.</span>
 <span class="sd">&quot;&quot;&quot;</span>

 <span class="c1"># pytype: skip-file</span>

 <span class="kn">import</span> <span class="nn">importlib</span>
 <span class="kn">import</span> <span class="nn">logging</span>
 <span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Set</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>

 <span class="kn">import</span> <span class="nn">apache_beam</span> <span class="k">as</span> <span class="nn">beam</span>
 <span class="kn">from</span> <span class="nn">apache_beam.internal</span> <span class="kn">import</span> <span class="n">pickler</span>
 <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive.sql.utils</span> <span class="kn">import</span> <span class="n">register_coder_for_schema</span>
 <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive.utils</span> <span class="kn">import</span> <span class="n">create_var_in_main</span>
 <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive.utils</span> <span class="kn">import</span> <span class="n">pcoll_by_name</span>
 <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive.utils</span> <span class="kn">import</span> <span class="n">progress_indicated</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms.sql</span> <span class="kn">import</span> <span class="n">SqlTransform</span>
 <span class="kn">from</span> <span class="nn">apache_beam.utils.interactive_utils</span> <span class="kn">import</span> <span class="n">is_in_ipython</span>

 <span class="n">_LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


 <div class="viewcode-block" id="SqlNode"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.sql.sql_chain.html#apache_beam.runners.interactive.sql.sql_chain.SqlNode">[docs]</a><span class="nd">@dataclass</span>
 <span class="k">class</span> <span class="nc">SqlNode</span><span class="p">:</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Each SqlNode represents a beam_sql magic applied.</span>

 <span class="sd">  Attributes:</span>
 <span class="sd">    output_name: the watched unique name of the beam_sql output. Can be used as</span>
 <span class="sd">      an identifier.</span>
 <span class="sd">    source: the inputs consumed by this node. Can be a pipeline or a set of</span>
 <span class="sd">      PCollections represented by their variable names watched. When it&#39;s a</span>
 <span class="sd">      pipeline, the node computes from raw values in the query, so the output</span>
 <span class="sd">      can be consumed by any SqlNode in any SqlChain.</span>
 <span class="sd">    query: the SQL query applied by this node.</span>
 <span class="sd">    schemas: the schemas (NamedTuple classes) used by this node.</span>
 <span class="sd">    evaluated: the pipelines this node has been evaluated for.</span>
 <span class="sd">    next: the next SqlNode applied chronologically.</span>
 <span class="sd">    execution_count: the execution count if in an IPython env.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="n">output_name</span><span class="p">:</span> <span class="nb">str</span>
   <span class="n">source</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">beam</span><span class="o">.</span><span class="n">Pipeline</span><span class="p">,</span> <span class="n">Set</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span>
   <span class="n">query</span><span class="p">:</span> <span class="nb">str</span>
   <span class="n">schemas</span><span class="p">:</span> <span class="n">Set</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
   <span class="n">evaluated</span><span class="p">:</span> <span class="n">Set</span><span class="p">[</span><span class="n">beam</span><span class="o">.</span><span class="n">Pipeline</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
   <span class="nb">next</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="s1">&#39;SqlNode&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
   <span class="n">execution_count</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>

   <span class="k">def</span> <span class="nf">__post_init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">schemas</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">schemas</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">evaluated</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">evaluated</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
     <span class="k">if</span> <span class="n">is_in_ipython</span><span class="p">():</span>
       <span class="kn">from</span> <span class="nn">IPython</span> <span class="kn">import</span> <span class="n">get_ipython</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">execution_count</span> <span class="o">=</span> <span class="n">get_ipython</span><span class="p">()</span><span class="o">.</span><span class="n">execution_count</span>

   <span class="k">def</span> <span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="nb">hash</span><span class="p">(</span>
         <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">source</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">execution_count</span><span class="p">))</span>

 <div class="viewcode-block" id="SqlNode.to_pipeline"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.sql.sql_chain.html#apache_beam.runners.interactive.sql.sql_chain.SqlNode.to_pipeline">[docs]</a>  <span class="k">def</span> <span class="nf">to_pipeline</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pipeline</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">beam</span><span class="o">.</span><span class="n">Pipeline</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">beam</span><span class="o">.</span><span class="n">Pipeline</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Converts the chain into an executable pipeline.&quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">pipeline</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">evaluated</span><span class="p">:</span>
       <span class="c1"># The whole chain should form a single pipeline.</span>
       <span class="n">source</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">source</span>
       <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">source</span><span class="p">,</span> <span class="n">beam</span><span class="o">.</span><span class="n">Pipeline</span><span class="p">):</span>
         <span class="k">if</span> <span class="n">pipeline</span><span class="p">:</span>  <span class="c1"># use the known pipeline</span>
           <span class="n">source</span> <span class="o">=</span> <span class="n">pipeline</span>
         <span class="k">else</span><span class="p">:</span>  <span class="c1"># use the source pipeline</span>
           <span class="n">pipeline</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">source</span>
       <span class="k">else</span><span class="p">:</span>
         <span class="n">name_to_pcoll</span> <span class="o">=</span> <span class="n">pcoll_by_name</span><span class="p">()</span>
         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">source</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
           <span class="n">source</span> <span class="o">=</span> <span class="n">name_to_pcoll</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">source</span><span class="p">)))</span>
         <span class="k">else</span><span class="p">:</span>
           <span class="n">source</span> <span class="o">=</span> <span class="p">{</span><span class="n">s</span><span class="p">:</span> <span class="n">name_to_pcoll</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">source</span><span class="p">}</span>
       <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">beam</span><span class="o">.</span><span class="n">Pipeline</span><span class="p">):</span>
         <span class="n">output</span> <span class="o">=</span> <span class="n">source</span> <span class="o">|</span> <span class="s1">&#39;beam_sql_</span><span class="si">{}</span><span class="s1">_</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">output_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">execution_count</span><span class="p">)</span> <span class="o">&gt;&gt;</span> <span class="n">SqlTransform</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">)</span>
       <span class="k">else</span><span class="p">:</span>
         <span class="n">output</span> <span class="o">=</span> <span class="n">source</span> <span class="o">|</span> <span class="s1">&#39;schema_loaded_beam_sql_</span><span class="si">{}</span><span class="s1">_</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">output_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">execution_count</span>
         <span class="p">)</span> <span class="o">&gt;&gt;</span> <span class="n">SchemaLoadedSqlTransform</span><span class="p">(</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">output_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">schemas</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">execution_count</span><span class="p">)</span>
       <span class="n">_</span> <span class="o">=</span> <span class="n">create_var_in_main</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output_name</span><span class="p">,</span> <span class="n">output</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">evaluated</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">pipeline</span><span class="p">)</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="p">:</span>
       <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="o">.</span><span class="n">to_pipeline</span><span class="p">(</span><span class="n">pipeline</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="k">return</span> <span class="n">pipeline</span></div></div>


 <div class="viewcode-block" id="SchemaLoadedSqlTransform"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.sql.sql_chain.html#apache_beam.runners.interactive.sql.sql_chain.SchemaLoadedSqlTransform">[docs]</a><span class="k">class</span> <span class="nc">SchemaLoadedSqlTransform</span><span class="p">(</span><span class="n">beam</span><span class="o">.</span><span class="n">PTransform</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;PTransform that loads schema before executing SQL.</span>

 <span class="sd">  When submitting a pipeline to remote runner for execution, schemas defined in</span>
 <span class="sd">  the main module are not available without save_main_session. However,</span>
 <span class="sd">  save_main_session might fail when there is anything unpicklable. This DoFn</span>
 <span class="sd">  makes sure only the schemas needed are pickled locally and restored later on</span>
 <span class="sd">  workers.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output_name</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">schemas</span><span class="p">,</span> <span class="n">execution_count</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">output_name</span> <span class="o">=</span> <span class="n">output_name</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">query</span> <span class="o">=</span> <span class="n">query</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">schemas</span> <span class="o">=</span> <span class="n">schemas</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">execution_count</span> <span class="o">=</span> <span class="n">execution_count</span>
     <span class="c1"># TODO(BEAM-8123): clean up this attribute or the whole wrapper PTransform.</span>
     <span class="c1"># Dill does not preserve everything. On the other hand, save_main_session</span>
     <span class="c1"># is not stable. Until cloudpickle replaces dill in Beam, we work around</span>
     <span class="c1"># it by explicitly pickling annotations and load schemas in remote main</span>
     <span class="c1"># sessions.</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">schema_annotations</span> <span class="o">=</span> <span class="p">[</span><span class="n">s</span><span class="o">.</span><span class="vm">__annotations__</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">schemas</span><span class="p">]</span>

   <span class="k">class</span> <span class="nc">_SqlTransformDoFn</span><span class="p">(</span><span class="n">beam</span><span class="o">.</span><span class="n">DoFn</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;The DoFn yields all its input without any transform but a setup to</span>
 <span class="sd">    configure the main session.&quot;&quot;&quot;</span>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">schemas</span><span class="p">,</span> <span class="n">annotations</span><span class="p">):</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">pickled_schemas</span> <span class="o">=</span> <span class="p">[</span><span class="n">pickler</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">schemas</span><span class="p">]</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">pickled_annotations</span> <span class="o">=</span> <span class="p">[</span><span class="n">pickler</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">a</span><span class="p">)</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">annotations</span><span class="p">]</span>

     <span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
       <span class="n">main_session</span> <span class="o">=</span> <span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span><span class="s1">&#39;__main__&#39;</span><span class="p">)</span>
       <span class="k">for</span> <span class="n">pickled_schema</span><span class="p">,</span> <span class="n">pickled_annotation</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span>
           <span class="bp">self</span><span class="o">.</span><span class="n">pickled_schemas</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">pickled_annotations</span><span class="p">):</span>
         <span class="n">schema</span> <span class="o">=</span> <span class="n">pickler</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">pickled_schema</span><span class="p">)</span>
         <span class="n">schema</span><span class="o">.</span><span class="vm">__annotations__</span> <span class="o">=</span> <span class="n">pickler</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">pickled_annotation</span><span class="p">)</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">main_session</span><span class="p">,</span> <span class="n">schema</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span>
             <span class="nb">getattr</span><span class="p">(</span><span class="n">main_session</span><span class="p">,</span> <span class="n">schema</span><span class="o">.</span><span class="vm">__name__</span><span class="p">),</span> <span class="s1">&#39;__annotations__&#39;</span><span class="p">):</span>
           <span class="c1"># Restore the schema in the main session on the [remote] worker.</span>
           <span class="nb">setattr</span><span class="p">(</span><span class="n">main_session</span><span class="p">,</span> <span class="n">schema</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="n">schema</span><span class="p">)</span>
         <span class="n">register_coder_for_schema</span><span class="p">(</span><span class="n">schema</span><span class="p">)</span>

     <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">e</span><span class="p">):</span>
       <span class="k">yield</span> <span class="n">e</span>

 <div class="viewcode-block" id="SchemaLoadedSqlTransform.expand"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.sql.sql_chain.html#apache_beam.runners.interactive.sql.sql_chain.SchemaLoadedSqlTransform.expand">[docs]</a>  <span class="k">def</span> <span class="nf">expand</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Applies the SQL transform. If a PCollection uses a schema defined in</span>
 <span class="sd">    the main session, use the additional DoFn to restore it on the worker.&quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
       <span class="n">schema_loaded</span> <span class="o">=</span> <span class="p">{</span>
           <span class="n">tag</span><span class="p">:</span> <span class="n">pcoll</span> <span class="o">|</span> <span class="s1">&#39;load_schemas_</span><span class="si">{}</span><span class="s1">_tag_</span><span class="si">{}</span><span class="s1">_</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
               <span class="bp">self</span><span class="o">.</span><span class="n">output_name</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">execution_count</span><span class="p">)</span> <span class="o">&gt;&gt;</span> <span class="n">beam</span><span class="o">.</span><span class="n">ParDo</span><span class="p">(</span>
                   <span class="bp">self</span><span class="o">.</span><span class="n">_SqlTransformDoFn</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">schemas</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">schema_annotations</span><span class="p">))</span>
           <span class="k">if</span> <span class="n">pcoll</span><span class="o">.</span><span class="n">element_type</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">schemas</span> <span class="k">else</span> <span class="n">pcoll</span>
           <span class="k">for</span> <span class="n">tag</span><span class="p">,</span>
           <span class="n">pcoll</span> <span class="ow">in</span> <span class="n">source</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
       <span class="p">}</span>
     <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">beam</span><span class="o">.</span><span class="n">pvalue</span><span class="o">.</span><span class="n">PCollection</span><span class="p">):</span>
       <span class="n">schema_loaded</span> <span class="o">=</span> <span class="n">source</span> <span class="o">|</span> <span class="s1">&#39;load_schemas_</span><span class="si">{}</span><span class="s1">_</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
           <span class="bp">self</span><span class="o">.</span><span class="n">output_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">execution_count</span><span class="p">)</span> <span class="o">&gt;&gt;</span> <span class="n">beam</span><span class="o">.</span><span class="n">ParDo</span><span class="p">(</span>
               <span class="bp">self</span><span class="o">.</span><span class="n">_SqlTransformDoFn</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">schemas</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">schema_annotations</span><span class="p">)</span>
           <span class="p">)</span> <span class="k">if</span> <span class="n">source</span><span class="o">.</span><span class="n">element_type</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">schemas</span> <span class="k">else</span> <span class="n">source</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
           <span class="s1">&#39;</span><span class="si">{}</span><span class="s1"> should be either a single PCollection or a dict of named &#39;</span>
           <span class="s1">&#39;PCollections.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">source</span><span class="p">))</span>
     <span class="k">return</span> <span class="n">schema_loaded</span> <span class="o">|</span> <span class="s1">&#39;beam_sql_</span><span class="si">{}</span><span class="s1">_</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">output_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">execution_count</span><span class="p">)</span> <span class="o">&gt;&gt;</span> <span class="n">SqlTransform</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">)</span></div></div>


 <div class="viewcode-block" id="SqlChain"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.sql.sql_chain.html#apache_beam.runners.interactive.sql.sql_chain.SqlChain">[docs]</a><span class="nd">@dataclass</span>
 <span class="k">class</span> <span class="nc">SqlChain</span><span class="p">:</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A chain of SqlNodes.</span>

 <span class="sd">  Attributes:</span>
 <span class="sd">    nodes: all nodes by their output_names.</span>
 <span class="sd">    root: the first SqlNode applied chronologically.</span>
 <span class="sd">    current: the last node applied.</span>
 <span class="sd">    user_pipeline: the user defined pipeline this chain originates from. If</span>
 <span class="sd">      None, the whole chain just computes from raw values in queries.</span>
 <span class="sd">      Otherwise, at least some of the nodes in chain has queried against</span>
 <span class="sd">      PCollections.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="n">nodes</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">SqlNode</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
   <span class="n">root</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">SqlNode</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
   <span class="n">current</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">SqlNode</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
   <span class="n">user_pipeline</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">beam</span><span class="o">.</span><span class="n">Pipeline</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>

   <span class="k">def</span> <span class="nf">__post_init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span> <span class="o">=</span> <span class="p">{}</span>

 <div class="viewcode-block" id="SqlChain.to_pipeline"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.sql.sql_chain.html#apache_beam.runners.interactive.sql.sql_chain.SqlChain.to_pipeline">[docs]</a>  <span class="nd">@progress_indicated</span>
   <span class="k">def</span> <span class="nf">to_pipeline</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">beam</span><span class="o">.</span><span class="n">Pipeline</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Converts the chain into a beam pipeline.&quot;&quot;&quot;</span>
     <span class="n">pipeline_to_execute</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">to_pipeline</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">user_pipeline</span><span class="p">)</span>
     <span class="c1"># The pipeline definitely contains external transform: SqlTransform.</span>
     <span class="n">pipeline_to_execute</span><span class="o">.</span><span class="n">contains_external_transforms</span> <span class="o">=</span> <span class="kc">True</span>
     <span class="k">return</span> <span class="n">pipeline_to_execute</span></div>

 <div class="viewcode-block" id="SqlChain.append"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.sql.sql_chain.html#apache_beam.runners.interactive.sql.sql_chain.SqlChain.append">[docs]</a>  <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node</span><span class="p">:</span> <span class="n">SqlNode</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;SqlChain&#39;</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Appends a node to the chain.&quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">current</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">current</span><span class="o">.</span><span class="n">next</span> <span class="o">=</span> <span class="n">node</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">=</span> <span class="n">node</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">current</span> <span class="o">=</span> <span class="n">node</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span><span class="p">[</span><span class="n">node</span><span class="o">.</span><span class="n">output_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">node</span>
     <span class="k">return</span> <span class="bp">self</span></div>

 <div class="viewcode-block" id="SqlChain.get"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.sql.sql_chain.html#apache_beam.runners.interactive.sql.sql_chain.SqlChain.get">[docs]</a>  <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">SqlNode</span><span class="p">]:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Gets a node from the chain based on the given output_name.&quot;&quot;&quot;</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">output_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div></div>
 </pre></div>

            </div>

           </div>
           <footer>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

 </footer>

         </div>
       </div>

     </section>

   </div>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


 </body>
 </html>