| |
| |
| <!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.io.avroio module — Apache Beam 2.67.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=959b4fbe"></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.io.concat_source module" href="apache_beam.io.concat_source.html" /> |
| <link rel="prev" title="apache_beam.io.gcp.spanner_wrapper module" href="apache_beam.io.gcp.spanner_wrapper.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 current"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.io.avroio module</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.io.avroio.ReadFromAvro"><code class="docutils literal notranslate"><span class="pre">ReadFromAvro</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.io.avroio.ReadAllFromAvro"><code class="docutils literal notranslate"><span class="pre">ReadAllFromAvro</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.io.avroio.ReadAllFromAvroContinuously"><code class="docutils literal notranslate"><span class="pre">ReadAllFromAvroContinuously</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.io.avroio.WriteToAvro"><code class="docutils literal notranslate"><span class="pre">WriteToAvro</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.concat_source.html">apache_beam.io.concat_source module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.debezium.html">apache_beam.io.debezium module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsink.html">apache_beam.io.filebasedsink module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsource.html">apache_beam.io.filebasedsource module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.fileio.html">apache_beam.io.fileio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystem.html">apache_beam.io.filesystem module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystemio.html">apache_beam.io.filesystemio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystems.html">apache_beam.io.filesystems module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.hadoopfilesystem.html">apache_beam.io.hadoopfilesystem module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.iobase.html">apache_beam.io.iobase module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.jdbc.html">apache_beam.io.jdbc module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kafka.html">apache_beam.io.kafka module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kinesis.html">apache_beam.io.kinesis module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.localfilesystem.html">apache_beam.io.localfilesystem module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.mongodbio.html">apache_beam.io.mongodbio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.parquetio.html">apache_beam.io.parquetio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.range_trackers.html">apache_beam.io.range_trackers module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.requestresponse.html">apache_beam.io.requestresponse module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.restriction_trackers.html">apache_beam.io.restriction_trackers module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.snowflake.html">apache_beam.io.snowflake module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.source_test_utils.html">apache_beam.io.source_test_utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.textio.html">apache_beam.io.textio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.tfrecordio.html">apache_beam.io.tfrecordio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.utils.html">apache_beam.io.utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.watermark_estimators.html">apache_beam.io.watermark_estimators module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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="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.io.html">apache_beam.io package</a></li> |
| <li class="breadcrumb-item active">apache_beam.io.avroio module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.io.avroio.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.io.avroio"> |
| <span id="apache-beam-io-avroio-module"></span><h1>apache_beam.io.avroio module<a class="headerlink" href="#module-apache_beam.io.avroio" title="Link to this heading"></a></h1> |
| <p><code class="docutils literal notranslate"><span class="pre">PTransforms</span></code> for reading from and writing to Avro files.</p> |
| <p>Provides two read <code class="docutils literal notranslate"><span class="pre">PTransform``s,</span> <span class="pre">``ReadFromAvro</span></code> and <code class="docutils literal notranslate"><span class="pre">ReadAllFromAvro</span></code>, |
| that produces a <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of records. |
| Each record of this <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> will contain a single record read from |
| an Avro file. Records that are of simple types will be mapped into |
| corresponding Python types. Records that are of Avro type ‘RECORD’ will be |
| mapped to Python dictionaries that comply with the schema contained in the |
| Avro file that contains those records. In this case, keys of each dictionary |
| will contain the corresponding field names and will be of type <code class="docutils literal notranslate"><span class="pre">string</span></code> |
| while the values of the dictionary will be of the type defined in the |
| corresponding Avro schema.</p> |
| <p>For example, if schema of the Avro file is the following. |
| {“namespace”: “example.avro”,”type”: “record”,”name”: “User”,”fields”: |
| [{“name”: “name”, “type”: “string”}, |
| {“name”: “favorite_number”, “type”: [“int”, “null”]}, |
| {“name”: “favorite_color”, “type”: [“string”, “null”]}]}</p> |
| <p>Then records generated by read transforms will be dictionaries of the |
| following form. |
| {‘name’: ‘Alyssa’, ‘favorite_number’: 256, ‘favorite_color’: None}).</p> |
| <p>Additionally, this module provides a write <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> <code class="docutils literal notranslate"><span class="pre">WriteToAvro</span></code> |
| that can be used to write a given <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of Python objects to an |
| Avro file.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.ReadFromAvro"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.avroio.</span></span><span class="sig-name descname"><span class="pre">ReadFromAvro</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_pattern</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_bundle_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_fastavro</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_rows</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/avroio.html#ReadFromAvro"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.avroio.ReadFromAvro" title="Link 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">PTransform</span></code></a></p> |
| <p>A <cite>PTransform</cite> for reading records from avro files.</p> |
| <p>Each record of the resulting PCollection will contain |
| a single record read from a source. Records that are of simple types will be |
| mapped to beam Rows with a single <cite>record</cite> field containing the records |
| value. Records that are of Avro type <code class="docutils literal notranslate"><span class="pre">RECORD</span></code> will be mapped to Beam rows |
| that comply with the schema contained in the Avro file that contains those |
| records.</p> |
| <p>Initializes <a class="reference internal" href="#apache_beam.io.avroio.ReadFromAvro" title="apache_beam.io.avroio.ReadFromAvro"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReadFromAvro</span></code></a>.</p> |
| <p>Uses source <code class="xref py py-class docutils literal notranslate"><span class="pre">_AvroSource</span></code> to read a set of Avro |
| files defined by a given file pattern.</p> |
| <p>If <code class="docutils literal notranslate"><span class="pre">/mypath/myavrofiles*</span></code> is a file-pattern that points to a set of Avro |
| files, a <a class="reference internal" href="apache_beam.pvalue.html#apache_beam.pvalue.PCollection" title="apache_beam.pvalue.PCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">PCollection</span></code></a> for the records in |
| these Avro files can be created in the following manner.</p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">beam</span><span class="o">.</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">records</span> <span class="o">=</span> <span class="n">p</span> <span class="o">|</span> <span class="s1">'Read'</span> <span class="o">>></span> <span class="n">beam</span><span class="o">.</span><span class="n">io</span><span class="o">.</span><span class="n">ReadFromAvro</span><span class="p">(</span><span class="s1">'/mypath/myavrofiles*'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Each record of this <a class="reference internal" href="apache_beam.pvalue.html#apache_beam.pvalue.PCollection" title="apache_beam.pvalue.PCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">PCollection</span></code></a> will contain |
| a single record read from a source. Records that are of simple types will be |
| mapped into corresponding Python types. Records that are of Avro type |
| <code class="docutils literal notranslate"><span class="pre">RECORD</span></code> will be mapped to Python dictionaries that comply with the schema |
| contained in the Avro file that contains those records. In this case, keys |
| of each dictionary will contain the corresponding field names and will be of |
| type <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> while the values of the dictionary will be of the type |
| defined in the corresponding Avro schema.</p> |
| <p>For example, if schema of the Avro file is the following.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"namespace"</span><span class="p">:</span> <span class="s2">"example.avro"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"record"</span><span class="p">,</span> |
| <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"User"</span><span class="p">,</span> |
| <span class="s2">"fields"</span><span class="p">:</span> <span class="p">[</span> |
| |
| <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"name"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">},</span> |
| |
| <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"favorite_number"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"int"</span><span class="p">,</span> <span class="s2">"null"</span><span class="p">]},</span> |
| |
| <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"favorite_color"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"string"</span><span class="p">,</span> <span class="s2">"null"</span><span class="p">]}</span> |
| |
| <span class="p">]</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p>Then records generated by <code class="xref py py-class docutils literal notranslate"><span class="pre">_AvroSource</span></code> will be |
| dictionaries of the following form.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Alyssa'</span><span class="p">,</span> <span class="s1">'favorite_number'</span><span class="p">:</span> <span class="mi">256</span><span class="p">,</span> <span class="s1">'favorite_color'</span><span class="p">:</span> <span class="kc">None</span><span class="p">})</span><span class="o">.</span> |
| </pre></div> |
| </div> |
| <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>file_pattern</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – the file glob to read</p></li> |
| <li><p><strong>min_bundle_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – the minimum size in bytes, to be considered when |
| splitting the input into bundles.</p></li> |
| <li><p><strong>validate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – flag to verify that the files exist during the pipeline |
| creation time.</p></li> |
| <li><p><strong>use_fastavro</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – This flag is left for API backwards compatibility |
| and no longer has an effect. Do not use.</p></li> |
| <li><p><strong>as_rows</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Whether to return a schema’d PCollection of Beam rows.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.ReadFromAvro.expand"> |
| <span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pvalue</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/avroio.html#ReadFromAvro.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.avroio.ReadFromAvro.expand" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.ReadFromAvro.display_data"> |
| <span class="sig-name descname"><span class="pre">display_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/avroio.html#ReadFromAvro.display_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.avroio.ReadFromAvro.display_data" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.ReadAllFromAvro"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.avroio.</span></span><span class="sig-name descname"><span class="pre">ReadAllFromAvro</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_bundle_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">desired_bundle_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">67108864</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_fastavro</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_filename</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ReadAllFiles'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/avroio.html#ReadAllFromAvro"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.avroio.ReadAllFromAvro" title="Link 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">PTransform</span></code></a></p> |
| <p>A <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> for reading <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of Avro files.</p> |
| <p>Uses source ‘_AvroSource’ to read a <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of Avro files or file |
| patterns and produce a <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> of Avro records.</p> |
| <p>This implementation is only tested with batch pipeline. In streaming, |
| reading may happen with delay due to the limitation in ReShuffle involved.</p> |
| <p>Initializes <code class="docutils literal notranslate"><span class="pre">ReadAllFromAvro</span></code>.</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>min_bundle_size</strong> – the minimum size in bytes, to be considered when |
| splitting the input into bundles.</p></li> |
| <li><p><strong>desired_bundle_size</strong> – the desired size in bytes, to be considered when |
| splitting the input into bundles.</p></li> |
| <li><p><strong>use_fastavro</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – This flag is left for API backwards compatibility |
| and no longer has an effect. Do not use.</p></li> |
| <li><p><strong>with_filename</strong> – If True, returns a Key Value with the key being the file |
| name and the value being the actual data. If False, it only returns |
| the data.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.ReadAllFromAvro.DEFAULT_DESIRED_BUNDLE_SIZE"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_DESIRED_BUNDLE_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">67108864</span></em><a class="headerlink" href="#apache_beam.io.avroio.ReadAllFromAvro.DEFAULT_DESIRED_BUNDLE_SIZE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.ReadAllFromAvro.expand"> |
| <span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pvalue</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/avroio.html#ReadAllFromAvro.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.avroio.ReadAllFromAvro.expand" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.ReadAllFromAvroContinuously"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.avroio.</span></span><span class="sig-name descname"><span class="pre">ReadAllFromAvroContinuously</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_pattern</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ReadAllFilesContinuously'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/avroio.html#ReadAllFromAvroContinuously"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.avroio.ReadAllFromAvroContinuously" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.io.avroio.ReadAllFromAvro" title="apache_beam.io.avroio.ReadAllFromAvro"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReadAllFromAvro</span></code></a></p> |
| <p>A <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> for reading avro files in given file patterns. |
| This PTransform acts as a Source and produces continuously a <code class="docutils literal notranslate"><span class="pre">PCollection</span></code> |
| of Avro records.</p> |
| <p>For more details, see <code class="docutils literal notranslate"><span class="pre">ReadAllFromAvro</span></code> for avro parsing settings; |
| see <code class="docutils literal notranslate"><span class="pre">apache_beam.io.fileio.MatchContinuously</span></code> for watching settings.</p> |
| <p>ReadAllFromAvroContinuously is experimental. No backwards-compatibility |
| guarantees. Due to the limitation on Reshuffle, current implementation does |
| not scale.</p> |
| <p>Initialize the <code class="docutils literal notranslate"><span class="pre">ReadAllFromAvroContinuously</span></code> transform.</p> |
| <p>Accepts args for constructor args of both <a class="reference internal" href="#apache_beam.io.avroio.ReadAllFromAvro" title="apache_beam.io.avroio.ReadAllFromAvro"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReadAllFromAvro</span></code></a> and |
| <a class="reference internal" href="apache_beam.io.fileio.html#apache_beam.io.fileio.MatchContinuously" title="apache_beam.io.fileio.MatchContinuously"><code class="xref py py-class docutils literal notranslate"><span class="pre">MatchContinuously</span></code></a>.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.ReadAllFromAvroContinuously.expand"> |
| <span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pbegin</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/avroio.html#ReadAllFromAvroContinuously.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.avroio.ReadAllFromAvroContinuously.expand" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.WriteToAvro"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.avroio.</span></span><span class="sig-name descname"><span class="pre">WriteToAvro</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path_prefix</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">codec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'deflate'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name_suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_shards</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shard_name_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mime_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'application/x-avro'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_fastavro</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/avroio.html#WriteToAvro"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.avroio.WriteToAvro" title="Link 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">PTransform</span></code></a></p> |
| <p>A <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> for writing avro files.</p> |
| <p>If the input has a schema, a corresponding avro schema will be automatically |
| generated and used to write the output records.</p> |
| <p>Initialize a WriteToAvro transform.</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>file_path_prefix</strong> – The file path to write to. The files written will begin |
| with this prefix, followed by a shard identifier (see num_shards), and |
| end in a common extension, if given by file_name_suffix. In most cases, |
| only this argument is specified and num_shards, shard_name_template, and |
| file_name_suffix use default values.</p></li> |
| <li><p><strong>schema</strong> – The schema to use (dict).</p></li> |
| <li><p><strong>codec</strong> – The codec to use for block-level compression. Any string supported |
| by the Avro specification is accepted (for example ‘null’).</p></li> |
| <li><p><strong>file_name_suffix</strong> – Suffix for the files written.</p></li> |
| <li><p><strong>num_shards</strong> – The number of files (shards) used for output. If not set, the |
| service will decide on the optimal number of shards. |
| Constraining the number of shards is likely to reduce |
| the performance of a pipeline. Setting this value is not recommended |
| unless you require a specific number of output files.</p></li> |
| <li><p><strong>shard_name_template</strong> – A template string containing placeholders for |
| the shard number and shard count. When constructing a filename for a |
| particular shard number, the upper-case letters ‘S’ and ‘N’ are |
| replaced with the 0-padded shard number and shard count respectively. |
| This argument can be ‘’ in which case it behaves as if num_shards was |
| set to 1 and only one file will be generated. The default pattern used |
| is ‘-SSSSS-of-NNNNN’ if None is passed as the shard_name_template.</p></li> |
| <li><p><strong>mime_type</strong> – The MIME type to use for the produced files, if the filesystem |
| supports specifying MIME types.</p></li> |
| <li><p><strong>use_fastavro</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – This flag is left for API backwards compatibility |
| and no longer has an effect. Do not use.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A WriteToAvro transform usable for writing.</p> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.WriteToAvro.expand"> |
| <span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pcoll</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/avroio.html#WriteToAvro.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.avroio.WriteToAvro.expand" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.io.avroio.WriteToAvro.display_data"> |
| <span class="sig-name descname"><span class="pre">display_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/avroio.html#WriteToAvro.display_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.avroio.WriteToAvro.display_data" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.io.gcp.spanner_wrapper.html" class="btn btn-neutral float-left" title="apache_beam.io.gcp.spanner_wrapper module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.io.concat_source.html" class="btn btn-neutral float-right" title="apache_beam.io.concat_source 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> |
