pydoc/2.68.0/apache_beam.io.gcp.bigtableio.html - beam-site - Git at Google



 <!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.gcp.bigtableio module &mdash; 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.io.gcp.dicomclient module" href="apache_beam.io.gcp.dicomclient.html" />
     <link rel="prev" title="apache_beam.io.gcp.bigquery_tools module" href="apache_beam.io.gcp.bigquery_tools.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 current"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a><ul class="current">
 <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.azure.html">apache_beam.io.azure package</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.components.html">apache_beam.io.components 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 current"><a class="reference internal" href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a><ul class="current">
 <li class="toctree-l4"><a class="reference internal" href="apache_beam.io.gcp.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.io.gcp.html#submodules">Submodules</a></li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a></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"><a href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a></li>
       <li class="breadcrumb-item active">apache_beam.io.gcp.bigtableio module</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/apache_beam.io.gcp.bigtableio.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.gcp.bigtableio">
 <span id="apache-beam-io-gcp-bigtableio-module"></span><h1>apache_beam.io.gcp.bigtableio module<a class="headerlink" href="#module-apache_beam.io.gcp.bigtableio" title="Link to this heading"></a></h1>
 <p>BigTable connector</p>
 <p>This module implements writing to BigTable tables.
 The default mode is to set row data to write to BigTable tables.
 The syntax supported is described here:
 <a class="reference external" href="https://cloud.google.com/bigtable/docs/quickstart-cbt">https://cloud.google.com/bigtable/docs/quickstart-cbt</a></p>
 <p>BigTable connector can be used as main outputs. A main output
 (common case) is expected to be massive and will be split into
 manageable chunks and processed in parallel. In the example below
 we created a list of rows then passed to the GeneratedDirectRows
 DoFn to set the Cells and then we call the BigTableWriteFn to insert
 those generated rows in the table.</p>
 <blockquote>
 <div><dl>
 <dt>main_table = (p</dt><dd><div class="line-block">
 <div class="line">beam.Create(self._generate())</div>
 <div class="line">WriteToBigTable(project_id,
 instance_id,
 table_id))</div>
 </div>
 </dd>
 </dl>
 </div></blockquote>
 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.io.gcp.bigtableio.WriteToBigTable">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.gcp.bigtableio.</span></span><span class="sig-name descname"><span class="pre">WriteToBigTable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_cross_language</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">expansion_service</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">flush_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_row_bytes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5242880</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/bigtableio.html#WriteToBigTable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.WriteToBigTable" 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 transform that writes rows to a Bigtable table.</p>
 <p>Takes an input PCollection of <cite>DirectRow</cite> objects containing un-committed
 mutations. For more information about this row object, visit
 <a class="reference external" href="https://cloud.google.com/python/docs/reference/bigtable/latest/row#class-googlecloudbigtablerowdirectrowrowkey-tablenone">https://cloud.google.com/python/docs/reference/bigtable/latest/row#class-googlecloudbigtablerowdirectrowrowkey-tablenone</a></p>
 <p>If flag <cite>use_cross_language</cite> is set to true, this transform will use the
 multi-language transforms framework to inject the Java native write transform
 into the pipeline.</p>
 <p>Initialize an WriteToBigTable 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>table_id</strong> – The ID of the table to write to.</p></li>
 <li><p><strong>instance_id</strong> – The ID of the instance where the table resides.</p></li>
 <li><p><strong>project_id</strong> – The GCP project ID.</p></li>
 <li><p><strong>use_cross_language</strong> – If set to True, will use the Java native transform via cross-language.</p></li>
 <li><p><strong>expansion_service</strong> – The address of the expansion service in the case of using cross-language.
 If no expansion service is provided, will attempt to run the default GCP
 expansion service.</p></li>
 <li><p><strong>flush_count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – (Optional) Max number of rows to flush.
 Default is FLUSH_COUNT (1000 rows).</p></li>
 <li><p><strong>max_row_bytes</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – (Optional) Max number of row mutations size to flush.
 Default is MAX_ROW_BYTES (5 MB).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.gcp.bigtableio.WriteToBigTable.URN">
 <span class="sig-name descname"><span class="pre">URN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'beam:schematransform:org.apache.beam:bigtable_write:v1'</span></em><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.WriteToBigTable.URN" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.io.gcp.bigtableio.WriteToBigTable.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">input</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/bigtableio.html#WriteToBigTable.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.WriteToBigTable.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.gcp.bigtableio.ReadFromBigtable">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.gcp.bigtableio.</span></span><span class="sig-name descname"><span class="pre">ReadFromBigtable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/bigtableio.html#ReadFromBigtable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.ReadFromBigtable" 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>Reads rows from Bigtable.</p>
 <p>Returns a PCollection of PartialRowData objects, each representing a
 Bigtable row. For more information about this row object, visit
 <a class="reference external" href="https://cloud.google.com/python/docs/reference/bigtable/latest/row#class-googlecloudbigtablerowpartialrowdatarowkey">https://cloud.google.com/python/docs/reference/bigtable/latest/row#class-googlecloudbigtablerowpartialrowdatarowkey</a></p>
 <p>Initialize a ReadFromBigtable 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>table_id</strong> – The ID of the table to read from.</p></li>
 <li><p><strong>instance_id</strong> – The ID of the instance where the table resides.</p></li>
 <li><p><strong>project_id</strong> – The GCP project ID.</p></li>
 <li><p><strong>expansion_service</strong> – The address of the expansion service. If no expansion service is
 provided, will attempt to run the default GCP expansion service.</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.gcp.bigtableio.ReadFromBigtable.URN">
 <span class="sig-name descname"><span class="pre">URN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'beam:schematransform:org.apache.beam:bigtable_read:v1'</span></em><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.ReadFromBigtable.URN" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.io.gcp.bigtableio.ReadFromBigtable.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">input</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/bigtableio.html#ReadFromBigtable.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.ReadFromBigtable.expand" 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.bigquery_tools.html" class="btn btn-neutral float-left" title="apache_beam.io.gcp.bigquery_tools module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="apache_beam.io.gcp.dicomclient.html" class="btn btn-neutral float-right" title="apache_beam.io.gcp.dicomclient module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>

   <hr/>

   <div role="contentinfo">
     <p>&#169; 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>


	<!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.gcp.bigtableio 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.io.gcp.dicomclient module" href="apache_beam.io.gcp.dicomclient.html" />
	<link rel="prev" title="apache_beam.io.gcp.bigquery_tools module" href="apache_beam.io.gcp.bigquery_tools.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 current"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a><ul class="current">
	<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.azure.html">apache_beam.io.azure package</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.components.html">apache_beam.io.components 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 current"><a class="reference internal" href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a><ul class="current">
	<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.gcp.html#subpackages">Subpackages</a></li>
	<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.io.gcp.html#submodules">Submodules</a></li>
	</ul>
	</li>
	</ul>
	</li>
	<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a></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"><a href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a></li>
	<li class="breadcrumb-item active">apache_beam.io.gcp.bigtableio module</li>
	<li class="wy-breadcrumbs-aside">
	<a href="_sources/apache_beam.io.gcp.bigtableio.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.gcp.bigtableio">
	<span id="apache-beam-io-gcp-bigtableio-module"></span><h1>apache_beam.io.gcp.bigtableio module<a class="headerlink" href="#module-apache_beam.io.gcp.bigtableio" title="Link to this heading"></a></h1>
	<p>BigTable connector</p>
	<p>This module implements writing to BigTable tables.
	The default mode is to set row data to write to BigTable tables.
	The syntax supported is described here:
	<a class="reference external" href="https://cloud.google.com/bigtable/docs/quickstart-cbt">https://cloud.google.com/bigtable/docs/quickstart-cbt</a></p>
	<p>BigTable connector can be used as main outputs. A main output
	(common case) is expected to be massive and will be split into
	manageable chunks and processed in parallel. In the example below
	we created a list of rows then passed to the GeneratedDirectRows
	DoFn to set the Cells and then we call the BigTableWriteFn to insert
	those generated rows in the table.</p>
	<blockquote>
	<div><dl>
	<dt>main_table = (p</dt><dd><div class="line-block">
	<div class="line">beam.Create(self._generate())</div>
	<div class="line">WriteToBigTable(project_id,
	instance_id,
	table_id))</div>
	</div>
	</dd>
	</dl>
	</div></blockquote>
	<dl class="py class">
	<dt class="sig sig-object py" id="apache_beam.io.gcp.bigtableio.WriteToBigTable">
	<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.gcp.bigtableio.</span></span><span class="sig-name descname"><span class="pre">WriteToBigTable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_cross_language</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">expansion_service</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">flush_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_row_bytes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5242880</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/bigtableio.html#WriteToBigTable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.WriteToBigTable" 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 transform that writes rows to a Bigtable table.</p>
	<p>Takes an input PCollection of <cite>DirectRow</cite> objects containing un-committed
	mutations. For more information about this row object, visit
	<a class="reference external" href="https://cloud.google.com/python/docs/reference/bigtable/latest/row#class-googlecloudbigtablerowdirectrowrowkey-tablenone">https://cloud.google.com/python/docs/reference/bigtable/latest/row#class-googlecloudbigtablerowdirectrowrowkey-tablenone</a></p>
	<p>If flag <cite>use_cross_language</cite> is set to true, this transform will use the
	multi-language transforms framework to inject the Java native write transform
	into the pipeline.</p>
	<p>Initialize an WriteToBigTable 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>table_id</strong> – The ID of the table to write to.</p></li>
	<li><p><strong>instance_id</strong> – The ID of the instance where the table resides.</p></li>
	<li><p><strong>project_id</strong> – The GCP project ID.</p></li>
	<li><p><strong>use_cross_language</strong> – If set to True, will use the Java native transform via cross-language.</p></li>
	<li><p><strong>expansion_service</strong> – The address of the expansion service in the case of using cross-language.
	If no expansion service is provided, will attempt to run the default GCP
	expansion service.</p></li>
	<li><p><strong>flush_count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – (Optional) Max number of rows to flush.
	Default is FLUSH_COUNT (1000 rows).</p></li>
	<li><p><strong>max_row_bytes</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – (Optional) Max number of row mutations size to flush.
	Default is MAX_ROW_BYTES (5 MB).</p></li>
	</ul>
	</dd>
	</dl>
	<dl class="py attribute">
	<dt class="sig sig-object py" id="apache_beam.io.gcp.bigtableio.WriteToBigTable.URN">
	<span class="sig-name descname"><span class="pre">URN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'beam:schematransform:org.apache.beam:bigtable_write:v1'</span></em><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.WriteToBigTable.URN" title="Link to this definition"></a></dt>
	<dd></dd></dl>

	<dl class="py method">
	<dt class="sig sig-object py" id="apache_beam.io.gcp.bigtableio.WriteToBigTable.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">input</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/bigtableio.html#WriteToBigTable.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.WriteToBigTable.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.gcp.bigtableio.ReadFromBigtable">
	<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.gcp.bigtableio.</span></span><span class="sig-name descname"><span class="pre">ReadFromBigtable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/bigtableio.html#ReadFromBigtable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.ReadFromBigtable" 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>Reads rows from Bigtable.</p>
	<p>Returns a PCollection of PartialRowData objects, each representing a
	Bigtable row. For more information about this row object, visit
	<a class="reference external" href="https://cloud.google.com/python/docs/reference/bigtable/latest/row#class-googlecloudbigtablerowpartialrowdatarowkey">https://cloud.google.com/python/docs/reference/bigtable/latest/row#class-googlecloudbigtablerowpartialrowdatarowkey</a></p>
	<p>Initialize a ReadFromBigtable 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>table_id</strong> – The ID of the table to read from.</p></li>
	<li><p><strong>instance_id</strong> – The ID of the instance where the table resides.</p></li>
	<li><p><strong>project_id</strong> – The GCP project ID.</p></li>
	<li><p><strong>expansion_service</strong> – The address of the expansion service. If no expansion service is
	provided, will attempt to run the default GCP expansion service.</p></li>
	</ul>
	</dd>
	</dl>
	<dl class="py attribute">
	<dt class="sig sig-object py" id="apache_beam.io.gcp.bigtableio.ReadFromBigtable.URN">
	<span class="sig-name descname"><span class="pre">URN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'beam:schematransform:org.apache.beam:bigtable_read:v1'</span></em><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.ReadFromBigtable.URN" title="Link to this definition"></a></dt>
	<dd></dd></dl>

	<dl class="py method">
	<dt class="sig sig-object py" id="apache_beam.io.gcp.bigtableio.ReadFromBigtable.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">input</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/bigtableio.html#ReadFromBigtable.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.gcp.bigtableio.ReadFromBigtable.expand" 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.bigquery_tools.html" class="btn btn-neutral float-left" title="apache_beam.io.gcp.bigquery_tools module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
	<a href="apache_beam.io.gcp.dicomclient.html" class="btn btn-neutral float-right" title="apache_beam.io.gcp.dicomclient 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>