Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.8.0 / . / pydoc / 2.8.0 / _modules / apache_beam / io / gcp / datastore / v1 / fake_datastore.html
blob: 6cd2f034d26cd0fc42a22aa6a8116bf958660ab2 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.io.gcp.datastore.v1.fake_datastore &mdash; Apache Beam documentation</title>
<link rel="stylesheet" href="../../../../../../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../../../../../../genindex.html"/>
<link rel="search" title="Search" href="../../../../../../search.html"/>
<link rel="top" title="Apache Beam documentation" href="../../../../../../index.html"/>
<link rel="up" title="Module code" href="../../../../../index.html"/>
<script src="../../../../../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../../../../../index.html" class="icon icon-home"> Apache Beam
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.internal.html">apache_beam.internal package</a></li>
<li class="toctree-l1"><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.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.testing.html">apache_beam.testing package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.tools.html">apache_beam.tools package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.version.html">apache_beam.version module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" 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.datastore.v1.fake_datastore</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.datastore.v1.fake_datastore</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;Fake datastore used for unit testing.</span>
<span class="sd">For internal use only; no backwards-compatibility guarantees.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
<span class="kn">import</span> <span class="nn">uuid</span>
<span class="kn">from</span> <span class="nn">builtins</span> <span class="k">import</span> <span class="nb">range</span>
<span class="c1"># Protect against environments where datastore library is not available.</span>
<span class="c1"># pylint: disable=wrong-import-order, wrong-import-position</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">google.cloud.proto.datastore.v1</span> <span class="k">import</span> <span class="n">datastore_pb2</span>
<span class="kn">from</span> <span class="nn">google.cloud.proto.datastore.v1</span> <span class="k">import</span> <span class="n">query_pb2</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="c1"># pylint: enable=wrong-import-order, wrong-import-position</span>
<div class="viewcode-block" id="create_run_query"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1.fake_datastore.html#apache_beam.io.gcp.datastore.v1.fake_datastore.create_run_query">[docs]</a><span class="k">def</span> <span class="nf">create_run_query</span><span class="p">(</span><span class="n">entities</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;A fake datastore run_query method that returns entities in batches.</span>
<span class="sd"> Note: the outer method is needed to make the `entities` and `batch_size`</span>
<span class="sd"> available in the scope of fake_run_query method.</span>
<span class="sd"> Args:</span>
<span class="sd"> entities: list of entities supposed to be contained in the datastore.</span>
<span class="sd"> batch_size: the number of entities that run_query method returns in one</span>
<span class="sd"> request.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">run_query</span><span class="p">(</span><span class="n">req</span><span class="p">):</span>
<span class="n">start</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">req</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">start_cursor</span><span class="p">)</span> <span class="k">if</span> <span class="n">req</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">start_cursor</span> <span class="k">else</span> <span class="mi">0</span>
<span class="c1"># if query limit is less than batch_size, then only return that much.</span>
<span class="n">count</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">req</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">limit</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>
<span class="c1"># cannot go more than the number of entities contained in datastore.</span>
<span class="n">end</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">entities</span><span class="p">),</span> <span class="n">start</span> <span class="o">+</span> <span class="n">count</span><span class="p">)</span>
<span class="n">finish</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># Finish reading when there are no more entities to return,</span>
<span class="c1"># or request query limit has been satisfied.</span>
<span class="k">if</span> <span class="n">end</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">entities</span><span class="p">)</span> <span class="ow">or</span> <span class="n">count</span> <span class="o">==</span> <span class="n">req</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">limit</span><span class="o">.</span><span class="n">value</span><span class="p">:</span>
<span class="n">finish</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">return</span> <span class="n">create_response</span><span class="p">(</span><span class="n">entities</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">end</span><span class="p">],</span> <span class="nb">str</span><span class="p">(</span><span class="n">end</span><span class="p">),</span> <span class="n">finish</span><span class="p">)</span>
<span class="k">return</span> <span class="n">run_query</span></div>
<div class="viewcode-block" id="create_commit"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1.fake_datastore.html#apache_beam.io.gcp.datastore.v1.fake_datastore.create_commit">[docs]</a><span class="k">def</span> <span class="nf">create_commit</span><span class="p">(</span><span class="n">mutations</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;A fake Datastore commit method that writes the mutations to a list.</span>
<span class="sd"> Args:</span>
<span class="sd"> mutations: A list to write mutations to.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A fake Datastore commit method</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">commit</span><span class="p">(</span><span class="n">req</span><span class="p">):</span>
<span class="k">for</span> <span class="n">mutation</span> <span class="ow">in</span> <span class="n">req</span><span class="o">.</span><span class="n">mutations</span><span class="p">:</span>
<span class="n">mutations</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">mutation</span><span class="p">)</span>
<span class="k">return</span> <span class="n">commit</span></div>
<div class="viewcode-block" id="create_response"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1.fake_datastore.html#apache_beam.io.gcp.datastore.v1.fake_datastore.create_response">[docs]</a><span class="k">def</span> <span class="nf">create_response</span><span class="p">(</span><span class="n">entities</span><span class="p">,</span> <span class="n">end_cursor</span><span class="p">,</span> <span class="n">finish</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Creates a query response for a given batch of scatter entities.&quot;&quot;&quot;</span>
<span class="n">resp</span> <span class="o">=</span> <span class="n">datastore_pb2</span><span class="o">.</span><span class="n">RunQueryResponse</span><span class="p">()</span>
<span class="k">if</span> <span class="n">finish</span><span class="p">:</span>
<span class="n">resp</span><span class="o">.</span><span class="n">batch</span><span class="o">.</span><span class="n">more_results</span> <span class="o">=</span> <span class="n">query_pb2</span><span class="o">.</span><span class="n">QueryResultBatch</span><span class="o">.</span><span class="n">NO_MORE_RESULTS</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">resp</span><span class="o">.</span><span class="n">batch</span><span class="o">.</span><span class="n">more_results</span> <span class="o">=</span> <span class="n">query_pb2</span><span class="o">.</span><span class="n">QueryResultBatch</span><span class="o">.</span><span class="n">NOT_FINISHED</span>
<span class="n">resp</span><span class="o">.</span><span class="n">batch</span><span class="o">.</span><span class="n">end_cursor</span> <span class="o">=</span> <span class="n">end_cursor</span>
<span class="k">for</span> <span class="n">entity_result</span> <span class="ow">in</span> <span class="n">entities</span><span class="p">:</span>
<span class="n">resp</span><span class="o">.</span><span class="n">batch</span><span class="o">.</span><span class="n">entity_results</span><span class="o">.</span><span class="n">add</span><span class="p">()</span><span class="o">.</span><span class="n">CopyFrom</span><span class="p">(</span><span class="n">entity_result</span><span class="p">)</span>
<span class="k">return</span> <span class="n">resp</span></div>
<div class="viewcode-block" id="create_entities"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1.fake_datastore.html#apache_beam.io.gcp.datastore.v1.fake_datastore.create_entities">[docs]</a><span class="k">def</span> <span class="nf">create_entities</span><span class="p">(</span><span class="n">count</span><span class="p">,</span> <span class="n">id_or_name</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Creates a list of entities with random keys.&quot;&quot;&quot;</span>
<span class="n">entities</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">count</span><span class="p">):</span>
<span class="n">entity_result</span> <span class="o">=</span> <span class="n">query_pb2</span><span class="o">.</span><span class="n">EntityResult</span><span class="p">()</span>
<span class="k">if</span> <span class="n">id_or_name</span><span class="p">:</span>
<span class="n">entity_result</span><span class="o">.</span><span class="n">entity</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">add</span><span class="p">()</span><span class="o">.</span><span class="n">id</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">()</span><span class="o">.</span><span class="n">int</span> <span class="o">&amp;</span> <span class="p">((</span><span class="mi">1</span> <span class="o">&lt;&lt;</span> <span class="mi">63</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">entity_result</span><span class="o">.</span><span class="n">entity</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">add</span><span class="p">()</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">())</span>
<span class="n">entities</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">entity_result</span><span class="p">)</span>
<span class="k">return</span> <span class="n">entities</span></div>
</pre></div>
</div>
<div class="articleComments">
</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/snide/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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../../../../',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>