blob: f8ea4a92b87c36942f59f6c033a05bbe9948a975 [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 package &mdash; Apache Beam 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 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.aws package" href="apache_beam.io.aws.html" />
<link rel="prev" title="apache_beam.internal.util module" href="apache_beam.internal.util.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" />
<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.internal.html">apache_beam.internal package</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">apache_beam.io package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.aws.html">apache_beam.io.aws package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.external.html">apache_beam.io.external package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.flink.html">apache_beam.io.flink package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a><ul>
<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.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.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.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.vcfio.html">apache_beam.io.vcfio 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.tools.html">apache_beam.tools 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>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version 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>apache_beam.io package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.io.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">
<span id="apache-beam-io-package"></span><h1>apache_beam.io package<a class="headerlink" href="#module-apache_beam.io" title="Permalink to this headline"></a></h1>
<p>A package defining several input sources and output sinks.</p>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.aws.html">apache_beam.io.aws package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.aws.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.aws.clients.html">apache_beam.io.aws.clients package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.aws.clients.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="apache_beam.io.aws.clients.s3.html">apache_beam.io.aws.clients.s3 package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="apache_beam.io.aws.clients.s3.html#submodules">Submodules</a><ul>
<li class="toctree-l7"><a class="reference internal" href="apache_beam.io.aws.clients.s3.boto3_client.html">apache_beam.io.aws.clients.s3.boto3_client module</a></li>
<li class="toctree-l7"><a class="reference internal" href="apache_beam.io.aws.clients.s3.fake_client.html">apache_beam.io.aws.clients.s3.fake_client module</a></li>
<li class="toctree-l7"><a class="reference internal" href="apache_beam.io.aws.clients.s3.messages.html">apache_beam.io.aws.clients.s3.messages module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.aws.html#submodules">Submodules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.aws.s3filesystem.html">apache_beam.io.aws.s3filesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.aws.s3io.html">apache_beam.io.aws.s3io module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.external.html">apache_beam.io.external package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.external.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.external.gcp.html">apache_beam.io.external.gcp package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.external.gcp.html#submodules">Submodules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="apache_beam.io.external.gcp.pubsub.html">apache_beam.io.external.gcp.pubsub module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.external.html#submodules">Submodules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.external.generate_sequence.html">apache_beam.io.external.generate_sequence module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.external.kafka.html">apache_beam.io.external.kafka module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.flink.html">apache_beam.io.flink package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.flink.html#submodules">Submodules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.flink.flink_streaming_impulse_source.html">apache_beam.io.flink.flink_streaming_impulse_source module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.gcp.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.datastore.html">apache_beam.io.gcp.datastore package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.gcp.datastore.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="apache_beam.io.gcp.datastore.v1new.html">apache_beam.io.gcp.datastore.v1new package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="apache_beam.io.gcp.datastore.v1new.html#submodules">Submodules</a><ul>
<li class="toctree-l7"><a class="reference internal" href="apache_beam.io.gcp.datastore.v1new.datastore_write_it_pipeline.html">apache_beam.io.gcp.datastore.v1new.datastore_write_it_pipeline module</a></li>
<li class="toctree-l7"><a class="reference internal" href="apache_beam.io.gcp.datastore.v1new.datastoreio.html">apache_beam.io.gcp.datastore.v1new.datastoreio module</a></li>
<li class="toctree-l7"><a class="reference internal" href="apache_beam.io.gcp.datastore.v1new.helper.html">apache_beam.io.gcp.datastore.v1new.helper module</a></li>
<li class="toctree-l7"><a class="reference internal" href="apache_beam.io.gcp.datastore.v1new.query_splitter.html">apache_beam.io.gcp.datastore.v1new.query_splitter module</a></li>
<li class="toctree-l7"><a class="reference internal" href="apache_beam.io.gcp.datastore.v1new.types.html">apache_beam.io.gcp.datastore.v1new.types module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.experimental.html">apache_beam.io.gcp.experimental package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.gcp.experimental.html#submodules">Submodules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="apache_beam.io.gcp.experimental.spannerio.html">apache_beam.io.gcp.experimental.spannerio module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.gcp.html#submodules">Submodules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.big_query_query_to_table_pipeline.html">apache_beam.io.gcp.big_query_query_to_table_pipeline module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.bigquery.html">apache_beam.io.gcp.bigquery module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.gcp.bigquery.html#writing-data-to-bigquery">Writing Data to BigQuery</a><ul>
<li class="toctree-l5"><a class="reference internal" href="apache_beam.io.gcp.bigquery.html#table-references">Table References</a></li>
<li class="toctree-l5"><a class="reference internal" href="apache_beam.io.gcp.bigquery.html#schemas">Schemas</a></li>
<li class="toctree-l5"><a class="reference internal" href="apache_beam.io.gcp.bigquery.html#additional-parameters-for-bigquery-tables">Additional Parameters for BigQuery Tables</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.bigquery_file_loads.html">apache_beam.io.gcp.bigquery_file_loads module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.bigquery_io_read_pipeline.html">apache_beam.io.gcp.bigquery_io_read_pipeline module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.bigquery_tools.html">apache_beam.io.gcp.bigquery_tools module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.bigtableio.html">apache_beam.io.gcp.bigtableio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.gcsfilesystem.html">apache_beam.io.gcp.gcsfilesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.gcsio.html">apache_beam.io.gcp.gcsio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.gcsio_overrides.html">apache_beam.io.gcp.gcsio_overrides module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.pubsub.html">apache_beam.io.gcp.pubsub module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.pubsub_it_pipeline.html">apache_beam.io.gcp.pubsub_it_pipeline module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.avroio.html">apache_beam.io.avroio module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.concat_source.html">apache_beam.io.concat_source module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.filebasedsink.html">apache_beam.io.filebasedsink module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.filebasedsource.html">apache_beam.io.filebasedsource module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.fileio.html">apache_beam.io.fileio module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.fileio.html#writing-to-files">Writing to Files</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.fileio.html#file-naming">File Naming</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.fileio.html#dynamic-destinations">Dynamic Destinations</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.filesystem.html">apache_beam.io.filesystem module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.filesystemio.html">apache_beam.io.filesystemio module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.filesystems.html">apache_beam.io.filesystems module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.hadoopfilesystem.html">apache_beam.io.hadoopfilesystem module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.iobase.html">apache_beam.io.iobase module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.localfilesystem.html">apache_beam.io.localfilesystem module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.mongodbio.html">apache_beam.io.mongodbio module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.mongodbio.html#read-from-mongodb">Read from MongoDB</a></li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.mongodbio.html#write-to-mongodb">Write to MongoDB:</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.parquetio.html">apache_beam.io.parquetio module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.range_trackers.html">apache_beam.io.range_trackers module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.restriction_trackers.html">apache_beam.io.restriction_trackers module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.source_test_utils.html">apache_beam.io.source_test_utils module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.textio.html">apache_beam.io.textio module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.tfrecordio.html">apache_beam.io.tfrecordio module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.utils.html">apache_beam.io.utils module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.vcfio.html">apache_beam.io.vcfio module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.watermark_estimators.html">apache_beam.io.watermark_estimators module</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.io.aws.html" class="btn btn-neutral float-right" title="apache_beam.io.aws package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.internal.util.html" class="btn btn-neutral float-left" title="apache_beam.internal.util 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>