| |
| |
| <!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.beam_sql_magics module — 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.sql.sql_chain module" href="apache_beam.runners.interactive.sql.sql_chain.html" /> |
| <link rel="prev" title="apache_beam.runners.interactive.sql package" href="apache_beam.runners.interactive.sql.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> »</li> |
| |
| <li><a href="apache_beam.runners.html">apache_beam.runners package</a> »</li> |
| |
| <li><a href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a> »</li> |
| |
| <li><a href="apache_beam.runners.interactive.sql.html">apache_beam.runners.interactive.sql package</a> »</li> |
| |
| <li>apache_beam.runners.interactive.sql.beam_sql_magics module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.interactive.sql.beam_sql_magics.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.beam_sql_magics"> |
| <span id="apache-beam-runners-interactive-sql-beam-sql-magics-module"></span><h1>apache_beam.runners.interactive.sql.beam_sql_magics module<a class="headerlink" href="#module-apache_beam.runners.interactive.sql.beam_sql_magics" title="Permalink to this headline">¶</a></h1> |
| <p>Module of beam_sql cell magic that executes a Beam SQL.</p> |
| <p>Only works within an IPython kernel.</p> |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlParser"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.sql.beam_sql_magics.</code><code class="descname">BeamSqlParser</code><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#BeamSqlParser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlParser" 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 parser to parse beam_sql inputs.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlParser.parse"> |
| <code class="descname">parse</code><span class="sig-paren">(</span><em>args: List[str]</em><span class="sig-paren">)</span> → Optional[argparse.Namespace]<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#BeamSqlParser.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlParser.parse" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Parses a list of string inputs.</p> |
| <dl class="docutils"> |
| <dt>The parsed namespace contains these attributes:</dt> |
| <dd>output_name: Optional[str], the output variable name. |
| verbose: bool, whether to display more details of the magic execution. |
| query: Optional[List[str]], the beam SQL query to execute.</dd> |
| </dl> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The parsed args or None if fail to parse.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlParser.print_help"> |
| <code class="descname">print_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → None<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#BeamSqlParser.print_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlParser.print_help" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.on_error"> |
| <code class="descclassname">apache_beam.runners.interactive.sql.beam_sql_magics.</code><code class="descname">on_error</code><span class="sig-paren">(</span><em>error_msg</em>, <em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#on_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.on_error" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Logs the error and the usage example.</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlMagics"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.sql.beam_sql_magics.</code><code class="descname">BeamSqlMagics</code><span class="sig-paren">(</span><em>shell</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#BeamSqlMagics"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlMagics" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">IPython.core.magic.Magics</span></code></p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlMagics.beam_sql"> |
| <code class="descname">beam_sql</code><span class="sig-paren">(</span><em>line: str</em>, <em>cell: Optional[str] = None</em><span class="sig-paren">)</span> → Optional[apache_beam.pvalue.PValue]<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#BeamSqlMagics.beam_sql"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlMagics.beam_sql" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The beam_sql line/cell magic that executes a Beam SQL.</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>line</strong> – the string on the same line after the beam_sql magic.</li> |
| <li><strong>cell</strong> – everything else in the same notebook cell as a string. If None, |
| beam_sql is used as line magic. Otherwise, cell magic.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <p>Returns None if running into an error or waiting for user input (running on |
| a selected runner remotely), otherwise a PValue as if a SqlTransform is |
| applied.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlMagics.magics"> |
| <code class="descname">magics</code><em class="property"> = {'cell': {'beam_sql': 'beam_sql'}, 'line': {'beam_sql': 'beam_sql'}}</em><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlMagics.magics" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlMagics.registered"> |
| <code class="descname">registered</code><em class="property"> = True</em><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.BeamSqlMagics.registered" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.collect_data_for_local_run"> |
| <code class="descclassname">apache_beam.runners.interactive.sql.beam_sql_magics.</code><code class="descname">collect_data_for_local_run</code><span class="sig-paren">(</span><em>query: str, found: Dict[str, apache_beam.pvalue.PCollection]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#collect_data_for_local_run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.collect_data_for_local_run" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.apply_sql"> |
| <code class="descclassname">apache_beam.runners.interactive.sql.beam_sql_magics.</code><code class="descname">apply_sql</code><span class="sig-paren">(</span><em>query: str, output_name: Optional[str], found: Dict[str, apache_beam.pvalue.PCollection], run: bool = True</em><span class="sig-paren">)</span> → Tuple[str, Union[apache_beam.pvalue.PValue, apache_beam.runners.interactive.sql.sql_chain.SqlNode], apache_beam.runners.interactive.sql.sql_chain.SqlChain]<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#apply_sql"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.apply_sql" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Applies a SqlTransform with the given sql and queried PCollections.</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 simple"> |
| <li><strong>query</strong> – The SQL query executed in the magic.</li> |
| <li><strong>output_name</strong> – (optional) The output variable name in __main__ module.</li> |
| <li><strong>found</strong> – The PCollections with variable names found to be used in the query.</li> |
| <li><strong>run</strong> – Whether to prepare the SQL pipeline for a local run or not.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A tuple of values. First str value is the output variable name in |
| __main__ module, auto-generated if not provided. Second value: if run, |
| it’s a PValue; otherwise, a SqlNode tracks the SQL without applying it or |
| executing it. Third value: SqlChain is a chain of SqlNodes that have been |
| applied.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.pcolls_from_streaming_cache"> |
| <code class="descclassname">apache_beam.runners.interactive.sql.beam_sql_magics.</code><code class="descname">pcolls_from_streaming_cache</code><span class="sig-paren">(</span><em>user_pipeline: apache_beam.pipeline.Pipeline, query_pipeline: apache_beam.pipeline.Pipeline, name_to_pcoll: Dict[str, apache_beam.pvalue.PCollection]</em><span class="sig-paren">)</span> → Dict[str, apache_beam.pvalue.PCollection]<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#pcolls_from_streaming_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.pcolls_from_streaming_cache" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reads PCollection cache through the TestStream.</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 simple"> |
| <li><strong>user_pipeline</strong> – The beam.Pipeline object defined by the user in the |
| notebook.</li> |
| <li><strong>query_pipeline</strong> – The beam.Pipeline object built by the magic to execute the |
| SQL query.</li> |
| <li><strong>name_to_pcoll</strong> – PCollections with variable names used in the SQL query.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A Dict[str, beam.PCollection], where each PCollection is tagged with |
| their PCollection variable names, read from the cache.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <p>When the user_pipeline has unbounded sources, we force all cache reads to go |
| through the TestStream even if they are bounded sources.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.cache_output"> |
| <code class="descclassname">apache_beam.runners.interactive.sql.beam_sql_magics.</code><code class="descname">cache_output</code><span class="sig-paren">(</span><em>output_name: str</em>, <em>output: apache_beam.pvalue.PValue</em><span class="sig-paren">)</span> → None<a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#cache_output"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.cache_output" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.sql.beam_sql_magics.load_ipython_extension"> |
| <code class="descclassname">apache_beam.runners.interactive.sql.beam_sql_magics.</code><code class="descname">load_ipython_extension</code><span class="sig-paren">(</span><em>ipython</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/sql/beam_sql_magics.html#load_ipython_extension"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.sql.beam_sql_magics.load_ipython_extension" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Marks this module as an IPython extension.</p> |
| <p>To load this magic in an IPython environment, execute: |
| %load_ext apache_beam.runners.interactive.sql.beam_sql_magics.</p> |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.runners.interactive.sql.sql_chain.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.sql.sql_chain module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.runners.interactive.sql.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.sql package" 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> |
