pydoc/2.47.0/_modules/apache_beam/io/gcp/spanner.html - beam-site - Git at Google



 <!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.gcp.spanner &mdash; Apache Beam 2.47.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" />
 </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.47.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>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.io.html">apache_beam.io package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.ml.html">apache_beam.ml package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.utils.html">apache_beam.utils package</a></li>
 <li class="toctree-l1"><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="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="../../../index.html">Module code</a> &raquo;</li>

       <li>apache_beam.io.gcp.spanner</li>


       <li class="wy-breadcrumbs-aside">

       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <h1>Source code for apache_beam.io.gcp.spanner</h1><div class="highlight"><pre>
 <span></span><span class="c1">#</span>
 <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
 <span class="c1"># contributor license agreements.  See the NOTICE file distributed with</span>
 <span class="c1"># this work for additional information regarding copyright ownership.</span>
 <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
 <span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
 <span class="c1"># the License.  You may obtain a copy of the License at</span>
 <span class="c1">#</span>
 <span class="c1">#    http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="c1">#</span>
 <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
 <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
 <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c1"># See the License for the specific language governing permissions and</span>
 <span class="c1"># limitations under the License.</span>
 <span class="c1">#</span>

 <span class="sd">&quot;&quot;&quot;PTransforms for supporting Spanner in Python pipelines.</span>

 <span class="sd">  These transforms are currently supported by Beam portable</span>
 <span class="sd">  Flink and Spark runners.</span>

 <span class="sd">  **Setup**</span>

 <span class="sd">  Transforms provided in this module are cross-language transforms</span>
 <span class="sd">  implemented in the Beam Java SDK. During the pipeline construction, Python SDK</span>
 <span class="sd">  will connect to a Java expansion service to expand these transforms.</span>
 <span class="sd">  To facilitate this, a small amount of setup is needed before using these</span>
 <span class="sd">  transforms in a Beam Python pipeline.</span>

 <span class="sd">  There are several ways to setup cross-language Spanner transforms.</span>

 <span class="sd">  * Option 1: use the default expansion service</span>
 <span class="sd">  * Option 2: specify a custom expansion service</span>

 <span class="sd">  See below for details regarding each of these options.</span>

 <span class="sd">  *Option 1: Use the default expansion service*</span>

 <span class="sd">  This is the recommended and easiest setup option for using Python Spanner</span>
 <span class="sd">  transforms. This option is only available for Beam 2.26.0 and later.</span>

 <span class="sd">  This option requires following pre-requisites before running the Beam</span>
 <span class="sd">  pipeline.</span>

 <span class="sd">  * Install Java runtime in the computer from where the pipeline is constructed</span>
 <span class="sd">    and make sure that &#39;java&#39; command is available.</span>

 <span class="sd">  In this option, Python SDK will either download (for released Beam version) or</span>
 <span class="sd">  build (when running from a Beam Git clone) a expansion service jar and use</span>
 <span class="sd">  that to expand transforms. Currently Spanner transforms use the</span>
 <span class="sd">  &#39;beam-sdks-java-io-google-cloud-platform-expansion-service&#39; jar for this</span>
 <span class="sd">  purpose.</span>

 <span class="sd">  *Option 2: specify a custom expansion service*</span>

 <span class="sd">  In this option, you startup your own expansion service and provide that as</span>
 <span class="sd">  a parameter when using the transforms provided in this module.</span>

 <span class="sd">  This option requires following pre-requisites before running the Beam</span>
 <span class="sd">  pipeline.</span>

 <span class="sd">  * Startup your own expansion service.</span>
 <span class="sd">  * Update your pipeline to provide the expansion service address when</span>
 <span class="sd">    initiating Spanner transforms provided in this module.</span>

 <span class="sd">  Flink Users can use the built-in Expansion Service of the Flink Runner&#39;s</span>
 <span class="sd">  Job Server. If you start Flink&#39;s Job Server, the expansion service will be</span>
 <span class="sd">  started on port 8097. For a different address, please set the</span>
 <span class="sd">  expansion_service parameter.</span>

 <span class="sd">  **More information**</span>

 <span class="sd">  For more information regarding cross-language transforms see:</span>
 <span class="sd">  - https://beam.apache.org/roadmap/portability/</span>

 <span class="sd">  For more information specific to Flink runner see:</span>
 <span class="sd">  - https://beam.apache.org/documentation/runners/flink/</span>
 <span class="sd">&quot;&quot;&quot;</span>

 <span class="c1"># pytype: skip-file</span>

 <span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
 <span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">auto</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">NamedTuple</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>

 <span class="kn">from</span> <span class="nn">apache_beam.transforms.external</span> <span class="kn">import</span> <span class="n">BeamJarExpansionService</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms.external</span> <span class="kn">import</span> <span class="n">ExternalTransform</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms.external</span> <span class="kn">import</span> <span class="n">NamedTupleBasedPayloadBuilder</span>
 <span class="kn">from</span> <span class="nn">apache_beam.typehints.schemas</span> <span class="kn">import</span> <span class="n">named_tuple_to_schema</span>

 <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
     <span class="s1">&#39;ReadFromSpanner&#39;</span><span class="p">,</span>
     <span class="s1">&#39;SpannerDelete&#39;</span><span class="p">,</span>
     <span class="s1">&#39;SpannerInsert&#39;</span><span class="p">,</span>
     <span class="s1">&#39;SpannerInsertOrUpdate&#39;</span><span class="p">,</span>
     <span class="s1">&#39;SpannerReplace&#39;</span><span class="p">,</span>
     <span class="s1">&#39;SpannerUpdate&#39;</span><span class="p">,</span>
     <span class="s1">&#39;TimestampBoundMode&#39;</span><span class="p">,</span>
     <span class="s1">&#39;TimeUnit&#39;</span><span class="p">,</span>
 <span class="p">]</span>


 <span class="k">def</span> <span class="nf">default_io_expansion_service</span><span class="p">():</span>
   <span class="k">return</span> <span class="n">BeamJarExpansionService</span><span class="p">(</span>
       <span class="s1">&#39;sdks:java:io:google-cloud-platform:expansion-service:shadowJar&#39;</span><span class="p">)</span>


 <div class="viewcode-block" id="TimeUnit"><a class="viewcode-back" href="../../../../apache_beam.io.gcp.spanner.html#apache_beam.io.gcp.spanner.TimeUnit">[docs]</a><span class="k">class</span> <span class="nc">TimeUnit</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
   <span class="n">NANOSECONDS</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>
   <span class="n">MICROSECONDS</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>
   <span class="n">MILLISECONDS</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>
   <span class="n">SECONDS</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>
   <span class="n">HOURS</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>
   <span class="n">DAYS</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span></div>


 <div class="viewcode-block" id="TimestampBoundMode"><a class="viewcode-back" href="../../../../apache_beam.io.gcp.spanner.html#apache_beam.io.gcp.spanner.TimestampBoundMode">[docs]</a><span class="k">class</span> <span class="nc">TimestampBoundMode</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
   <span class="n">MAX_STALENESS</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>
   <span class="n">EXACT_STALENESS</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>
   <span class="n">READ_TIMESTAMP</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>
   <span class="n">MIN_READ_TIMESTAMP</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>
   <span class="n">STRONG</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span></div>


 <span class="k">class</span> <span class="nc">ReadFromSpannerSchema</span><span class="p">(</span><span class="n">NamedTuple</span><span class="p">):</span>
   <span class="n">instance_id</span><span class="p">:</span> <span class="nb">str</span>
   <span class="n">database_id</span><span class="p">:</span> <span class="nb">str</span>
   <span class="n">schema</span><span class="p">:</span> <span class="nb">bytes</span>
   <span class="n">sql</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
   <span class="n">table</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
   <span class="n">project_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
   <span class="n">host</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
   <span class="n">emulator_host</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
   <span class="n">batching</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span>
   <span class="n">timestamp_bound_mode</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
   <span class="n">read_timestamp</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
   <span class="n">staleness</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
   <span class="n">time_unit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>


 <div class="viewcode-block" id="ReadFromSpanner"><a class="viewcode-back" href="../../../../apache_beam.io.gcp.spanner.html#apache_beam.io.gcp.spanner.ReadFromSpanner">[docs]</a><span class="k">class</span> <span class="nc">ReadFromSpanner</span><span class="p">(</span><span class="n">ExternalTransform</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  A PTransform which reads from the specified Spanner instance&#39;s database.</span>

 <span class="sd">  This transform required type of the row it has to return to provide the</span>
 <span class="sd">  schema. Example::</span>

 <span class="sd">    from typing import NamedTuple</span>
 <span class="sd">    from apache_beam import coders</span>

 <span class="sd">    class ExampleRow(NamedTuple):</span>
 <span class="sd">      id: int</span>
 <span class="sd">      name: unicode</span>

 <span class="sd">    coders.registry.register_coder(ExampleRow, coders.RowCoder)</span>

 <span class="sd">    with Pipeline() as p:</span>
 <span class="sd">      result = (</span>
 <span class="sd">          p</span>
 <span class="sd">          | ReadFromSpanner(</span>
 <span class="sd">              instance_id=&#39;your_instance_id&#39;,</span>
 <span class="sd">              database_id=&#39;your_database_id&#39;,</span>
 <span class="sd">              project_id=&#39;your_project_id&#39;,</span>
 <span class="sd">              row_type=ExampleRow,</span>
 <span class="sd">              sql=&#39;SELECT * FROM some_table&#39;,</span>
 <span class="sd">              timestamp_bound_mode=TimestampBoundMode.MAX_STALENESS,</span>
 <span class="sd">              staleness=3,</span>
 <span class="sd">              time_unit=TimeUnit.HOURS,</span>
 <span class="sd">          ).with_output_types(ExampleRow))</span>

 <span class="sd">  Experimental; no backwards compatibility guarantees.</span>
 <span class="sd">  &quot;&quot;&quot;</span>

   <span class="n">URN</span> <span class="o">=</span> <span class="s1">&#39;beam:transform:org.apache.beam:spanner_read:v1&#39;</span>

   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">project_id</span><span class="p">,</span>
       <span class="n">instance_id</span><span class="p">,</span>
       <span class="n">database_id</span><span class="p">,</span>
       <span class="n">row_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">sql</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">table</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">emulator_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">batching</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">timestamp_bound_mode</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">read_timestamp</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">staleness</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">time_unit</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">expansion_service</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
   <span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Initializes a read operation from Spanner.</span>

 <span class="sd">    :param project_id: Specifies the Cloud Spanner project.</span>
 <span class="sd">    :param instance_id: Specifies the Cloud Spanner instance.</span>
 <span class="sd">    :param database_id: Specifies the Cloud Spanner database.</span>
 <span class="sd">    :param row_type: Row type that fits the given query or table. Passed as</span>
 <span class="sd">        NamedTuple, e.g. NamedTuple(&#39;name&#39;, [(&#39;row_name&#39;, unicode)])</span>
 <span class="sd">    :param sql: An sql query to execute. It&#39;s results must fit the</span>
 <span class="sd">        provided row_type. Don&#39;t use when table is set.</span>
 <span class="sd">    :param table: A spanner table. When provided all columns from row_type</span>
 <span class="sd">        will be selected to query. Don&#39;t use when query is set.</span>
 <span class="sd">    :param batching: By default Batch API is used to read data from Cloud</span>
 <span class="sd">        Spanner. It is useful to disable batching when the underlying query</span>
 <span class="sd">        is not root-partitionable.</span>
 <span class="sd">    :param host: Specifies the Cloud Spanner host.</span>
 <span class="sd">    :param emulator_host: Specifies Spanner emulator host.</span>
 <span class="sd">    :param timestamp_bound_mode: Defines how Cloud Spanner will choose a</span>
 <span class="sd">        timestamp for a read-only transaction or a single read/query.</span>
 <span class="sd">        Passed as TimestampBoundMode enum. Possible values:</span>
 <span class="sd">        STRONG: A timestamp bound that will perform reads and queries at a</span>
 <span class="sd">        timestamp where all previously committed transactions are visible.</span>
 <span class="sd">        READ_TIMESTAMP: Returns a timestamp bound that will perform reads</span>
 <span class="sd">        and queries at the given timestamp.</span>
 <span class="sd">        MIN_READ_TIMESTAMP: Returns a timestamp bound that will perform reads</span>
 <span class="sd">        and queries at a timestamp chosen to be at least given timestamp value.</span>
 <span class="sd">        EXACT_STALENESS: Returns a timestamp bound that will perform reads and</span>
 <span class="sd">        queries at an exact staleness. The timestamp is chosen soon after the</span>
 <span class="sd">        read is started.</span>
 <span class="sd">        MAX_STALENESS: Returns a timestamp bound that will perform reads and</span>
 <span class="sd">        queries at a timestamp chosen to be at most time_unit stale.</span>
 <span class="sd">    :param read_timestamp: Timestamp in string. Use only when</span>
 <span class="sd">        timestamp_bound_mode is set to READ_TIMESTAMP or MIN_READ_TIMESTAMP.</span>
 <span class="sd">    :param staleness: Staleness value as int. Use only when</span>
 <span class="sd">        timestamp_bound_mode is set to EXACT_STALENESS or MAX_STALENESS.</span>
 <span class="sd">        time_unit has to be set along with this param.</span>
 <span class="sd">    :param time_unit: Time unit for staleness_value passed as TimeUnit enum.</span>
 <span class="sd">        Possible values: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS,</span>
 <span class="sd">        HOURS, DAYS.</span>
 <span class="sd">    :param expansion_service: The address (host:port) of the ExpansionService.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">assert</span> <span class="n">row_type</span>
     <span class="k">assert</span> <span class="n">sql</span> <span class="ow">or</span> <span class="n">table</span> <span class="ow">and</span> <span class="ow">not</span> <span class="p">(</span><span class="n">sql</span> <span class="ow">and</span> <span class="n">table</span><span class="p">)</span>
     <span class="n">staleness_value</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">staleness</span><span class="p">)</span> <span class="k">if</span> <span class="n">staleness</span> <span class="k">else</span> <span class="kc">None</span>

     <span class="k">if</span> <span class="n">staleness_value</span> <span class="ow">or</span> <span class="n">time_unit</span><span class="p">:</span>
       <span class="k">assert</span> <span class="n">staleness_value</span> <span class="ow">and</span> <span class="n">time_unit</span> <span class="ow">and</span> \
              <span class="n">timestamp_bound_mode</span> <span class="ow">is</span> <span class="n">TimestampBoundMode</span><span class="o">.</span><span class="n">MAX_STALENESS</span> <span class="ow">or</span> \
              <span class="n">timestamp_bound_mode</span> <span class="ow">is</span> <span class="n">TimestampBoundMode</span><span class="o">.</span><span class="n">EXACT_STALENESS</span>

     <span class="k">if</span> <span class="n">read_timestamp</span><span class="p">:</span>
       <span class="k">assert</span> <span class="n">timestamp_bound_mode</span> <span class="ow">is</span> <span class="n">TimestampBoundMode</span><span class="o">.</span><span class="n">MIN_READ_TIMESTAMP</span>\
              <span class="ow">or</span> <span class="n">timestamp_bound_mode</span> <span class="ow">is</span> <span class="n">TimestampBoundMode</span><span class="o">.</span><span class="n">READ_TIMESTAMP</span>

     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">URN</span><span class="p">,</span>
         <span class="n">NamedTupleBasedPayloadBuilder</span><span class="p">(</span>
             <span class="n">ReadFromSpannerSchema</span><span class="p">(</span>
                 <span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">,</span>
                 <span class="n">database_id</span><span class="o">=</span><span class="n">database_id</span><span class="p">,</span>
                 <span class="n">sql</span><span class="o">=</span><span class="n">sql</span><span class="p">,</span>
                 <span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">,</span>
                 <span class="n">schema</span><span class="o">=</span><span class="n">named_tuple_to_schema</span><span class="p">(</span><span class="n">row_type</span><span class="p">)</span><span class="o">.</span><span class="n">SerializeToString</span><span class="p">(),</span>
                 <span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
                 <span class="n">host</span><span class="o">=</span><span class="n">host</span><span class="p">,</span>
                 <span class="n">emulator_host</span><span class="o">=</span><span class="n">emulator_host</span><span class="p">,</span>
                 <span class="n">batching</span><span class="o">=</span><span class="n">batching</span><span class="p">,</span>
                 <span class="n">timestamp_bound_mode</span><span class="o">=</span><span class="n">_get_enum_name</span><span class="p">(</span><span class="n">timestamp_bound_mode</span><span class="p">),</span>
                 <span class="n">read_timestamp</span><span class="o">=</span><span class="n">read_timestamp</span><span class="p">,</span>
                 <span class="n">staleness</span><span class="o">=</span><span class="n">staleness</span><span class="p">,</span>
                 <span class="n">time_unit</span><span class="o">=</span><span class="n">_get_enum_name</span><span class="p">(</span><span class="n">time_unit</span><span class="p">),</span>
             <span class="p">),</span>
         <span class="p">),</span>
         <span class="n">expansion_service</span> <span class="ow">or</span> <span class="n">default_io_expansion_service</span><span class="p">(),</span>
     <span class="p">)</span></div>


 <span class="k">class</span> <span class="nc">WriteToSpannerSchema</span><span class="p">(</span><span class="n">NamedTuple</span><span class="p">):</span>
   <span class="n">project_id</span><span class="p">:</span> <span class="nb">str</span>
   <span class="n">instance_id</span><span class="p">:</span> <span class="nb">str</span>
   <span class="n">database_id</span><span class="p">:</span> <span class="nb">str</span>
   <span class="n">table</span><span class="p">:</span> <span class="nb">str</span>
   <span class="n">max_batch_size_bytes</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
   <span class="n">max_number_mutations</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
   <span class="n">max_number_rows</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
   <span class="n">grouping_factor</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
   <span class="n">host</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
   <span class="n">emulator_host</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
   <span class="n">commit_deadline</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
   <span class="n">max_cumulative_backoff</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>


 <span class="n">_CLASS_DOC</span> <span class="o">=</span> \
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  A PTransform which writes {operation} mutations to the specified Spanner</span>
 <span class="sd">  table.</span>

 <span class="sd">  This transform receives rows defined as NamedTuple. Example::</span>

 <span class="sd">    from typing import NamedTuple</span>
 <span class="sd">    from apache_beam import coders</span>

 <span class="sd">    class {row_type}(NamedTuple):</span>
 <span class="sd">       id: int</span>
 <span class="sd">       name: unicode</span>

 <span class="sd">    coders.registry.register_coder({row_type}, coders.RowCoder)</span>

 <span class="sd">    with Pipeline() as p:</span>
 <span class="sd">      _ = (</span>
 <span class="sd">          p</span>
 <span class="sd">          | &#39;Impulse&#39; &gt;&gt; beam.Impulse()</span>
 <span class="sd">          | &#39;Generate&#39; &gt;&gt; beam.FlatMap(lambda x: range(num_rows))</span>
 <span class="sd">          | &#39;To row&#39; &gt;&gt; beam.Map(lambda n: {row_type}(n, str(n))</span>
 <span class="sd">              .with_output_types({row_type})</span>
 <span class="sd">          | &#39;Write to Spanner&#39; &gt;&gt; Spanner{operation_suffix}(</span>
 <span class="sd">              instance_id=&#39;your_instance&#39;,</span>
 <span class="sd">              database_id=&#39;existing_database&#39;,</span>
 <span class="sd">              project_id=&#39;your_project_id&#39;,</span>
 <span class="sd">              table=&#39;your_table&#39;))</span>

 <span class="sd">  Experimental; no backwards compatibility guarantees.</span>
 <span class="sd">  &quot;&quot;&quot;</span>

 <span class="n">_INIT_DOC</span> <span class="o">=</span> \
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  Initializes {operation} operation to a Spanner table.</span>

 <span class="sd">  :param project_id: Specifies the Cloud Spanner project.</span>
 <span class="sd">  :param instance_id: Specifies the Cloud Spanner instance.</span>
 <span class="sd">  :param database_id: Specifies the Cloud Spanner database.</span>
 <span class="sd">  :param table: Specifies the Cloud Spanner table.</span>
 <span class="sd">  :param max_batch_size_bytes: Specifies the batch size limit (max number of</span>
 <span class="sd">      bytes mutated per batch). Default value is 1048576 bytes = 1MB.</span>
 <span class="sd">  :param max_number_mutations: Specifies the cell mutation limit (maximum</span>
 <span class="sd">      number of mutated cells per batch). Default value is 5000.</span>
 <span class="sd">  :param max_number_rows: Specifies the row mutation limit (maximum number of</span>
 <span class="sd">      mutated rows per batch). Default value is 500.</span>
 <span class="sd">  :param grouping_factor: Specifies the multiple of max mutation (in terms</span>
 <span class="sd">      of both bytes per batch and cells per batch) that is used to select a</span>
 <span class="sd">      set of mutations to sort by key for batching. This sort uses local</span>
 <span class="sd">      memory on the workers, so using large values can cause out of memory</span>
 <span class="sd">      errors. Default value is 1000.</span>
 <span class="sd">  :param host: Specifies the Cloud Spanner host.</span>
 <span class="sd">  :param emulator_host: Specifies Spanner emulator host.</span>
 <span class="sd">  :param commit_deadline: Specifies the deadline for the Commit API call.</span>
 <span class="sd">      Default is 15 secs. DEADLINE_EXCEEDED errors will prompt a backoff/retry</span>
 <span class="sd">      until the value of commit_deadline is reached. DEADLINE_EXCEEDED errors</span>
 <span class="sd">      are ar reported with logging and counters. Pass seconds as value.</span>
 <span class="sd">  :param max_cumulative_backoff: Specifies the maximum cumulative backoff</span>
 <span class="sd">      time when retrying after DEADLINE_EXCEEDED errors. Default is 900s</span>
 <span class="sd">      (15min). If the mutations still have not been written after this time,</span>
 <span class="sd">      they are treated as a failure, and handled according to the setting of</span>
 <span class="sd">      failure_mode. Pass seconds as value.</span>
 <span class="sd">  :param expansion_service: The address (host:port) of the ExpansionService.</span>
 <span class="sd">  &quot;&quot;&quot;</span>


 <span class="k">def</span> <span class="nf">_add_doc</span><span class="p">(</span>
     <span class="n">value</span><span class="p">,</span>
     <span class="n">operation</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="n">row_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="n">operation_suffix</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
 <span class="p">):</span>
   <span class="k">def</span> <span class="nf">_doc</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
     <span class="n">obj</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
         <span class="n">operation</span><span class="o">=</span><span class="n">operation</span><span class="p">,</span>
         <span class="n">row_type</span><span class="o">=</span><span class="n">row_type</span><span class="p">,</span>
         <span class="n">operation_suffix</span><span class="o">=</span><span class="n">operation_suffix</span><span class="p">,</span>
     <span class="p">)</span>
     <span class="k">return</span> <span class="n">obj</span>

   <span class="k">return</span> <span class="n">_doc</span>


 <div class="viewcode-block" id="SpannerDelete"><a class="viewcode-back" href="../../../../apache_beam.io.gcp.spanner.html#apache_beam.io.gcp.spanner.SpannerDelete">[docs]</a><span class="nd">@_add_doc</span><span class="p">(</span>
     <span class="n">_CLASS_DOC</span><span class="p">,</span>
     <span class="n">operation</span><span class="o">=</span><span class="s1">&#39;delete&#39;</span><span class="p">,</span>
     <span class="n">row_type</span><span class="o">=</span><span class="s1">&#39;ExampleKey&#39;</span><span class="p">,</span>
     <span class="n">operation_suffix</span><span class="o">=</span><span class="s1">&#39;Delete&#39;</span><span class="p">,</span>
 <span class="p">)</span>
 <span class="k">class</span> <span class="nc">SpannerDelete</span><span class="p">(</span><span class="n">ExternalTransform</span><span class="p">):</span>

   <span class="n">URN</span> <span class="o">=</span> <span class="s1">&#39;beam:transform:org.apache.beam:spanner_delete:v1&#39;</span>

   <span class="nd">@_add_doc</span><span class="p">(</span><span class="n">_INIT_DOC</span><span class="p">,</span> <span class="n">operation</span><span class="o">=</span><span class="s1">&#39;a delete&#39;</span><span class="p">)</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">project_id</span><span class="p">,</span>
       <span class="n">instance_id</span><span class="p">,</span>
       <span class="n">database_id</span><span class="p">,</span>
       <span class="n">table</span><span class="p">,</span>
       <span class="n">max_batch_size_bytes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_number_mutations</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_number_rows</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">grouping_factor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">emulator_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">commit_deadline</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_cumulative_backoff</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">expansion_service</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
   <span class="p">):</span>
     <span class="n">max_cumulative_backoff</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span>
         <span class="n">max_cumulative_backoff</span><span class="p">)</span> <span class="k">if</span> <span class="n">max_cumulative_backoff</span> <span class="k">else</span> <span class="kc">None</span>
     <span class="n">commit_deadline</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">commit_deadline</span><span class="p">)</span> <span class="k">if</span> <span class="n">commit_deadline</span> <span class="k">else</span> <span class="kc">None</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">URN</span><span class="p">,</span>
         <span class="n">NamedTupleBasedPayloadBuilder</span><span class="p">(</span>
             <span class="n">WriteToSpannerSchema</span><span class="p">(</span>
                 <span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
                 <span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">,</span>
                 <span class="n">database_id</span><span class="o">=</span><span class="n">database_id</span><span class="p">,</span>
                 <span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">,</span>
                 <span class="n">max_batch_size_bytes</span><span class="o">=</span><span class="n">max_batch_size_bytes</span><span class="p">,</span>
                 <span class="n">max_number_mutations</span><span class="o">=</span><span class="n">max_number_mutations</span><span class="p">,</span>
                 <span class="n">max_number_rows</span><span class="o">=</span><span class="n">max_number_rows</span><span class="p">,</span>
                 <span class="n">grouping_factor</span><span class="o">=</span><span class="n">grouping_factor</span><span class="p">,</span>
                 <span class="n">host</span><span class="o">=</span><span class="n">host</span><span class="p">,</span>
                 <span class="n">emulator_host</span><span class="o">=</span><span class="n">emulator_host</span><span class="p">,</span>
                 <span class="n">commit_deadline</span><span class="o">=</span><span class="n">commit_deadline</span><span class="p">,</span>
                 <span class="n">max_cumulative_backoff</span><span class="o">=</span><span class="n">max_cumulative_backoff</span><span class="p">,</span>
             <span class="p">),</span>
         <span class="p">),</span>
         <span class="n">expansion_service</span><span class="o">=</span><span class="n">expansion_service</span> <span class="ow">or</span> <span class="n">default_io_expansion_service</span><span class="p">(),</span>
     <span class="p">)</span></div>


 <div class="viewcode-block" id="SpannerInsert"><a class="viewcode-back" href="../../../../apache_beam.io.gcp.spanner.html#apache_beam.io.gcp.spanner.SpannerInsert">[docs]</a><span class="nd">@_add_doc</span><span class="p">(</span>
     <span class="n">_CLASS_DOC</span><span class="p">,</span>
     <span class="n">operation</span><span class="o">=</span><span class="s1">&#39;insert&#39;</span><span class="p">,</span>
     <span class="n">row_type</span><span class="o">=</span><span class="s1">&#39;ExampleRow&#39;</span><span class="p">,</span>
     <span class="n">operation_suffix</span><span class="o">=</span><span class="s1">&#39;Insert&#39;</span><span class="p">,</span>
 <span class="p">)</span>
 <span class="k">class</span> <span class="nc">SpannerInsert</span><span class="p">(</span><span class="n">ExternalTransform</span><span class="p">):</span>

   <span class="n">URN</span> <span class="o">=</span> <span class="s1">&#39;beam:transform:org.apache.beam:spanner_insert:v1&#39;</span>

   <span class="nd">@_add_doc</span><span class="p">(</span><span class="n">_INIT_DOC</span><span class="p">,</span> <span class="n">operation</span><span class="o">=</span><span class="s1">&#39;an insert&#39;</span><span class="p">)</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">project_id</span><span class="p">,</span>
       <span class="n">instance_id</span><span class="p">,</span>
       <span class="n">database_id</span><span class="p">,</span>
       <span class="n">table</span><span class="p">,</span>
       <span class="n">max_batch_size_bytes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_number_mutations</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_number_rows</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">grouping_factor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">emulator_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">commit_deadline</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_cumulative_backoff</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">expansion_service</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
   <span class="p">):</span>
     <span class="n">max_cumulative_backoff</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span>
         <span class="n">max_cumulative_backoff</span><span class="p">)</span> <span class="k">if</span> <span class="n">max_cumulative_backoff</span> <span class="k">else</span> <span class="kc">None</span>
     <span class="n">commit_deadline</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">commit_deadline</span><span class="p">)</span> <span class="k">if</span> <span class="n">commit_deadline</span> <span class="k">else</span> <span class="kc">None</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">URN</span><span class="p">,</span>
         <span class="n">NamedTupleBasedPayloadBuilder</span><span class="p">(</span>
             <span class="n">WriteToSpannerSchema</span><span class="p">(</span>
                 <span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
                 <span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">,</span>
                 <span class="n">database_id</span><span class="o">=</span><span class="n">database_id</span><span class="p">,</span>
                 <span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">,</span>
                 <span class="n">max_batch_size_bytes</span><span class="o">=</span><span class="n">max_batch_size_bytes</span><span class="p">,</span>
                 <span class="n">max_number_mutations</span><span class="o">=</span><span class="n">max_number_mutations</span><span class="p">,</span>
                 <span class="n">max_number_rows</span><span class="o">=</span><span class="n">max_number_rows</span><span class="p">,</span>
                 <span class="n">grouping_factor</span><span class="o">=</span><span class="n">grouping_factor</span><span class="p">,</span>
                 <span class="n">host</span><span class="o">=</span><span class="n">host</span><span class="p">,</span>
                 <span class="n">emulator_host</span><span class="o">=</span><span class="n">emulator_host</span><span class="p">,</span>
                 <span class="n">commit_deadline</span><span class="o">=</span><span class="n">commit_deadline</span><span class="p">,</span>
                 <span class="n">max_cumulative_backoff</span><span class="o">=</span><span class="n">max_cumulative_backoff</span><span class="p">,</span>
             <span class="p">),</span>
         <span class="p">),</span>
         <span class="n">expansion_service</span><span class="o">=</span><span class="n">expansion_service</span> <span class="ow">or</span> <span class="n">default_io_expansion_service</span><span class="p">(),</span>
     <span class="p">)</span></div>


 <div class="viewcode-block" id="SpannerReplace"><a class="viewcode-back" href="../../../../apache_beam.io.gcp.spanner.html#apache_beam.io.gcp.spanner.SpannerReplace">[docs]</a><span class="nd">@_add_doc</span><span class="p">(</span>
     <span class="n">_CLASS_DOC</span><span class="p">,</span>
     <span class="n">operation</span><span class="o">=</span><span class="s1">&#39;replace&#39;</span><span class="p">,</span>
     <span class="n">row_type</span><span class="o">=</span><span class="s1">&#39;ExampleRow&#39;</span><span class="p">,</span>
     <span class="n">operation_suffix</span><span class="o">=</span><span class="s1">&#39;Replace&#39;</span><span class="p">,</span>
 <span class="p">)</span>
 <span class="k">class</span> <span class="nc">SpannerReplace</span><span class="p">(</span><span class="n">ExternalTransform</span><span class="p">):</span>

   <span class="n">URN</span> <span class="o">=</span> <span class="s1">&#39;beam:transform:org.apache.beam:spanner_replace:v1&#39;</span>

   <span class="nd">@_add_doc</span><span class="p">(</span><span class="n">_INIT_DOC</span><span class="p">,</span> <span class="n">operation</span><span class="o">=</span><span class="s1">&#39;a replace&#39;</span><span class="p">)</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">project_id</span><span class="p">,</span>
       <span class="n">instance_id</span><span class="p">,</span>
       <span class="n">database_id</span><span class="p">,</span>
       <span class="n">table</span><span class="p">,</span>
       <span class="n">max_batch_size_bytes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_number_mutations</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_number_rows</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">grouping_factor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">emulator_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">commit_deadline</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_cumulative_backoff</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">expansion_service</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
   <span class="p">):</span>
     <span class="n">max_cumulative_backoff</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span>
         <span class="n">max_cumulative_backoff</span><span class="p">)</span> <span class="k">if</span> <span class="n">max_cumulative_backoff</span> <span class="k">else</span> <span class="kc">None</span>
     <span class="n">commit_deadline</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">commit_deadline</span><span class="p">)</span> <span class="k">if</span> <span class="n">commit_deadline</span> <span class="k">else</span> <span class="kc">None</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">URN</span><span class="p">,</span>
         <span class="n">NamedTupleBasedPayloadBuilder</span><span class="p">(</span>
             <span class="n">WriteToSpannerSchema</span><span class="p">(</span>
                 <span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
                 <span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">,</span>
                 <span class="n">database_id</span><span class="o">=</span><span class="n">database_id</span><span class="p">,</span>
                 <span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">,</span>
                 <span class="n">max_batch_size_bytes</span><span class="o">=</span><span class="n">max_batch_size_bytes</span><span class="p">,</span>
                 <span class="n">max_number_mutations</span><span class="o">=</span><span class="n">max_number_mutations</span><span class="p">,</span>
                 <span class="n">max_number_rows</span><span class="o">=</span><span class="n">max_number_rows</span><span class="p">,</span>
                 <span class="n">grouping_factor</span><span class="o">=</span><span class="n">grouping_factor</span><span class="p">,</span>
                 <span class="n">host</span><span class="o">=</span><span class="n">host</span><span class="p">,</span>
                 <span class="n">emulator_host</span><span class="o">=</span><span class="n">emulator_host</span><span class="p">,</span>
                 <span class="n">commit_deadline</span><span class="o">=</span><span class="n">commit_deadline</span><span class="p">,</span>
                 <span class="n">max_cumulative_backoff</span><span class="o">=</span><span class="n">max_cumulative_backoff</span><span class="p">,</span>
             <span class="p">),</span>
         <span class="p">),</span>
         <span class="n">expansion_service</span><span class="o">=</span><span class="n">expansion_service</span> <span class="ow">or</span> <span class="n">default_io_expansion_service</span><span class="p">(),</span>
     <span class="p">)</span></div>


 <div class="viewcode-block" id="SpannerInsertOrUpdate"><a class="viewcode-back" href="../../../../apache_beam.io.gcp.spanner.html#apache_beam.io.gcp.spanner.SpannerInsertOrUpdate">[docs]</a><span class="nd">@_add_doc</span><span class="p">(</span>
     <span class="n">_CLASS_DOC</span><span class="p">,</span>
     <span class="n">operation</span><span class="o">=</span><span class="s1">&#39;insert-or-update&#39;</span><span class="p">,</span>
     <span class="n">row_type</span><span class="o">=</span><span class="s1">&#39;ExampleRow&#39;</span><span class="p">,</span>
     <span class="n">operation_suffix</span><span class="o">=</span><span class="s1">&#39;InsertOrUpdate&#39;</span><span class="p">,</span>
 <span class="p">)</span>
 <span class="k">class</span> <span class="nc">SpannerInsertOrUpdate</span><span class="p">(</span><span class="n">ExternalTransform</span><span class="p">):</span>

   <span class="n">URN</span> <span class="o">=</span> <span class="s1">&#39;beam:transform:org.apache.beam:spanner_insert_or_update:v1&#39;</span>

   <span class="nd">@_add_doc</span><span class="p">(</span><span class="n">_INIT_DOC</span><span class="p">,</span> <span class="n">operation</span><span class="o">=</span><span class="s1">&#39;an insert-or-update&#39;</span><span class="p">)</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">project_id</span><span class="p">,</span>
       <span class="n">instance_id</span><span class="p">,</span>
       <span class="n">database_id</span><span class="p">,</span>
       <span class="n">table</span><span class="p">,</span>
       <span class="n">max_batch_size_bytes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_number_mutations</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_number_rows</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">grouping_factor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">emulator_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">commit_deadline</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_cumulative_backoff</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">expansion_service</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
   <span class="p">):</span>
     <span class="n">max_cumulative_backoff</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span>
         <span class="n">max_cumulative_backoff</span><span class="p">)</span> <span class="k">if</span> <span class="n">max_cumulative_backoff</span> <span class="k">else</span> <span class="kc">None</span>
     <span class="n">commit_deadline</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">commit_deadline</span><span class="p">)</span> <span class="k">if</span> <span class="n">commit_deadline</span> <span class="k">else</span> <span class="kc">None</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">URN</span><span class="p">,</span>
         <span class="n">NamedTupleBasedPayloadBuilder</span><span class="p">(</span>
             <span class="n">WriteToSpannerSchema</span><span class="p">(</span>
                 <span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
                 <span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">,</span>
                 <span class="n">database_id</span><span class="o">=</span><span class="n">database_id</span><span class="p">,</span>
                 <span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">,</span>
                 <span class="n">max_batch_size_bytes</span><span class="o">=</span><span class="n">max_batch_size_bytes</span><span class="p">,</span>
                 <span class="n">max_number_mutations</span><span class="o">=</span><span class="n">max_number_mutations</span><span class="p">,</span>
                 <span class="n">max_number_rows</span><span class="o">=</span><span class="n">max_number_rows</span><span class="p">,</span>
                 <span class="n">grouping_factor</span><span class="o">=</span><span class="n">grouping_factor</span><span class="p">,</span>
                 <span class="n">host</span><span class="o">=</span><span class="n">host</span><span class="p">,</span>
                 <span class="n">emulator_host</span><span class="o">=</span><span class="n">emulator_host</span><span class="p">,</span>
                 <span class="n">commit_deadline</span><span class="o">=</span><span class="n">commit_deadline</span><span class="p">,</span>
                 <span class="n">max_cumulative_backoff</span><span class="o">=</span><span class="n">max_cumulative_backoff</span><span class="p">,</span>
             <span class="p">),</span>
         <span class="p">),</span>
         <span class="n">expansion_service</span><span class="o">=</span><span class="n">expansion_service</span> <span class="ow">or</span> <span class="n">default_io_expansion_service</span><span class="p">(),</span>
     <span class="p">)</span></div>


 <div class="viewcode-block" id="SpannerUpdate"><a class="viewcode-back" href="../../../../apache_beam.io.gcp.spanner.html#apache_beam.io.gcp.spanner.SpannerUpdate">[docs]</a><span class="nd">@_add_doc</span><span class="p">(</span>
     <span class="n">_CLASS_DOC</span><span class="p">,</span>
     <span class="n">operation</span><span class="o">=</span><span class="s1">&#39;update&#39;</span><span class="p">,</span>
     <span class="n">row_type</span><span class="o">=</span><span class="s1">&#39;ExampleRow&#39;</span><span class="p">,</span>
     <span class="n">operation_suffix</span><span class="o">=</span><span class="s1">&#39;Update&#39;</span><span class="p">,</span>
 <span class="p">)</span>
 <span class="k">class</span> <span class="nc">SpannerUpdate</span><span class="p">(</span><span class="n">ExternalTransform</span><span class="p">):</span>

   <span class="n">URN</span> <span class="o">=</span> <span class="s1">&#39;beam:transform:org.apache.beam:spanner_update:v1&#39;</span>

   <span class="nd">@_add_doc</span><span class="p">(</span><span class="n">_INIT_DOC</span><span class="p">,</span> <span class="n">operation</span><span class="o">=</span><span class="s1">&#39;an update&#39;</span><span class="p">)</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">project_id</span><span class="p">,</span>
       <span class="n">instance_id</span><span class="p">,</span>
       <span class="n">database_id</span><span class="p">,</span>
       <span class="n">table</span><span class="p">,</span>
       <span class="n">max_batch_size_bytes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_number_mutations</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_number_rows</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">grouping_factor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">emulator_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">commit_deadline</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_cumulative_backoff</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">expansion_service</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
   <span class="p">):</span>
     <span class="n">max_cumulative_backoff</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span>
         <span class="n">max_cumulative_backoff</span><span class="p">)</span> <span class="k">if</span> <span class="n">max_cumulative_backoff</span> <span class="k">else</span> <span class="kc">None</span>
     <span class="n">commit_deadline</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">commit_deadline</span><span class="p">)</span> <span class="k">if</span> <span class="n">commit_deadline</span> <span class="k">else</span> <span class="kc">None</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">URN</span><span class="p">,</span>
         <span class="n">NamedTupleBasedPayloadBuilder</span><span class="p">(</span>
             <span class="n">WriteToSpannerSchema</span><span class="p">(</span>
                 <span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
                 <span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">,</span>
                 <span class="n">database_id</span><span class="o">=</span><span class="n">database_id</span><span class="p">,</span>
                 <span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">,</span>
                 <span class="n">max_batch_size_bytes</span><span class="o">=</span><span class="n">max_batch_size_bytes</span><span class="p">,</span>
                 <span class="n">max_number_mutations</span><span class="o">=</span><span class="n">max_number_mutations</span><span class="p">,</span>
                 <span class="n">max_number_rows</span><span class="o">=</span><span class="n">max_number_rows</span><span class="p">,</span>
                 <span class="n">grouping_factor</span><span class="o">=</span><span class="n">grouping_factor</span><span class="p">,</span>
                 <span class="n">host</span><span class="o">=</span><span class="n">host</span><span class="p">,</span>
                 <span class="n">emulator_host</span><span class="o">=</span><span class="n">emulator_host</span><span class="p">,</span>
                 <span class="n">commit_deadline</span><span class="o">=</span><span class="n">commit_deadline</span><span class="p">,</span>
                 <span class="n">max_cumulative_backoff</span><span class="o">=</span><span class="n">max_cumulative_backoff</span><span class="p">,</span>
             <span class="p">),</span>
         <span class="p">),</span>
         <span class="n">expansion_service</span><span class="o">=</span><span class="n">expansion_service</span> <span class="ow">or</span> <span class="n">default_io_expansion_service</span><span class="p">(),</span>
     <span class="p">)</span></div>


 <span class="k">def</span> <span class="nf">_get_enum_name</span><span class="p">(</span><span class="n">enum</span><span class="p">):</span>
   <span class="k">return</span> <span class="kc">None</span> <span class="k">if</span> <span class="n">enum</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">enum</span><span class="o">.</span><span class="n">name</span>
 </pre></div>

            </div>

           </div>
           <footer>


   <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>