pydoc/2.36.0/apache_beam.runners.interactive.sql.utils.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.utils module &mdash; Apache Beam 2.36.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.runners.interactive.testing package" href="apache_beam.runners.interactive.testing.html" />
     <link rel="prev" title="apache_beam.runners.interactive.sql.sql_chain module" href="apache_beam.runners.interactive.sql.sql_chain.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.36.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 current"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a></li>
 <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a><ul class="current">
 <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.interactive.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.html#submodules">Submodules</a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.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> &raquo;</li>

           <li><a href="apache_beam.runners.html">apache_beam.runners package</a> &raquo;</li>

           <li><a href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a> &raquo;</li>

           <li><a href="apache_beam.runners.interactive.sql.html">apache_beam.runners.interactive.sql package</a> &raquo;</li>

       <li>apache_beam.runners.interactive.sql.utils module</li>


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


             <a href="_sources/apache_beam.runners.interactive.sql.utils.rst.txt" rel="nofollow"> View page source</a>


       </li>

   </ul>


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

   <div class="section" id="module-apache_beam.runners.interactive.sql.utils">
 <span id="apache-beam-runners-interactive-sql-utils-module"></span><h1>apache_beam.runners.interactive.sql.utils module<a class="headerlink" href="#module-apache_beam.runners.interactive.sql.utils" title="Permalink to this headline">¶</a></h1>
 <p>Module of utilities for SQL magics.</p>
 <p>For internal use only; no backward-compatibility guarantees.</p>
 <dl class="function">
 <dt id="apache_beam.runners.interactive.sql.utils.register_coder_for_schema">
 <code class="descclassname">apache_beam.runners.interactive.sql.utils.</code><code class="descname">register_coder_for_schema</code><span class="sig-paren">(</span><em>schema: NamedTuple</em>, <em>verbose: bool = False</em><span class="sig-paren">)</span> &#x2192; None<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#register_coder_for_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.register_coder_for_schema" title="Permalink to this definition">¶</a></dt>
 <dd><p>Registers a RowCoder for the given schema if hasn’t.</p>
 <p>Notifies the user of what code has been implicitly executed.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.sql.utils.find_pcolls">
 <code class="descclassname">apache_beam.runners.interactive.sql.utils.</code><code class="descname">find_pcolls</code><span class="sig-paren">(</span><em>sql: str, pcolls: Dict[str, apache_beam.pvalue.PCollection], verbose: bool = False</em><span class="sig-paren">)</span> &#x2192; Dict[str, apache_beam.pvalue.PCollection]<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#find_pcolls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.find_pcolls" title="Permalink to this definition">¶</a></dt>
 <dd><p>Finds all PCollections used in the given sql query.</p>
 <p>It does a simple word by word match and calls ib.collect for each PCollection
 found.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.sql.utils.replace_single_pcoll_token">
 <code class="descclassname">apache_beam.runners.interactive.sql.utils.</code><code class="descname">replace_single_pcoll_token</code><span class="sig-paren">(</span><em>sql: str</em>, <em>pcoll_name: str</em><span class="sig-paren">)</span> &#x2192; str<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#replace_single_pcoll_token"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.replace_single_pcoll_token" title="Permalink to this definition">¶</a></dt>
 <dd><p>Replaces the pcoll_name used in the sql with ‘PCOLLECTION’.</p>
 <p>For sql query using only a single PCollection, the PCollection needs to be
 referred to as ‘PCOLLECTION’ instead of its variable/tag name.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.sql.utils.pformat_namedtuple">
 <code class="descclassname">apache_beam.runners.interactive.sql.utils.</code><code class="descname">pformat_namedtuple</code><span class="sig-paren">(</span><em>schema: NamedTuple</em><span class="sig-paren">)</span> &#x2192; str<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#pformat_namedtuple"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.pformat_namedtuple" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.sql.utils.pformat_dict">
 <code class="descclassname">apache_beam.runners.interactive.sql.utils.</code><code class="descname">pformat_dict</code><span class="sig-paren">(</span><em>raw_input: Dict[str, Any]</em><span class="sig-paren">)</span> &#x2192; str<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#pformat_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.pformat_dict" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="class">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsEntry">
 <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.sql.utils.</code><code class="descname">OptionsEntry</code><span class="sig-paren">(</span><em>label: str, help: str, cls: Type[apache_beam.options.pipeline_options.PipelineOptions], arg_builder: Union[str, Dict[str, Optional[Callable]]], default: Optional[str] = None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#OptionsEntry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsEntry" 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>An entry of PipelineOptions that can be visualized through ipywidgets to
 take inputs in IPython notebooks interactively.</p>
 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsEntry.label">
 <code class="descname">label</code><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsEntry.label" title="Permalink to this definition">¶</a></dt>
 <dd><p>The value of the Label widget.</p>
 </dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsEntry.help">
 <code class="descname">help</code><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsEntry.help" title="Permalink to this definition">¶</a></dt>
 <dd><p>The help message of the entry, usually the same to the help in
 PipelineOptions.</p>
 </dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsEntry.cls">
 <code class="descname">cls</code><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsEntry.cls" title="Permalink to this definition">¶</a></dt>
 <dd><p>The PipelineOptions class/subclass the options belong to.</p>
 </dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsEntry.arg_builder">
 <code class="descname">arg_builder</code><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsEntry.arg_builder" title="Permalink to this definition">¶</a></dt>
 <dd><p>Builds the argument/option. If it’s a str, this entry
 assigns the input ipywidget’s value directly to the argument. If it’s a
 Dict, use the corresponding Callable to assign the input value to each
 argument. If Callable is None, fallback to assign the input value
 directly. This allows building multiple similar PipelineOptions
 arguments from a single input, such as staging_location and
 temp_location in GoogleCloudOptions.</p>
 </dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsEntry.default">
 <code class="descname">default</code><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsEntry.default" title="Permalink to this definition">¶</a></dt>
 <dd><p>The default value of the entry, None if absent.</p>
 </dd></dl>

 <dl class="attribute">
 <dt>
 <code class="descname">default</code><em class="property"> = None</em></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsForm">
 <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.sql.utils.</code><code class="descname">OptionsForm</code><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#OptionsForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsForm" 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 form visualized to take inputs from users in IPython Notebooks and
 generate PipelineOptions to run pipelines.</p>
 <dl class="method">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsForm.add">
 <code class="descname">add</code><span class="sig-paren">(</span><em>entry: apache_beam.runners.interactive.sql.utils.OptionsEntry</em><span class="sig-paren">)</span> &#x2192; apache_beam.runners.interactive.sql.utils.OptionsForm<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#OptionsForm.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsForm.add" title="Permalink to this definition">¶</a></dt>
 <dd><p>Adds an OptionsEntry to the form.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsForm.to_options">
 <code class="descname">to_options</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; apache_beam.options.pipeline_options.PipelineOptions<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#OptionsForm.to_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsForm.to_options" title="Permalink to this definition">¶</a></dt>
 <dd><p>Builds the PipelineOptions based on user inputs.</p>
 <p>Can only be invoked after display_for_input.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsForm.additional_options">
 <code class="descname">additional_options</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#OptionsForm.additional_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsForm.additional_options" title="Permalink to this definition">¶</a></dt>
 <dd><p>Alters the self.options with additional config.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsForm.display_for_input">
 <code class="descname">display_for_input</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; apache_beam.runners.interactive.sql.utils.OptionsForm<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#OptionsForm.display_for_input"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsForm.display_for_input" title="Permalink to this definition">¶</a></dt>
 <dd><p>Displays the widgets to take user inputs.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.sql.utils.OptionsForm.display_actions">
 <code class="descname">display_actions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#OptionsForm.display_actions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.OptionsForm.display_actions" title="Permalink to this definition">¶</a></dt>
 <dd><p>Displays actionable widgets to utilize the options, run pipelines and
 etc.</p>
 </dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.runners.interactive.sql.utils.DataflowOptionsForm">
 <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.sql.utils.</code><code class="descname">DataflowOptionsForm</code><span class="sig-paren">(</span><em>output_name: str</em>, <em>output_pcoll: apache_beam.pvalue.PCollection</em>, <em>verbose: bool = False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#DataflowOptionsForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.DataflowOptionsForm" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.runners.interactive.sql.utils.OptionsForm" title="apache_beam.runners.interactive.sql.utils.OptionsForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.runners.interactive.sql.utils.OptionsForm</span></code></a></p>
 <p>A form to take inputs from users in IPython Notebooks to build
 PipelineOptions to run pipelines on Dataflow.</p>
 <p>Only contains minimum fields needed.</p>
 <p>Inits the OptionsForm for setting up Dataflow jobs.</p>
 <dl class="method">
 <dt id="apache_beam.runners.interactive.sql.utils.DataflowOptionsForm.additional_options">
 <code class="descname">additional_options</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#DataflowOptionsForm.additional_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.DataflowOptionsForm.additional_options" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.sql.utils.DataflowOptionsForm.display_actions">
 <code class="descname">display_actions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/utils.html#DataflowOptionsForm.display_actions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.utils.DataflowOptionsForm.display_actions" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 </div>


            </div>

           </div>
           <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="apache_beam.runners.interactive.testing.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.testing package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="apache_beam.runners.interactive.sql.sql_chain.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.sql.sql_chain module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

     </div>


   <hr/>

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

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/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>