| |
| |
| <!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.v1new.types — 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> »</li> |
| |
| <li><a href="../../../../../index.html">Module code</a> »</li> |
| |
| <li>apache_beam.io.gcp.datastore.v1new.types</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.v1new.types</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 "License"); 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 "AS IS" 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">"""</span> |
| <span class="sd">Beam Datastore types.</span> |
| <span class="sd">"""</span> |
| |
| <span class="c1"># pytype: skip-file</span> |
| |
| <span class="kn">import</span> <span class="nn">copy</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Iterable</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</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">typing</span> <span class="kn">import</span> <span class="n">Text</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span> |
| |
| <span class="kn">from</span> <span class="nn">google.cloud.datastore</span> <span class="kn">import</span> <span class="n">entity</span> |
| <span class="kn">from</span> <span class="nn">google.cloud.datastore</span> <span class="kn">import</span> <span class="n">key</span> |
| <span class="kn">from</span> <span class="nn">google.cloud.datastore</span> <span class="kn">import</span> <span class="n">query</span> |
| |
| <span class="kn">from</span> <span class="nn">apache_beam.options.value_provider</span> <span class="kn">import</span> <span class="n">ValueProvider</span> |
| |
| <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'Query'</span><span class="p">,</span> <span class="s1">'Key'</span><span class="p">,</span> <span class="s1">'Entity'</span><span class="p">]</span> |
| |
| |
| <div class="viewcode-block" id="Query"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1new.types.html#apache_beam.io.gcp.datastore.v1new.types.Query">[docs]</a><span class="k">class</span> <span class="nc">Query</span><span class="p">(</span><span class="nb">object</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">kind</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">project</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">namespace</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">ancestor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">filters</span><span class="o">=</span><span class="p">(),</span> |
| <span class="n">projection</span><span class="o">=</span><span class="p">(),</span> |
| <span class="n">order</span><span class="o">=</span><span class="p">(),</span> |
| <span class="n">distinct_on</span><span class="o">=</span><span class="p">(),</span> |
| <span class="n">limit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Represents a Datastore query.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> kind: (str) The kind to query.</span> |
| <span class="sd"> project: (str) Required. Project associated with query.</span> |
| <span class="sd"> namespace: (str, ValueProvider(str)) (Optional) Namespace to restrict</span> |
| <span class="sd"> results to.</span> |
| <span class="sd"> ancestor: (:class:`~apache_beam.io.gcp.datastore.v1new.types.Key`)</span> |
| <span class="sd"> (Optional) key of the ancestor to which this query's results are</span> |
| <span class="sd"> restricted.</span> |
| <span class="sd"> filters: (sequence of tuple[str, str, str],</span> |
| <span class="sd"> sequence of</span> |
| <span class="sd"> tuple[ValueProvider(str), ValueProvider(str), ValueProvider(str)])</span> |
| <span class="sd"> Property filters applied by this query.</span> |
| <span class="sd"> The sequence is ``(property_name, operator, value)``.</span> |
| <span class="sd"> projection: (sequence of string) fields returned as part of query results.</span> |
| <span class="sd"> order: (sequence of string) field names used to order query results.</span> |
| <span class="sd"> Prepend ``-`` to a field name to sort it in descending order.</span> |
| <span class="sd"> distinct_on: (sequence of string) field names used to group query</span> |
| <span class="sd"> results.</span> |
| <span class="sd"> limit: (int) Maximum amount of results to return.</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">kind</span> <span class="o">=</span> <span class="n">kind</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">project</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span> <span class="o">=</span> <span class="n">namespace</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ancestor</span> <span class="o">=</span> <span class="n">ancestor</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">filters</span> <span class="o">=</span> <span class="n">filters</span> <span class="ow">or</span> <span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">projection</span> <span class="o">=</span> <span class="n">projection</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">order</span> <span class="o">=</span> <span class="n">order</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">distinct_on</span> <span class="o">=</span> <span class="n">distinct_on</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">limit</span> <span class="o">=</span> <span class="n">limit</span> |
| |
| <span class="k">def</span> <span class="nf">_to_client_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> Returns a ``google.cloud.datastore.query.Query`` instance that represents</span> |
| <span class="sd"> this query.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> client: (``google.cloud.datastore.client.Client``) Datastore client</span> |
| <span class="sd"> instance to use.</span> |
| <span class="sd"> """</span> |
| <span class="n">ancestor_client_key</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ancestor</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">ancestor_client_key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ancestor</span><span class="o">.</span><span class="n">to_client_key</span><span class="p">()</span> |
| |
| <span class="c1"># Resolve ValueProvider arguments.</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">filters</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_set_runtime_filters</span><span class="p">()</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">,</span> <span class="n">ValueProvider</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| |
| <span class="k">return</span> <span class="n">query</span><span class="o">.</span><span class="n">Query</span><span class="p">(</span> |
| <span class="n">client</span><span class="p">,</span> |
| <span class="n">kind</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">kind</span><span class="p">,</span> |
| <span class="n">project</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span> |
| <span class="n">namespace</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">,</span> |
| <span class="n">ancestor</span><span class="o">=</span><span class="n">ancestor_client_key</span><span class="p">,</span> |
| <span class="n">filters</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">filters</span><span class="p">,</span> |
| <span class="n">projection</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">projection</span><span class="p">,</span> |
| <span class="n">order</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">order</span><span class="p">,</span> |
| <span class="n">distinct_on</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">distinct_on</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_set_runtime_filters</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> Extracts values from ValueProviders in `self.filters` if available</span> |
| <span class="sd"> :param filters: sequence of tuple[str, str, str] or</span> |
| <span class="sd"> sequence of tuple[ValueProvider, ValueProvider, ValueProvider]</span> |
| <span class="sd"> :return: tuple[str, str, str]</span> |
| <span class="sd"> """</span> |
| <span class="n">runtime_filters</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">all</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">filter_tuple</span><span class="p">)</span> <span class="o">==</span> <span class="mi">3</span> <span class="k">for</span> <span class="n">filter_tuple</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">filters</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span> |
| <span class="s1">'</span><span class="si">%s</span><span class="s1">: filters must be a sequence of tuple with length=3'</span> |
| <span class="s1">' got </span><span class="si">%r</span><span class="s1"> instead'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">filters</span><span class="p">))</span> |
| |
| <span class="k">for</span> <span class="n">filter_type</span><span class="p">,</span> <span class="n">filter_operator</span><span class="p">,</span> <span class="n">filter_value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">filters</span><span class="p">:</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">filter_type</span><span class="p">,</span> <span class="n">ValueProvider</span><span class="p">):</span> |
| <span class="n">filter_type</span> <span class="o">=</span> <span class="n">filter_type</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">filter_operator</span><span class="p">,</span> <span class="n">ValueProvider</span><span class="p">):</span> |
| <span class="n">filter_operator</span> <span class="o">=</span> <span class="n">filter_operator</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">filter_value</span><span class="p">,</span> <span class="n">ValueProvider</span><span class="p">):</span> |
| <span class="n">filter_value</span> <span class="o">=</span> <span class="n">filter_value</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="n">runtime_filters</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">filter_type</span><span class="p">,</span> <span class="n">filter_operator</span><span class="p">,</span> <span class="n">filter_value</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="n">runtime_filters</span> <span class="ow">or</span> <span class="p">()</span> |
| |
| <div class="viewcode-block" id="Query.clone"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1new.types.html#apache_beam.io.gcp.datastore.v1new.types.Query.clone">[docs]</a> <span class="k">def</span> <span class="nf">clone</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="p">(</span> |
| <span class="s1">'<Query(kind=</span><span class="si">%s</span><span class="s1">, project=</span><span class="si">%s</span><span class="s1">, namespace=</span><span class="si">%s</span><span class="s1">, ancestor=</span><span class="si">%s</span><span class="s1">, filters=</span><span class="si">%s</span><span class="s1">,'</span> |
| <span class="s1">'projection=</span><span class="si">%s</span><span class="s1">, order=</span><span class="si">%s</span><span class="s1">, distinct_on=</span><span class="si">%s</span><span class="s1">, limit=</span><span class="si">%s</span><span class="s1">)>'</span> <span class="o">%</span> <span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">kind</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ancestor</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">filters</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">projection</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">order</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">distinct_on</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">limit</span><span class="p">))</span></div> |
| |
| |
| <div class="viewcode-block" id="Key"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1new.types.html#apache_beam.io.gcp.datastore.v1new.types.Key">[docs]</a><span class="k">class</span> <span class="nc">Key</span><span class="p">(</span><span class="nb">object</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">path_elements</span><span class="p">,</span> <span class="c1"># type: List[Union[Text, int]]</span> |
| <span class="n">parent</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Key]</span> |
| <span class="n">project</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Text]</span> |
| <span class="n">namespace</span><span class="o">=</span><span class="kc">None</span> <span class="c1"># type: Optional[Text]</span> |
| <span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> Represents a Datastore key.</span> |
| |
| <span class="sd"> The partition ID is represented by its components: namespace and project.</span> |
| <span class="sd"> If key has a parent, project and namespace should either be unset or match</span> |
| <span class="sd"> the parent's.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> path_elements: (list of str and int) Key path: an alternating sequence of</span> |
| <span class="sd"> kind and identifier. The kind must be of type ``str`` and identifier may</span> |
| <span class="sd"> be a ``str`` or an ``int``.</span> |
| <span class="sd"> If the last identifier is omitted this is an incomplete key, which is</span> |
| <span class="sd"> unsupported in ``WriteToDatastore`` and ``DeleteFromDatastore``.</span> |
| <span class="sd"> See :class:`google.cloud.datastore.key.Key` for more details.</span> |
| <span class="sd"> parent: (:class:`~apache_beam.io.gcp.datastore.v1new.types.Key`)</span> |
| <span class="sd"> (optional) Parent for this key.</span> |
| <span class="sd"> project: (str) Project ID. Required unless set by parent.</span> |
| <span class="sd"> namespace: (str) (optional) Namespace ID</span> |
| <span class="sd"> """</span> |
| <span class="c1"># Verification or arguments is delegated to to_client_key().</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">path_elements</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">path_elements</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="n">parent</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span> <span class="o">=</span> <span class="n">namespace</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">project</span> |
| |
| <div class="viewcode-block" id="Key.from_client_key"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1new.types.html#apache_beam.io.gcp.datastore.v1new.types.Key.from_client_key">[docs]</a> <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">from_client_key</span><span class="p">(</span><span class="n">client_key</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">Key</span><span class="p">(</span> |
| <span class="n">client_key</span><span class="o">.</span><span class="n">flat_path</span><span class="p">,</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">client_key</span><span class="o">.</span><span class="n">project</span><span class="p">,</span> |
| <span class="n">namespace</span><span class="o">=</span><span class="n">client_key</span><span class="o">.</span><span class="n">namespace</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Key.to_client_key"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1new.types.html#apache_beam.io.gcp.datastore.v1new.types.Key.to_client_key">[docs]</a> <span class="k">def</span> <span class="nf">to_client_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> Returns a :class:`google.cloud.datastore.key.Key` instance that represents</span> |
| <span class="sd"> this key.</span> |
| <span class="sd"> """</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent</span> |
| <span class="k">if</span> <span class="n">parent</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">parent</span> <span class="o">=</span> <span class="n">parent</span><span class="o">.</span><span class="n">to_client_key</span><span class="p">()</span> |
| <span class="k">return</span> <span class="n">key</span><span class="o">.</span><span class="n">Key</span><span class="p">(</span> |
| <span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">path_elements</span><span class="p">,</span> |
| <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> |
| <span class="n">namespace</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">,</span> |
| <span class="n">project</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">)</span></div> |
| |
| <span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Key</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">path_elements</span> <span class="o">!=</span> <span class="n">other</span><span class="o">.</span><span class="n">path_elements</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">!=</span> <span class="n">other</span><span class="o">.</span><span class="n">project</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">other</span><span class="o">.</span><span class="n">parent</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">parent</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">other</span><span class="o">.</span><span class="n">parent</span> <span class="ow">is</span> <span class="kc">None</span> |
| |
| <span class="fm">__hash__</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># type: ignore[assignment]</span> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'<</span><span class="si">%s</span><span class="s1">(</span><span class="si">%s</span><span class="s1">, parent=</span><span class="si">%s</span><span class="s1">, project=</span><span class="si">%s</span><span class="s1">, namespace=</span><span class="si">%s</span><span class="s1">)>'</span> <span class="o">%</span> <span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> |
| <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path_elements</span><span class="p">),</span> |
| <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="p">),</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">)</span></div> |
| |
| |
| <div class="viewcode-block" id="Entity"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1new.types.html#apache_beam.io.gcp.datastore.v1new.types.Entity">[docs]</a><span class="k">class</span> <span class="nc">Entity</span><span class="p">(</span><span class="nb">object</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">key</span><span class="p">,</span> <span class="c1"># type: Key</span> |
| <span class="n">exclude_from_indexes</span><span class="o">=</span><span class="p">()</span> <span class="c1"># type: Iterable[str]</span> |
| <span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> Represents a Datastore entity.</span> |
| |
| <span class="sd"> Does not support the property value "meaning" field.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> key: (Key) A complete Key representing this Entity.</span> |
| <span class="sd"> exclude_from_indexes: (iterable of str) List of property keys whose values</span> |
| <span class="sd"> should not be indexed for this entity.</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">key</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">exclude_from_indexes</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">exclude_from_indexes</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">properties</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <div class="viewcode-block" id="Entity.set_properties"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1new.types.html#apache_beam.io.gcp.datastore.v1new.types.Entity.set_properties">[docs]</a> <span class="k">def</span> <span class="nf">set_properties</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">property_dict</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Sets a dictionary of properties on this entity.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> property_dict: A map from property name to value. See</span> |
| <span class="sd"> :class:`google.cloud.datastore.entity.Entity` documentation for allowed</span> |
| <span class="sd"> values.</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">property_dict</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Entity.from_client_entity"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1new.types.html#apache_beam.io.gcp.datastore.v1new.types.Entity.from_client_entity">[docs]</a> <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">from_client_entity</span><span class="p">(</span><span class="n">client_entity</span><span class="p">):</span> |
| <span class="n">res</span> <span class="o">=</span> <span class="n">Entity</span><span class="p">(</span> |
| <span class="n">Key</span><span class="o">.</span><span class="n">from_client_key</span><span class="p">(</span><span class="n">client_entity</span><span class="o">.</span><span class="n">key</span><span class="p">),</span> |
| <span class="n">exclude_from_indexes</span><span class="o">=</span><span class="nb">set</span><span class="p">(</span><span class="n">client_entity</span><span class="o">.</span><span class="n">exclude_from_indexes</span><span class="p">))</span> |
| <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">client_entity</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">key</span><span class="o">.</span><span class="n">Key</span><span class="p">):</span> |
| <span class="n">value</span> <span class="o">=</span> <span class="n">Key</span><span class="o">.</span><span class="n">from_client_key</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">entity</span><span class="o">.</span><span class="n">Entity</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">key</span><span class="p">:</span> |
| <span class="n">value</span> <span class="o">=</span> <span class="n">Entity</span><span class="o">.</span><span class="n">from_client_entity</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">value</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span> |
| <span class="n">res</span><span class="o">.</span><span class="n">properties</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span> |
| <span class="k">return</span> <span class="n">res</span></div> |
| |
| <div class="viewcode-block" id="Entity.to_client_entity"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1new.types.html#apache_beam.io.gcp.datastore.v1new.types.Entity.to_client_entity">[docs]</a> <span class="k">def</span> <span class="nf">to_client_entity</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> Returns a :class:`google.cloud.datastore.entity.Entity` instance that</span> |
| <span class="sd"> represents this entity.</span> |
| <span class="sd"> """</span> |
| <span class="n">res</span> <span class="o">=</span> <span class="n">entity</span><span class="o">.</span><span class="n">Entity</span><span class="p">(</span> |
| <span class="n">key</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">to_client_key</span><span class="p">(),</span> |
| <span class="n">exclude_from_indexes</span><span class="o">=</span><span class="nb">tuple</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">exclude_from_indexes</span><span class="p">))</span> |
| <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Key</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">value</span><span class="o">.</span><span class="n">project</span><span class="p">:</span> |
| <span class="n">value</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">project</span> |
| <span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">to_client_key</span><span class="p">()</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Entity</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">value</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">project</span><span class="p">:</span> |
| <span class="n">value</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">project</span> |
| <span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">to_client_entity</span><span class="p">()</span> |
| <span class="n">res</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span> |
| <span class="k">return</span> <span class="n">res</span></div> |
| |
| <span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Entity</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| <span class="k">return</span> <span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">key</span> <span class="ow">and</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">exclude_from_indexes</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">exclude_from_indexes</span> <span class="ow">and</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">properties</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">properties</span><span class="p">)</span> |
| |
| <span class="fm">__hash__</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># type: ignore[assignment]</span> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s2">"<</span><span class="si">%s</span><span class="s2">(key=</span><span class="si">%s</span><span class="s2">, exclude_from_indexes=</span><span class="si">%s</span><span class="s2">) properties=</span><span class="si">%s</span><span class="s2">>"</span> <span class="o">%</span> <span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> |
| <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">),</span> |
| <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">exclude_from_indexes</span><span class="p">),</span> |
| <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="p">))</span></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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> |
