pydoc/2.57.0/apache_beam.transforms.external_transform_provider.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.transforms.external_transform_provider module &mdash; Apache Beam 2.57.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.transforms.fully_qualified_named_transform module" href="apache_beam.transforms.fully_qualified_named_transform.html" />
     <link rel="prev" title="apache_beam.transforms.external_java module" href="apache_beam.transforms.external_java.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.57.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"><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 current"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="apache_beam.transforms.html#subpackages">Subpackages</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.transforms.html#submodules">Submodules</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combinefn_lifecycle_pipeline.html">apache_beam.transforms.combinefn_lifecycle_pipeline module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combiners.html">apache_beam.transforms.combiners module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.core.html">apache_beam.transforms.core module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.create_source.html">apache_beam.transforms.create_source module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.deduplicate.html">apache_beam.transforms.deduplicate module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.display.html">apache_beam.transforms.display module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.enrichment.html">apache_beam.transforms.enrichment module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.environments.html">apache_beam.transforms.environments module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external.html">apache_beam.transforms.external module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_java.html">apache_beam.transforms.external_java module</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.transforms.external_transform_provider module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.fully_qualified_named_transform.html">apache_beam.transforms.fully_qualified_named_transform module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.periodicsequence.html">apache_beam.transforms.periodicsequence module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.ptransform.html">apache_beam.transforms.ptransform module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.resources.html">apache_beam.transforms.resources module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sideinputs.html">apache_beam.transforms.sideinputs module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sql.html">apache_beam.transforms.sql module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.stats.html">apache_beam.transforms.stats module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.timeutil.html">apache_beam.transforms.timeutil module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.trigger.html">apache_beam.transforms.trigger module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.userstate.html">apache_beam.transforms.userstate module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.util.html">apache_beam.transforms.util module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.window.html">apache_beam.transforms.window module</a></li>
 </ul>
 </li>
 </ul>
 </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="apache_beam.transforms.html">apache_beam.transforms package</a> &raquo;</li>

       <li>apache_beam.transforms.external_transform_provider module</li>


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


             <a href="_sources/apache_beam.transforms.external_transform_provider.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.transforms.external_transform_provider">
 <span id="apache-beam-transforms-external-transform-provider-module"></span><h1>apache_beam.transforms.external_transform_provider module<a class="headerlink" href="#module-apache_beam.transforms.external_transform_provider" title="Permalink to this headline">¶</a></h1>
 <dl class="class">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransform">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external_transform_provider.</code><code class="descname">ExternalTransform</code><span class="sig-paren">(</span><em>expansion_service=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external_transform_provider.html#ExternalTransform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransform" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
 <p>Template for a wrapper class of an external SchemaTransform</p>
 <p>This is a superclass for dynamically generated SchemaTransform wrappers and
 is not meant to be manually instantiated.</p>
 <p>Experimental; no backwards compatibility guarantees.</p>
 <dl class="attribute">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransform.default_expansion_service">
 <code class="descname">default_expansion_service</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransform.default_expansion_service" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransform.description">
 <code class="descname">description</code><em class="property"> = ''</em><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransform.description" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransform.identifier">
 <code class="descname">identifier</code><em class="property"> = ''</em><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransform.identifier" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransform.configuration_schema">
 <code class="descname">configuration_schema</code><em class="property"> = {}</em><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransform.configuration_schema" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransform.expand">
 <code class="descname">expand</code><span class="sig-paren">(</span><em>input</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external_transform_provider.html#ExternalTransform.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransform.expand" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransformProvider">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external_transform_provider.</code><code class="descname">ExternalTransformProvider</code><span class="sig-paren">(</span><em>expansion_services</em>, <em>urn_pattern='^beam:schematransform:org.apache.beam:([\w-]+):(\w+)$'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external_transform_provider.html#ExternalTransformProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransformProvider" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Dynamically discovers Schema-aware external transforms from a given list
 of expansion services and provides them as ready PTransforms.</p>
 <p>A <a class="reference internal" href="#apache_beam.transforms.external_transform_provider.ExternalTransform" title="apache_beam.transforms.external_transform_provider.ExternalTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExternalTransform</span></code></a> subclass is generated for each external
 transform, and is named based on what can be inferred from the URN
 (see the <cite>urn_pattern</cite> parameter).</p>
 <p>These classes are generated when <a class="reference internal" href="#apache_beam.transforms.external_transform_provider.ExternalTransformProvider" title="apache_beam.transforms.external_transform_provider.ExternalTransformProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExternalTransformProvider</span></code></a> is
 initialized. We need to give it one or more expansion service addresses that
 are already up and running:
 &gt;&gt;&gt; provider = ExternalTransformProvider([“localhost:12345”,
 …                                             “localhost:12121”])
 We can also give it the gradle target of a standard Beam expansion service:
 &gt;&gt;&gt; provider = ExternalTransform(BeamJarExpansionService(
 …     “sdks:java:io:google-cloud-platform:expansion-service:shadowJar”))
 Let’s take a look at the output of <a class="reference internal" href="#apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get_available" title="apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get_available"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_available()</span></code></a> to know the
 available transforms in the expansion service(s) we provided:
 &gt;&gt;&gt; provider.get_available()
 [(‘JdbcWrite’, ‘beam:schematransform:org.apache.beam:jdbc_write:v1’),
 (‘BigtableRead’, ‘beam:schematransform:org.apache.beam:bigtable_read:v1’),
 …]</p>
 <p>Then retrieve a transform by <a class="reference internal" href="#apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get" title="apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">get()</span></code></a>, <a class="reference internal" href="#apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get_urn" title="apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get_urn"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_urn()</span></code></a>, or by directly
 accessing it as an attribute of <a class="reference internal" href="#apache_beam.transforms.external_transform_provider.ExternalTransformProvider" title="apache_beam.transforms.external_transform_provider.ExternalTransformProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExternalTransformProvider</span></code></a>.
 All of the following commands do the same thing:
 &gt;&gt;&gt; provider.get(‘BigqueryStorageRead’)
 &gt;&gt;&gt; provider.get_urn(
 …       ‘beam:schematransform:org.apache.beam:bigquery_storage_read:v1’)
 &gt;&gt;&gt; provider.BigqueryStorageRead</p>
 <p>To know more about the usage of a given transform, take a look at the
 <cite>description</cite> attribute. This returns some documentation IF the underlying
 SchemaTransform provides any.
 &gt;&gt;&gt; provider.BigqueryStorageRead.description</p>
 <p>Similarly, the <cite>configuration_schema</cite> attribute returns information about the
 parameters, including their names, types, and any documentation that the
 underlying SchemaTransform may provide:
 &gt;&gt;&gt; provider.BigqueryStorageRead.configuration_schema
 {‘query’: ParamInfo(type=typing.Optional[str], description=’The SQL query to
 be executed to read from the BigQuery table.’, original_name=’query’),
 ‘row_restriction’: ParamInfo(type=typing.Optional[str]…}</p>
 <p>The retrieved external transform can be used as a normal PTransform like so:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">Pipeline</span><span class="p">()</span> <span class="k">as</span> <span class="n">p</span><span class="p">:</span>
   <span class="n">_</span> <span class="o">=</span> <span class="p">(</span><span class="n">p</span>
     <span class="o">|</span> <span class="s1">&#39;Read from BigQuery` &gt;&gt; provider.BigqueryStorageRead(</span>
             <span class="n">query</span><span class="o">=</span><span class="n">query</span><span class="p">,</span>
             <span class="n">row_restriction</span><span class="o">=</span><span class="n">restriction</span><span class="p">)</span>
     <span class="o">|</span> <span class="s1">&#39;Some processing&#39;</span> <span class="o">&gt;&gt;</span> <span class="n">beam</span><span class="o">.</span><span class="n">Map</span><span class="p">(</span><span class="o">...</span><span class="p">))</span>
 </pre></div>
 </div>
 <p>Experimental; no backwards compatibility guarantees.</p>
 <dl class="method">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get_available">
 <code class="descname">get_available</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; List[Tuple[str, str]]<a class="reference internal" href="_modules/apache_beam/transforms/external_transform_provider.html#ExternalTransformProvider.get_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get_available" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get a list of available ExternalTransform names and identifiers</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get_all">
 <code class="descname">get_all</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; Dict[str, apache_beam.transforms.external_transform_provider.ExternalTransform]<a class="reference internal" href="_modules/apache_beam/transforms/external_transform_provider.html#ExternalTransformProvider.get_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get_all" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get all ExternalTransform</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get">
 <code class="descname">get</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span> &#x2192; apache_beam.transforms.external_transform_provider.ExternalTransform<a class="reference internal" href="_modules/apache_beam/transforms/external_transform_provider.html#ExternalTransformProvider.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get an ExternalTransform by its inferred class name</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get_urn">
 <code class="descname">get_urn</code><span class="sig-paren">(</span><em>identifier</em><span class="sig-paren">)</span> &#x2192; apache_beam.transforms.external_transform_provider.ExternalTransform<a class="reference internal" href="_modules/apache_beam/transforms/external_transform_provider.html#ExternalTransformProvider.get_urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external_transform_provider.ExternalTransformProvider.get_urn" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get an ExternalTransform by its SchemaTransform identifier</p>
 </dd></dl>

 </dd></dl>

 </div>


            </div>

           </div>
           <footer>

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

         <a href="apache_beam.transforms.fully_qualified_named_transform.html" class="btn btn-neutral float-right" title="apache_beam.transforms.fully_qualified_named_transform module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="apache_beam.transforms.external_java.html" class="btn btn-neutral float-left" title="apache_beam.transforms.external_java 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>