forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbatch.html
More file actions
436 lines (363 loc) · 33.6 KB
/
batch.html
File metadata and controls
436 lines (363 loc) · 33.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>gcloud.datastore.batch — gcloud 777c6ac documentation</title>
<link rel="stylesheet" href="../../../_static/css/main.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/normalize.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/github.min.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '777c6ac',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/js/vendor/modernizr-2.6.2.min.js"></script>
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
<link rel="top" title="gcloud 777c6ac documentation" href="../../../index.html" />
<link rel="up" title="Module code" href="../../index.html" />
</head>
<body role="document">
<header class="page-header fixed" role="banner">
<h1 class="logo">
<a href="index.html" title="back to home">
<img src="../../../_static/images/logo.svg" alt="Google Cloud Platform" />
<span class="gcloud">gcloud</span>
</a>
</h1>
<nav class="main-nav">
<div class="nav-current">Python</div>
<ul class="menu">
<li>
<a href="
https://googlecloudplatform.github.io/gcloud-node/#/docs" title="Node.js docs page">
<img src="../../../_static/images/icon-lang-nodejs.svg" alt="Node.js icon" class="menu-icon" />
Node.js
</a>
</li>
<li>
<a href="
http://googlecloudplatform.github.io/gcloud-ruby/docs/latest" title="Ruby docs page">
<img src="../../../_static/images/icon-lang-ruby.svg" alt="Ruby icon" class="menu-icon" />
Ruby
</a>
</li>
<li>
<a href="#" title="Python docs page">
<img src="../../../_static/images/icon-lang-python.svg" alt="Python icon" class="menu-icon" />
Python
</a>
</li>
</ul>
</nav><!-- end of .main-nav -->
<a href="https://github.com/GoogleCloudPlatform/gcloud-python/issues/new?title=%5BDocumentation+Issue%5D+&body=Page+Name%3A+_modules/gcloud/datastore/batch%0ARelease%3A%20777c6ac" target="_blank" class="v-btn" id="file-issue">
<img src="_static/images/icon-link-github.svg" />
Report an Issue
</a>
</header><!-- end of .page-header -->
<article class="main lang-page" role="main">
<header class="docs-header">
<h1 class="page-title">Python</h1>
<div class="versions">
<a href="/gcloud-python/versions.html" class="v-btn">
<img src="_static/images/icon-arrow-bullet.svg" />
Version History (777c6ac)
</a>
</div><!-- end of .versions -->
<div>
<a href="https://github.com/GoogleCloudPlatform/gcloud-python/issues/new?title=%5BDocumentation+Issue%5D+" target="_blank" class="v-btn" id="file-issue-secondary">
<img src="_static/images/icon-link-github.svg" />
Report an Issue
</a>
</div>
</header>
<section class="content">
<h1>Source code for gcloud.datastore.batch</h1><div class="highlight"><pre>
<span class="c"># Copyright 2014 Google Inc. All rights reserved.</span>
<span class="c">#</span>
<span class="c"># Licensed under the Apache License, Version 2.0 (the "License");</span>
<span class="c"># you may not use this file except in compliance with the License.</span>
<span class="c"># You may obtain a copy of the License at</span>
<span class="c">#</span>
<span class="c"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c">#</span>
<span class="c"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c"># distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="c"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c"># See the License for the specific language governing permissions and</span>
<span class="c"># limitations under the License.</span>
<span class="sd">"""Create / interact with a batch of updates / deletes.</span>
<span class="sd">Batches provide the ability to execute multiple operations</span>
<span class="sd">in a single request to the Cloud Datastore API.</span>
<span class="sd">See</span>
<span class="sd">https://cloud.google.com/datastore/docs/concepts/entities#Datastore_Batch_operations</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">gcloud.datastore</span> <span class="kn">import</span> <span class="n">helpers</span>
<span class="kn">from</span> <span class="nn">gcloud.datastore.key</span> <span class="kn">import</span> <span class="n">_dataset_ids_equal</span>
<span class="kn">from</span> <span class="nn">gcloud.datastore</span> <span class="kn">import</span> <span class="n">_datastore_v1_pb2</span> <span class="k">as</span> <span class="n">datastore_pb</span>
<div class="viewcode-block" id="Batch"><a class="viewcode-back" href="../../../datastore-batches.html#gcloud.datastore.batch.Batch">[docs]</a><span class="k">class</span> <span class="nc">Batch</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""An abstraction representing a collected group of updates / deletes.</span>
<span class="sd"> Used to build up a bulk mutuation.</span>
<span class="sd"> For example, the following snippet of code will put the two ``save``</span>
<span class="sd"> operations and the delete operatiuon into the same mutation, and send</span>
<span class="sd"> them to the server in a single API request::</span>
<span class="sd"> >>> from gcloud.datastore.batch import Batch</span>
<span class="sd"> >>> batch = Batch()</span>
<span class="sd"> >>> batch.put(entity1)</span>
<span class="sd"> >>> batch.put(entity2)</span>
<span class="sd"> >>> batch.delete(key3)</span>
<span class="sd"> >>> batch.commit()</span>
<span class="sd"> You can also use a batch as a context manager, in which case the</span>
<span class="sd"> ``commit`` will be called automatically if its block exits without</span>
<span class="sd"> raising an exception::</span>
<span class="sd"> >>> with Batch() as batch:</span>
<span class="sd"> ... batch.put(entity1)</span>
<span class="sd"> ... batch.put(entity2)</span>
<span class="sd"> ... batch.delete(key3)</span>
<span class="sd"> By default, no updates will be sent if the block exits with an error::</span>
<span class="sd"> >>> with Batch() as batch:</span>
<span class="sd"> ... do_some_work(batch)</span>
<span class="sd"> ... raise Exception() # rolls back</span>
<span class="sd"> :type client: :class:`gcloud.datastore.client.Client`</span>
<span class="sd"> :param client: The client used to connect to datastore.</span>
<span class="sd"> """</span>
<span class="n">_id</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># "protected" attribute, always None for non-transactions</span>
<span class="k">def</span> <span class="nf">__init__</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="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_mutation</span> <span class="o">=</span> <span class="n">datastore_pb</span><span class="o">.</span><span class="n">Mutation</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auto_id_entities</span> <span class="o">=</span> <span class="p">[]</span>
<div class="viewcode-block" id="Batch.current"><a class="viewcode-back" href="../../../datastore-batches.html#gcloud.datastore.batch.Batch.current">[docs]</a> <span class="k">def</span> <span class="nf">current</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return the topmost batch / transaction, or None."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">current_batch</span>
</div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">dataset_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Getter for dataset ID in which the batch will run.</span>
<span class="sd"> :rtype: :class:`str`</span>
<span class="sd"> :returns: The dataset ID in which the batch will run.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">dataset_id</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">namespace</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Getter for namespace in which the batch will run.</span>
<span class="sd"> :rtype: :class:`str`</span>
<span class="sd"> :returns: The namespace in which the batch will run.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">namespace</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">connection</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Getter for connection over which the batch will run.</span>
<span class="sd"> :rtype: :class:`gcloud.datastore.connection.Connection`</span>
<span class="sd"> :returns: The connection over which the batch will run.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">connection</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">mutation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Getter for the current mutation.</span>
<span class="sd"> Every batch is committed with a single Mutation</span>
<span class="sd"> representing the 'work' to be done as part of the batch.</span>
<span class="sd"> Inside a batch, calling ``batch.put()`` with an entity, or</span>
<span class="sd"> ``batch.delete`` with a key, builds up the mutation.</span>
<span class="sd"> This getter returns the Mutation protobuf that</span>
<span class="sd"> has been built-up so far.</span>
<span class="sd"> :rtype: :class:`gcloud.datastore._datastore_v1_pb2.Mutation`</span>
<span class="sd"> :returns: The Mutation protobuf to be sent in the commit request.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_mutation</span>
<div class="viewcode-block" id="Batch.add_auto_id_entity"><a class="viewcode-back" href="../../../datastore-batches.html#gcloud.datastore.batch.Batch.add_auto_id_entity">[docs]</a> <span class="k">def</span> <span class="nf">add_auto_id_entity</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entity</span><span class="p">):</span>
<span class="sd">"""Adds an entity to the list of entities to update with IDs.</span>
<span class="sd"> When an entity has a partial key, calling ``save()`` adds an</span>
<span class="sd"> insert_auto_id entry in the mutation. In order to make sure we</span>
<span class="sd"> update the Entity once the transaction is committed, we need to</span>
<span class="sd"> keep track of which entities to update (and the order is</span>
<span class="sd"> important).</span>
<span class="sd"> When you call ``save()`` on an entity inside a transaction, if</span>
<span class="sd"> the entity has a partial key, it adds itself to the list of</span>
<span class="sd"> entities to be updated once the transaction is committed by</span>
<span class="sd"> calling this method.</span>
<span class="sd"> :type entity: :class:`gcloud.datastore.entity.Entity`</span>
<span class="sd"> :param entity: The entity to be updated with a completed key.</span>
<span class="sd"> :raises: ValueError if the entity's key is alread completed.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">entity</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">is_partial</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Entity has a completed key"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auto_id_entities</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Batch.put"><a class="viewcode-back" href="../../../datastore-batches.html#gcloud.datastore.batch.Batch.put">[docs]</a> <span class="k">def</span> <span class="nf">put</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entity</span><span class="p">):</span>
<span class="sd">"""Remember an entity's state to be saved during ``commit``.</span>
<span class="sd"> .. note::</span>
<span class="sd"> Any existing properties for the entity will be replaced by those</span>
<span class="sd"> currently set on this instance. Already-stored properties which do</span>
<span class="sd"> not correspond to keys set on this instance will be removed from</span>
<span class="sd"> the datastore.</span>
<span class="sd"> .. note::</span>
<span class="sd"> Property values which are "text" ('unicode' in Python2, 'str' in</span>
<span class="sd"> Python3) map to 'string_value' in the datastore; values which are</span>
<span class="sd"> "bytes" ('str' in Python2, 'bytes' in Python3) map to 'blob_value'.</span>
<span class="sd"> :type entity: :class:`gcloud.datastore.entity.Entity`</span>
<span class="sd"> :param entity: the entity to be saved.</span>
<span class="sd"> :raises: ValueError if entity has no key assigned, or if the key's</span>
<span class="sd"> ``dataset_id`` does not match ours.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">entity</span><span class="o">.</span><span class="n">key</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Entity must have a key"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_dataset_ids_equal</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dataset_id</span><span class="p">,</span> <span class="n">entity</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">dataset_id</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Key must be from same dataset as batch"</span><span class="p">)</span>
<span class="n">_assign_entity_to_mutation</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mutation</span><span class="p">,</span> <span class="n">entity</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_auto_id_entities</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Batch.delete"><a class="viewcode-back" href="../../../datastore-batches.html#gcloud.datastore.batch.Batch.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</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="sd">"""Remember a key to be deleted durring ``commit``.</span>
<span class="sd"> :type key: :class:`gcloud.datastore.key.Key`</span>
<span class="sd"> :param key: the key to be deleted.</span>
<span class="sd"> :raises: ValueError if key is not complete, or if the key's</span>
<span class="sd"> ``dataset_id`` does not match ours.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">is_partial</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Key must be complete"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_dataset_ids_equal</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dataset_id</span><span class="p">,</span> <span class="n">key</span><span class="o">.</span><span class="n">dataset_id</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Key must be from same dataset as batch"</span><span class="p">)</span>
<span class="n">key_pb</span> <span class="o">=</span> <span class="n">helpers</span><span class="o">.</span><span class="n">_prepare_key_for_request</span><span class="p">(</span><span class="n">key</span><span class="o">.</span><span class="n">to_protobuf</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mutation</span><span class="o">.</span><span class="n">delete</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">key_pb</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Batch.begin"><a class="viewcode-back" href="../../../datastore-batches.html#gcloud.datastore.batch.Batch.begin">[docs]</a> <span class="k">def</span> <span class="nf">begin</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""No-op</span>
<span class="sd"> Overridden by :class:`gcloud.datastore.transaction.Transaction`.</span>
<span class="sd"> """</span>
<span class="k">pass</span>
</div>
<div class="viewcode-block" id="Batch.commit"><a class="viewcode-back" href="../../../datastore-batches.html#gcloud.datastore.batch.Batch.commit">[docs]</a> <span class="k">def</span> <span class="nf">commit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Commits the batch.</span>
<span class="sd"> This is called automatically upon exiting a with statement,</span>
<span class="sd"> however it can be called explicitly if you don't want to use a</span>
<span class="sd"> context manager.</span>
<span class="sd"> """</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">commit</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dataset_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">mutation</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id</span><span class="p">)</span>
<span class="c"># If the back-end returns without error, we are guaranteed that</span>
<span class="c"># the response's 'insert_auto_id_key' will match (length and order)</span>
<span class="c"># the request's 'insert_auto_id` entities, which are derived from</span>
<span class="c"># our '_auto_id_entities' (no partial success).</span>
<span class="k">for</span> <span class="n">new_key_pb</span><span class="p">,</span> <span class="n">entity</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">insert_auto_id_key</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auto_id_entities</span><span class="p">):</span>
<span class="n">new_id</span> <span class="o">=</span> <span class="n">new_key_pb</span><span class="o">.</span><span class="n">path_element</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">id</span>
<span class="n">entity</span><span class="o">.</span><span class="n">key</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">completed_key</span><span class="p">(</span><span class="n">new_id</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Batch.rollback"><a class="viewcode-back" href="../../../datastore-batches.html#gcloud.datastore.batch.Batch.rollback">[docs]</a> <span class="k">def</span> <span class="nf">rollback</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""No-op</span>
<span class="sd"> Overridden by :class:`gcloud.datastore.transaction.Transaction`.</span>
<span class="sd"> """</span>
<span class="k">pass</span>
</div>
<span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">_push_batch</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_val</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">exc_type</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rollback</span><span class="p">()</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">_pop_batch</span><span class="p">()</span>
</div>
<span class="k">def</span> <span class="nf">_assign_entity_to_mutation</span><span class="p">(</span><span class="n">mutation_pb</span><span class="p">,</span> <span class="n">entity</span><span class="p">,</span> <span class="n">auto_id_entities</span><span class="p">):</span>
<span class="sd">"""Copy ``entity`` into appropriate slot of ``mutation_pb``.</span>
<span class="sd"> If ``entity.key`` is incomplete, append ``entity`` to ``auto_id_entities``</span>
<span class="sd"> for later fixup during ``commit``.</span>
<span class="sd"> Helper method for ``Batch.put``.</span>
<span class="sd"> :type mutation_pb: :class:`gcloud.datastore._datastore_v1_pb2.Mutation`</span>
<span class="sd"> :param mutation_pb: The Mutation protobuf for the batch / transaction.</span>
<span class="sd"> :type entity: :class:`gcloud.datastore.entity.Entity`</span>
<span class="sd"> :param entity: The entity being updated within the batch / transaction.</span>
<span class="sd"> :type auto_id_entities: list of :class:`gcloud.datastore.entity.Entity`</span>
<span class="sd"> :param auto_id_entities: Entities with partial keys, to be fixed up</span>
<span class="sd"> during commit.</span>
<span class="sd"> """</span>
<span class="n">auto_id</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">is_partial</span>
<span class="n">key_pb</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">to_protobuf</span><span class="p">()</span>
<span class="n">key_pb</span> <span class="o">=</span> <span class="n">helpers</span><span class="o">.</span><span class="n">_prepare_key_for_request</span><span class="p">(</span><span class="n">key_pb</span><span class="p">)</span>
<span class="k">if</span> <span class="n">auto_id</span><span class="p">:</span>
<span class="n">insert</span> <span class="o">=</span> <span class="n">mutation_pb</span><span class="o">.</span><span class="n">insert_auto_id</span><span class="o">.</span><span class="n">add</span><span class="p">()</span>
<span class="n">auto_id_entities</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># We use ``upsert`` for entities with completed keys, rather than</span>
<span class="c"># ``insert`` or ``update``, in order not to create race conditions</span>
<span class="c"># based on prior existence / removal of the entity.</span>
<span class="n">insert</span> <span class="o">=</span> <span class="n">mutation_pb</span><span class="o">.</span><span class="n">upsert</span><span class="o">.</span><span class="n">add</span><span class="p">()</span>
<span class="n">insert</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">CopyFrom</span><span class="p">(</span><span class="n">key_pb</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">entity</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">value_is_list</span> <span class="o">=</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span>
<span class="k">if</span> <span class="n">value_is_list</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">prop</span> <span class="o">=</span> <span class="n">insert</span><span class="o">.</span><span class="n">property</span><span class="o">.</span><span class="n">add</span><span class="p">()</span>
<span class="c"># Set the name of the property.</span>
<span class="n">prop</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="c"># Set the appropriate value.</span>
<span class="n">helpers</span><span class="o">.</span><span class="n">_set_protobuf_value</span><span class="p">(</span><span class="n">prop</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">entity</span><span class="o">.</span><span class="n">exclude_from_indexes</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">value_is_list</span><span class="p">:</span>
<span class="n">prop</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">indexed</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">for</span> <span class="n">sub_value</span> <span class="ow">in</span> <span class="n">prop</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">list_value</span><span class="p">:</span>
<span class="n">sub_value</span><span class="o">.</span><span class="n">indexed</span> <span class="o">=</span> <span class="bp">False</span>
</pre></div>
</section><!-- end of .content -->
<nav class="side-nav">
<ul><li><a href="../../../index.html">gcloud</a></li></ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../gcloud-api.html">GCloud Package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../datastore-overview.html">Datastore</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../datastore-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../datastore-entities.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../datastore-keys.html">Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../datastore-queries.html">Queries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../datastore-transactions.html">Transactions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../datastore-batches.html">Batches</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../storage-api.html">Storage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../storage-blobs.html">Blobs / Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../storage-buckets.html">Buckets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../storage-acl.html">ACL</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pubsub-api.html">Pub/Sub</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pubsub-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pubsub-topic.html">Topics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pubsub-subscription.html">Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigquery-usage.html">BigQuery</a></li>
</ul>
<ul class="external-links">
<li>
<a href="https://github.com/GoogleCloudPlatform/gcloud-python/" title="Python on Github">
<img src="../../../_static/images/icon-link-github.svg" alt="Github icon" />
Github
</a>
</li>
<li>
<a href="https://github.com/GoogleCloudPlatform/gcloud-python/issues" title="Python issues on Github">
<img src="../../../_static/images/icon-link-github.svg" alt="Github icon" />
Issues
</a>
</li>
<li>
<a href="http://stackoverflow.com/questions/tagged/gcloud-python" title="gcloud on StackOverflow">
<img src="../../../_static/images/icon-link-stackoverflow.svg" alt="StackOverflow icon" />
gcloud
</a>
</li>
<li>
<a href="https://pypi.python.org/pypi/gcloud" title="Python package manager">
<img src="../../../_static/images/icon-link-package-manager.svg" alt="Package Manager icon" />
Package Manager
</a>
</li>
</ul>
</nav><!-- end of .side-nav -->
</article><!-- end of .main -->
<script src="../../../_static/js/vendor/jquery-1.10.2.min.js"></script>
<script src="../../../_static/js/plugins.js"></script>
<script src="../../../_static/js/main.js"></script>
</body>
</html>