blob: f3f0f984a3e23dfaf140aafd50c351f7bd4bde39 [file] [log] [blame]
<!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.io.filebasedsink module &mdash; Apache Beam 2.36.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.io.filebasedsource module" href="apache_beam.io.filebasedsource.html" />
<link rel="prev" title="apache_beam.io.debezium module" href="apache_beam.io.debezium.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 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"><a class="reference internal" href="apache_beam.io.avroio.html">apache_beam.io.avroio module</a></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 current"><a class="current reference internal" href="#">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.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.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="apache_beam.io.html">apache_beam.io package</a> &raquo;</li>
<li>apache_beam.io.filebasedsink module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.io.filebasedsink.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.io.filebasedsink">
<span id="apache-beam-io-filebasedsink-module"></span><h1>apache_beam.io.filebasedsink module<a class="headerlink" href="#module-apache_beam.io.filebasedsink" title="Permalink to this headline"></a></h1>
<p>File-based sink.</p>
<dl class="class">
<dt id="apache_beam.io.filebasedsink.FileBasedSink">
<em class="property">class </em><code class="descclassname">apache_beam.io.filebasedsink.</code><code class="descname">FileBasedSink</code><span class="sig-paren">(</span><em>file_path_prefix</em>, <em>coder</em>, <em>file_name_suffix=''</em>, <em>num_shards=0</em>, <em>shard_name_template=None</em>, <em>mime_type='application/octet-stream'</em>, <em>compression_type='auto'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/filebasedsink.html#FileBasedSink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.filebasedsink.FileBasedSink" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.Sink" title="apache_beam.io.iobase.Sink"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.iobase.Sink</span></code></a></p>
<p>A sink to a GCS or local files.</p>
<p>To implement a file-based sink, extend this class and override
either <a class="reference internal" href="#apache_beam.io.filebasedsink.FileBasedSink.write_record" title="apache_beam.io.filebasedsink.FileBasedSink.write_record"><code class="xref py py-meth docutils literal notranslate"><span class="pre">write_record()</span></code></a> or <a class="reference internal" href="#apache_beam.io.filebasedsink.FileBasedSink.write_encoded_record" title="apache_beam.io.filebasedsink.FileBasedSink.write_encoded_record"><code class="xref py py-meth docutils literal notranslate"><span class="pre">write_encoded_record()</span></code></a>.</p>
<p>If needed, also overwrite <a class="reference internal" href="#apache_beam.io.filebasedsink.FileBasedSink.open" title="apache_beam.io.filebasedsink.FileBasedSink.open"><code class="xref py py-meth docutils literal notranslate"><span class="pre">open()</span></code></a> and/or <a class="reference internal" href="#apache_beam.io.filebasedsink.FileBasedSink.close" title="apache_beam.io.filebasedsink.FileBasedSink.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> to customize
the file handling or write headers and footers.</p>
<p>The output of this write is 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> of
all written shards.</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">Raises:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.10)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> – if file path parameters are not a <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> or
<a class="reference internal" href="apache_beam.options.value_provider.html#apache_beam.options.value_provider.ValueProvider" title="apache_beam.options.value_provider.ValueProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueProvider</span></code></a>, or if
<strong>compression_type</strong> is not member of
<a class="reference internal" href="apache_beam.io.filesystem.html#apache_beam.io.filesystem.CompressionTypes" title="apache_beam.io.filesystem.CompressionTypes"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompressionTypes</span></code></a>.</li>
<li><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.10)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> – if <strong>shard_name_template</strong> is not of expected
format.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="apache_beam.io.filebasedsink.FileBasedSink.display_data">
<code class="descname">display_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/filebasedsink.html#FileBasedSink.display_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.filebasedsink.FileBasedSink.display_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.io.filebasedsink.FileBasedSink.open">
<code class="descname">open</code><span class="sig-paren">(</span><em>temp_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/filebasedsink.html#FileBasedSink.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.filebasedsink.FileBasedSink.open" title="Permalink to this definition"></a></dt>
<dd><p>Opens <code class="docutils literal notranslate"><span class="pre">temp_path</span></code>, returning an opaque file handle object.</p>
<p>The returned file handle is passed to <code class="docutils literal notranslate"><span class="pre">write_[encoded_]record</span></code> and
<code class="docutils literal notranslate"><span class="pre">close</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.filebasedsink.FileBasedSink.write_record">
<code class="descname">write_record</code><span class="sig-paren">(</span><em>file_handle</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/filebasedsink.html#FileBasedSink.write_record"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.filebasedsink.FileBasedSink.write_record" title="Permalink to this definition"></a></dt>
<dd><p>Writes a single record go the file handle returned by <code class="docutils literal notranslate"><span class="pre">open()</span></code>.</p>
<p>By default, calls <code class="docutils literal notranslate"><span class="pre">write_encoded_record</span></code> after encoding the record with
this sink’s Coder.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.filebasedsink.FileBasedSink.write_encoded_record">
<code class="descname">write_encoded_record</code><span class="sig-paren">(</span><em>file_handle</em>, <em>encoded_value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/filebasedsink.html#FileBasedSink.write_encoded_record"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.filebasedsink.FileBasedSink.write_encoded_record" title="Permalink to this definition"></a></dt>
<dd><p>Writes a single encoded record to the file handle returned by <code class="docutils literal notranslate"><span class="pre">open()</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.filebasedsink.FileBasedSink.close">
<code class="descname">close</code><span class="sig-paren">(</span><em>file_handle</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/filebasedsink.html#FileBasedSink.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.filebasedsink.FileBasedSink.close" title="Permalink to this definition"></a></dt>
<dd><p>Finalize and close the file handle returned from <code class="docutils literal notranslate"><span class="pre">open()</span></code>.</p>
<p>Called after all records are written.</p>
<p>By default, calls <code class="docutils literal notranslate"><span class="pre">file_handle.close()</span></code> iff it is not None.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.filebasedsink.FileBasedSink.initialize_write">
<code class="descname">initialize_write</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/filebasedsink.html#FileBasedSink.initialize_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.filebasedsink.FileBasedSink.initialize_write" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.io.filebasedsink.FileBasedSink.open_writer">
<code class="descname">open_writer</code><span class="sig-paren">(</span><em>init_result</em>, <em>uid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/filebasedsink.html#FileBasedSink.open_writer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.filebasedsink.FileBasedSink.open_writer" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.io.filebasedsink.FileBasedSink.pre_finalize">
<code class="descname">pre_finalize</code><span class="sig-paren">(</span><em>init_result</em>, <em>writer_results</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/filebasedsink.html#FileBasedSink.pre_finalize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.filebasedsink.FileBasedSink.pre_finalize" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.io.filebasedsink.FileBasedSink.finalize_write">
<code class="descname">finalize_write</code><span class="sig-paren">(</span><em>init_result</em>, <em>writer_results</em>, <em>unused_pre_finalize_results</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/filebasedsink.html#FileBasedSink.finalize_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.filebasedsink.FileBasedSink.finalize_write" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.io.filebasedsource.html" class="btn btn-neutral float-right" title="apache_beam.io.filebasedsource module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.io.debezium.html" class="btn btn-neutral float-left" title="apache_beam.io.debezium 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>