| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.yaml.yaml_enrichment module — Apache Beam 2.68.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=2388e03a"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.yaml.yaml_errors module" href="apache_beam.yaml.yaml_errors.html" /> |
| <link rel="prev" title="apache_beam.yaml.yaml_combine module" href="apache_beam.yaml.yaml_combine.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> |
| Apache Beam |
| </a> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu"> |
| <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"><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 current"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.yaml.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.yaml.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.cache_provider_artifacts.html">apache_beam.yaml.cache_provider_artifacts module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.conftest.html">apache_beam.yaml.conftest module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.generate_yaml_docs.html">apache_beam.yaml.generate_yaml_docs module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.json_utils.html">apache_beam.yaml.json_utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.main.html">apache_beam.yaml.main module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.options.html">apache_beam.yaml.options module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_combine.html">apache_beam.yaml.yaml_combine module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.yaml.yaml_enrichment module</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.yaml_enrichment.enrichment_transform"><code class="docutils literal notranslate"><span class="pre">enrichment_transform()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_errors.html">apache_beam.yaml.yaml_errors module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_io.html">apache_beam.yaml.yaml_io module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_join.html">apache_beam.yaml.yaml_join module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_mapping.html">apache_beam.yaml.yaml_mapping module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_ml.html">apache_beam.yaml.yaml_ml module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_provider.html">apache_beam.yaml.yaml_provider module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_specifiable.html">apache_beam.yaml.yaml_specifiable module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_testing.html">apache_beam.yaml.yaml_testing module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_transform.html">apache_beam.yaml.yaml_transform module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_utils.html">apache_beam.yaml.yaml_utils module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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="Mobile navigation menu" > |
| <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="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.yaml.html">apache_beam.yaml package</a></li> |
| <li class="breadcrumb-item active">apache_beam.yaml.yaml_enrichment module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.yaml.yaml_enrichment.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"> |
| |
| <section id="module-apache_beam.yaml.yaml_enrichment"> |
| <span id="apache-beam-yaml-yaml-enrichment-module"></span><h1>apache_beam.yaml.yaml_enrichment module<a class="headerlink" href="#module-apache_beam.yaml.yaml_enrichment" title="Link to this heading"></a></h1> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.yaml.yaml_enrichment.enrichment_transform"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.yaml_enrichment.</span></span><span class="sig-name descname"><span class="pre">enrichment_transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enrichment_handler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">30</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_enrichment.html#enrichment_transform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.yaml_enrichment.enrichment_transform" title="Link to this definition"></a></dt> |
| <dd><p>The Enrichment transform allows one to dynamically enhance elements in a |
| pipeline by performing key-value lookups against external services like |
| APIs or databases.</p> |
| <p>Example using BigTable:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span> <span class="nb">type</span><span class="p">:</span> <span class="n">Enrichment</span> |
| <span class="n">config</span><span class="p">:</span> |
| <span class="n">enrichment_handler</span><span class="p">:</span> <span class="s1">'BigTable'</span> |
| <span class="n">handler_config</span><span class="p">:</span> |
| <span class="n">project_id</span><span class="p">:</span> <span class="s1">'apache-beam-testing'</span> |
| <span class="n">instance_id</span><span class="p">:</span> <span class="s1">'beam-test'</span> |
| <span class="n">table_id</span><span class="p">:</span> <span class="s1">'bigtable-enrichment-test'</span> |
| <span class="n">row_key</span><span class="p">:</span> <span class="s1">'product_id'</span> |
| <span class="n">timeout</span><span class="p">:</span> <span class="mi">30</span> |
| </pre></div> |
| </div> |
| <p>For more information on Enrichment, see the [Beam docs]( |
| <a class="reference external" href="https://beam.apache.org/documentation/transforms/python/elementwise/enrichment/">https://beam.apache.org/documentation/transforms/python/elementwise/enrichment/</a>).</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>enrichment_handler</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Specifies the source from where data needs |
| to be extracted into the pipeline for enriching data. One of |
| “BigQuery”, “BigTable”, “FeastFeatureStore” or “VertexAIFeatureStore”.</p></li> |
| <li><p><strong>handler_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – <p>Specifies the parameters for the respective |
| enrichment_handler in a YAML/JSON format. To see the full set of |
| handler_config parameters, see their corresponding doc pages:</p> |
| <blockquote> |
| <div><ul> |
| <li><p>[BigQueryEnrichmentHandler](<a class="reference external" href="https://beam.apache.org/releases/pydoc/current/apache_beam.transforms.enrichment_handlers.bigquery.html#apache_beam.transforms.enrichment_handlers.bigquery.BigQueryEnrichmentHandler">https://beam.apache.org/releases/pydoc/current/apache_beam.transforms.enrichment_handlers.bigquery.html#apache_beam.transforms.enrichment_handlers.bigquery.BigQueryEnrichmentHandler</a>)</p></li> |
| <li><p>[BigTableEnrichmentHandler](<a class="reference external" href="https://beam.apache.org/releases/pydoc/current/apache_beam.transforms.enrichment_handlers.bigtable.html#apache_beam.transforms.enrichment_handlers.bigtable.BigTableEnrichmentHandler">https://beam.apache.org/releases/pydoc/current/apache_beam.transforms.enrichment_handlers.bigtable.html#apache_beam.transforms.enrichment_handlers.bigtable.BigTableEnrichmentHandler</a>)</p></li> |
| <li><p>[FeastFeatureStoreEnrichmentHandler](<a class="reference external" href="https://beam.apache.org/releases/pydoc/current/apache_beam.transforms.enrichment_handlers.feast_feature_store.html#apache_beam.transforms.enrichment_handlers.feast_feature_store.FeastFeatureStoreEnrichmentHandler">https://beam.apache.org/releases/pydoc/current/apache_beam.transforms.enrichment_handlers.feast_feature_store.html#apache_beam.transforms.enrichment_handlers.feast_feature_store.FeastFeatureStoreEnrichmentHandler</a>)</p></li> |
| <li><p>[VertexAIFeatureStoreEnrichmentHandler](<a class="reference external" href="https://beam.apache.org/releases/pydoc/current/apache_beam.transforms.enrichment_handlers.vertex_ai_feature_store.html#apache_beam.transforms.enrichment_handlers.vertex_ai_feature_store.VertexAIFeatureStoreEnrichmentHandler">https://beam.apache.org/releases/pydoc/current/apache_beam.transforms.enrichment_handlers.vertex_ai_feature_store.html#apache_beam.transforms.enrichment_handlers.vertex_ai_feature_store.VertexAIFeatureStoreEnrichmentHandler</a>)</p></li> |
| </ul> |
| </div></blockquote> |
| </p></li> |
| <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – Timeout for source requests in seconds. Defaults to 30 |
| seconds.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.yaml.yaml_combine.html" class="btn btn-neutral float-left" title="apache_beam.yaml.yaml_combine module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.yaml.yaml_errors.html" class="btn btn-neutral float-right" title="apache_beam.yaml.yaml_errors module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
