forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquery.html
More file actions
772 lines (641 loc) · 68.6 KB
/
Copy pathquery.html
File metadata and controls
772 lines (641 loc) · 68.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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
<!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.query — gcloud 0.18.0 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" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.18.0',
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 0.18.0 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="http://googlecloudplatform.github.io/google-cloud-dotnet" title=".NET docs page">
<img src="../../../_static/images/icon-lang-dotnet.svg" alt=".NET icon" class="menu-icon" />
.NET
</a>
</li>
<li>
<a href="
https://googlecloudplatform.github.io/gcloud-java/" title="gcloud-java page">
<img src="../../../_static/images/icon-lang-java-duke.svg" alt="Duke icon" class="menu-icon" />
Java
</a>
</li>
<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="
https://googlecloudplatform.github.io/gcloud-php/" title="PHP docs page">
<img src="../../../_static/images/icon-lang-php.svg" alt="PHP icon" class="menu-icon" />
PHP
</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>
<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>
</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/query%0ARelease%3A%200.18.0" 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">
<div class="versions">
<a href="/gcloud-python/versions.html" class="v-btn">
<img src="_static/images/icon-arrow-bullet.svg" />
Version History (0.18.0)
</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.query</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright 2014 Google Inc. All rights reserved.</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
<span class="c1"># you may not use this file except in compliance with the License.</span>
<span class="c1"># 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="sd">"""Create / interact with gcloud datastore queries."""</span>
<span class="kn">import</span> <span class="nn">base64</span>
<span class="kn">from</span> <span class="nn">gcloud._helpers</span> <span class="k">import</span> <span class="n">_ensure_tuple_or_list</span>
<span class="kn">from</span> <span class="nn">gcloud.datastore._generated</span> <span class="k">import</span> <span class="n">query_pb2</span> <span class="k">as</span> <span class="n">_query_pb2</span>
<span class="kn">from</span> <span class="nn">gcloud.datastore</span> <span class="k">import</span> <span class="n">helpers</span>
<span class="kn">from</span> <span class="nn">gcloud.datastore.key</span> <span class="k">import</span> <span class="n">Key</span>
<div class="viewcode-block" id="Query"><a class="viewcode-back" href="../../../datastore-queries.html#gcloud.datastore.query.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="sd">"""A Query against the Cloud Datastore.</span>
<span class="sd"> This class serves as an abstraction for creating a query over data</span>
<span class="sd"> stored in the Cloud Datastore.</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"> :type kind: string</span>
<span class="sd"> :param kind: The kind to query.</span>
<span class="sd"> :type project: string</span>
<span class="sd"> :param project: The project associated with the query. If not passed,</span>
<span class="sd"> uses the client's value.</span>
<span class="sd"> :type namespace: string or None</span>
<span class="sd"> :param namespace: The namespace to which to restrict results. If not</span>
<span class="sd"> passed, uses the client's value.</span>
<span class="sd"> :type ancestor: :class:`gcloud.datastore.key.Key` or None</span>
<span class="sd"> :param ancestor: key of the ancestor to which this query's results are</span>
<span class="sd"> restricted.</span>
<span class="sd"> :type filters: sequence of (property_name, operator, value) tuples</span>
<span class="sd"> :param filters: property filters applied by this query.</span>
<span class="sd"> :type projection: sequence of string</span>
<span class="sd"> :param projection: fields returned as part of query results.</span>
<span class="sd"> :type order: sequence of string</span>
<span class="sd"> :param order: field names used to order query results. Prepend '-'</span>
<span class="sd"> to a field name to sort it in descending order.</span>
<span class="sd"> :type distinct_on: sequence of string</span>
<span class="sd"> :param distinct_on: field names used to group query results.</span>
<span class="sd"> :raises: ValueError if ``project`` is not passed and no implicit</span>
<span class="sd"> default is set.</span>
<span class="sd"> """</span>
<span class="n">OPERATORS</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'<='</span><span class="p">:</span> <span class="n">_query_pb2</span><span class="o">.</span><span class="n">PropertyFilter</span><span class="o">.</span><span class="n">LESS_THAN_OR_EQUAL</span><span class="p">,</span>
<span class="s1">'>='</span><span class="p">:</span> <span class="n">_query_pb2</span><span class="o">.</span><span class="n">PropertyFilter</span><span class="o">.</span><span class="n">GREATER_THAN_OR_EQUAL</span><span class="p">,</span>
<span class="s1">'<'</span><span class="p">:</span> <span class="n">_query_pb2</span><span class="o">.</span><span class="n">PropertyFilter</span><span class="o">.</span><span class="n">LESS_THAN</span><span class="p">,</span>
<span class="s1">'>'</span><span class="p">:</span> <span class="n">_query_pb2</span><span class="o">.</span><span class="n">PropertyFilter</span><span class="o">.</span><span class="n">GREATER_THAN</span><span class="p">,</span>
<span class="s1">'='</span><span class="p">:</span> <span class="n">_query_pb2</span><span class="o">.</span><span class="n">PropertyFilter</span><span class="o">.</span><span class="n">EQUAL</span><span class="p">,</span>
<span class="p">}</span>
<span class="sd">"""Mapping of operator strings and their protobuf equivalents."""</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="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="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">_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="ow">or</span> <span class="n">client</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="ow">or</span> <span class="n">client</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="p">[]</span>
<span class="c1"># Verify filters passed in.</span>
<span class="k">for</span> <span class="n">property_name</span><span class="p">,</span> <span class="n">operator</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">filters</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_filter</span><span class="p">(</span><span class="n">property_name</span><span class="p">,</span> <span class="n">operator</span><span class="p">,</span> <span class="n">value</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">_ensure_tuple_or_list</span><span class="p">(</span><span class="s1">'projection'</span><span class="p">,</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="o">=</span> <span class="n">_ensure_tuple_or_list</span><span class="p">(</span><span class="s1">'order'</span><span class="p">,</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="o">=</span> <span class="n">_ensure_tuple_or_list</span><span class="p">(</span><span class="s1">'distinct_on'</span><span class="p">,</span> <span class="n">distinct_on</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">project</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get the project for this Query.</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> :returns: The project for the query.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_project</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">project</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">"""This query's namespace</span>
<span class="sd"> :rtype: string or None</span>
<span class="sd"> :returns: the namespace assigned to this query</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_namespace</span> <span class="ow">or</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">@namespace</span><span class="o">.</span><span class="n">setter</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="n">value</span><span class="p">):</span>
<span class="sd">"""Update the query's namespace.</span>
<span class="sd"> :type value: string</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Namespace must be a string"</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="n">value</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">kind</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get the Kind of the Query.</span>
<span class="sd"> :rtype: string</span>
<span class="sd"> :returns: The kind for the query.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_kind</span>
<span class="nd">@kind</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">kind</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Update the Kind of the Query.</span>
<span class="sd"> :type value: string</span>
<span class="sd"> :param value: updated kind for the query.</span>
<span class="sd"> .. note::</span>
<span class="sd"> The protobuf specification allows for ``kind`` to be repeated,</span>
<span class="sd"> but the current implementation returns an error if more than</span>
<span class="sd"> one value is passed. If the back-end changes in the future to</span>
<span class="sd"> allow multiple values, this method will be updated to allow passing</span>
<span class="sd"> either a string or a sequence of strings.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"Kind must be a string"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_kind</span> <span class="o">=</span> <span class="n">value</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">ancestor</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The ancestor key for the query.</span>
<span class="sd"> :rtype: Key or None</span>
<span class="sd"> :returns: The ancestor for the query.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ancestor</span>
<span class="nd">@ancestor</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">ancestor</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Set the ancestor for the query</span>
<span class="sd"> :type value: Key</span>
<span class="sd"> :param value: the new ancestor key</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</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">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"Ancestor must be a Key"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_ancestor</span> <span class="o">=</span> <span class="n">value</span>
<span class="nd">@ancestor</span><span class="o">.</span><span class="n">deleter</span>
<span class="k">def</span> <span class="nf">ancestor</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Remove the ancestor for the query."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_ancestor</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">filters</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Filters set on the query.</span>
<span class="sd"> :rtype: sequence of (property_name, operator, value) tuples.</span>
<span class="sd"> :returns: The filters set on the query.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_filters</span><span class="p">[:]</span>
<div class="viewcode-block" id="Query.add_filter"><a class="viewcode-back" href="../../../datastore-queries.html#gcloud.datastore.query.Query.add_filter">[docs]</a> <span class="k">def</span> <span class="nf">add_filter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">property_name</span><span class="p">,</span> <span class="n">operator</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Filter the query based on a property name, operator and a value.</span>
<span class="sd"> Expressions take the form of::</span>
<span class="sd"> .add_filter('<property>', '<operator>', <value>)</span>
<span class="sd"> where property is a property stored on the entity in the datastore</span>
<span class="sd"> and operator is one of ``OPERATORS``</span>
<span class="sd"> (ie, ``=``, ``<``, ``<=``, ``>``, ``>=``)::</span>
<span class="sd"> >>> from gcloud import datastore</span>
<span class="sd"> >>> client = datastore.Client()</span>
<span class="sd"> >>> query = client.query(kind='Person')</span>
<span class="sd"> >>> query.add_filter('name', '=', 'James')</span>
<span class="sd"> >>> query.add_filter('age', '>', 50)</span>
<span class="sd"> :type property_name: string</span>
<span class="sd"> :param property_name: A property name.</span>
<span class="sd"> :type operator: string</span>
<span class="sd"> :param operator: One of ``=``, ``<``, ``<=``, ``>``, ``>=``.</span>
<span class="sd"> :type value: :class:`int`, :class:`str`, :class:`bool`,</span>
<span class="sd"> :class:`float`, :class:`NoneType`,</span>
<span class="sd"> :class:`datetime.datetime`,</span>
<span class="sd"> :class:`gcloud.datastore.key.Key`</span>
<span class="sd"> :param value: The value to filter on.</span>
<span class="sd"> :raises: :class:`ValueError` if ``operation`` is not one of the</span>
<span class="sd"> specified values, or if a filter names ``'__key__'`` but</span>
<span class="sd"> passes an invalid value (a key is required).</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">OPERATORS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">operator</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">error_message</span> <span class="o">=</span> <span class="s1">'Invalid expression: "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">operator</span><span class="p">,)</span>
<span class="n">choices_message</span> <span class="o">=</span> <span class="s1">'Please use one of: =, <, <=, >, >=.'</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_message</span><span class="p">,</span> <span class="n">choices_message</span><span class="p">)</span>
<span class="k">if</span> <span class="n">property_name</span> <span class="o">==</span> <span class="s1">'__key__'</span> <span class="ow">and</span> <span class="ow">not</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">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Invalid key: "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="n">value</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_filters</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">property_name</span><span class="p">,</span> <span class="n">operator</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">projection</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Fields names returned by the query.</span>
<span class="sd"> :rtype: sequence of string</span>
<span class="sd"> :returns: Names of fields in query results.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_projection</span><span class="p">[:]</span>
<span class="nd">@projection</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">projection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">projection</span><span class="p">):</span>
<span class="sd">"""Set the fields returned the query.</span>
<span class="sd"> :type projection: string or sequence of strings</span>
<span class="sd"> :param projection: Each value is a string giving the name of a</span>
<span class="sd"> property to be included in the projection query.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">projection</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="n">projection</span> <span class="o">=</span> <span class="p">[</span><span class="n">projection</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="o">=</span> <span class="n">projection</span>
<div class="viewcode-block" id="Query.keys_only"><a class="viewcode-back" href="../../../datastore-queries.html#gcloud.datastore.query.Query.keys_only">[docs]</a> <span class="k">def</span> <span class="nf">keys_only</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Set the projection to include only keys."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_projection</span><span class="p">[:]</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'__key__'</span><span class="p">]</span></div>
<div class="viewcode-block" id="Query.key_filter"><a class="viewcode-back" href="../../../datastore-queries.html#gcloud.datastore.query.Query.key_filter">[docs]</a> <span class="k">def</span> <span class="nf">key_filter</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="n">operator</span><span class="o">=</span><span class="s1">'='</span><span class="p">):</span>
<span class="sd">"""Filter on a key.</span>
<span class="sd"> :type key: :class:`gcloud.datastore.key.Key`</span>
<span class="sd"> :param key: The key to filter on.</span>
<span class="sd"> :type operator: string</span>
<span class="sd"> :param operator: (Optional) One of ``=``, ``<``, ``<=``, ``>``, ``>=``.</span>
<span class="sd"> Defaults to ``=``.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_filter</span><span class="p">(</span><span class="s1">'__key__'</span><span class="p">,</span> <span class="n">operator</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">order</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Names of fields used to sort query results.</span>
<span class="sd"> :rtype: sequence of string</span>
<span class="sd"> :returns: The order(s) set on the query.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_order</span><span class="p">[:]</span>
<span class="nd">@order</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">order</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Set the fields used to sort query results.</span>
<span class="sd"> Sort fields will be applied in the order specified.</span>
<span class="sd"> :type value: string or sequence of strings</span>
<span class="sd"> :param value: Each value is a string giving the name of the</span>
<span class="sd"> property on which to sort, optionally preceded by a</span>
<span class="sd"> hyphen (-) to specify descending order.</span>
<span class="sd"> Omitting the hyphen implies ascending order.</span>
<span class="sd"> """</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="nb">str</span><span class="p">):</span>
<span class="n">value</span> <span class="o">=</span> <span class="p">[</span><span class="n">value</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="o">=</span> <span class="n">value</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">distinct_on</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Names of fields used to group query results.</span>
<span class="sd"> :rtype: sequence of string</span>
<span class="sd"> :returns: The "distinct on" fields set on the query.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_distinct_on</span><span class="p">[:]</span>
<span class="nd">@distinct_on</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">distinct_on</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Set fields used to group query results.</span>
<span class="sd"> :type value: string or sequence of strings</span>
<span class="sd"> :param value: Each value is a string giving the name of a</span>
<span class="sd"> property to use to group results together.</span>
<span class="sd"> """</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="nb">str</span><span class="p">):</span>
<span class="n">value</span> <span class="o">=</span> <span class="p">[</span><span class="n">value</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="o">=</span> <span class="n">value</span>
<div class="viewcode-block" id="Query.fetch"><a class="viewcode-back" href="../../../datastore-queries.html#gcloud.datastore.query.Query.fetch">[docs]</a> <span class="k">def</span> <span class="nf">fetch</span><span class="p">(</span><span class="bp">self</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="n">offset</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">start_cursor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">end_cursor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Execute the Query; return an iterator for the matching entities.</span>
<span class="sd"> For example::</span>
<span class="sd"> >>> from gcloud import datastore</span>
<span class="sd"> >>> client = datastore.Client()</span>
<span class="sd"> >>> query = client.query(kind='Person')</span>
<span class="sd"> >>> query.add_filter('name', '=', 'Sally')</span>
<span class="sd"> >>> list(query.fetch())</span>
<span class="sd"> [<Entity object>, <Entity object>, ...]</span>
<span class="sd"> >>> list(query.fetch(1))</span>
<span class="sd"> [<Entity object>]</span>
<span class="sd"> :type limit: integer or None</span>
<span class="sd"> :param limit: An optional limit passed through to the iterator.</span>
<span class="sd"> :type offset: integer</span>
<span class="sd"> :param offset: An optional offset passed through to the iterator.</span>
<span class="sd"> :type start_cursor: bytes</span>
<span class="sd"> :param start_cursor: An optional cursor passed through to the iterator.</span>
<span class="sd"> :type end_cursor: bytes</span>
<span class="sd"> :param end_cursor: An optional cursor passed through to the iterator.</span>
<span class="sd"> :type client: :class:`gcloud.datastore.client.Client`</span>
<span class="sd"> :param client: client used to connect to datastore.</span>
<span class="sd"> If not supplied, uses the query's value.</span>
<span class="sd"> :rtype: :class:`Iterator`</span>
<span class="sd"> :returns: The iterator for the query.</span>
<span class="sd"> :raises: ValueError if ``connection`` is not passed and no implicit</span>
<span class="sd"> default has been set.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">client</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span>
<span class="k">return</span> <span class="n">Iterator</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="n">limit</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">start_cursor</span><span class="p">,</span> <span class="n">end_cursor</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="Iterator"><a class="viewcode-back" href="../../../datastore-queries.html#gcloud.datastore.query.Iterator">[docs]</a><span class="k">class</span> <span class="nc">Iterator</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Represent the state of a given execution of a Query.</span>
<span class="sd"> :type query: :class:`gcloud.datastore.query.Query`</span>
<span class="sd"> :param query: Query object holding permanent configuration (i.e.</span>
<span class="sd"> things that don't change on with each page in</span>
<span class="sd"> a results set).</span>
<span class="sd"> :type client: :class:`gcloud.datastore.client.Client`</span>
<span class="sd"> :param client: The client used to make a request.</span>
<span class="sd"> :type limit: integer</span>
<span class="sd"> :param limit: (Optional) Limit the number of results returned.</span>
<span class="sd"> :type offset: integer</span>
<span class="sd"> :param offset: (Optional) Offset used to begin a query.</span>
<span class="sd"> :type start_cursor: bytes</span>
<span class="sd"> :param start_cursor: (Optional) Cursor to begin paging through</span>
<span class="sd"> query results.</span>
<span class="sd"> :type end_cursor: bytes</span>
<span class="sd"> :param end_cursor: (Optional) Cursor to end paging through</span>
<span class="sd"> query results.</span>
<span class="sd"> """</span>
<span class="n">_NOT_FINISHED</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">_FINISHED</span> <span class="o">=</span> <span class="p">(</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="p">,</span>
<span class="n">_query_pb2</span><span class="o">.</span><span class="n">QueryResultBatch</span><span class="o">.</span><span class="n">MORE_RESULTS_AFTER_LIMIT</span><span class="p">,</span>
<span class="n">_query_pb2</span><span class="o">.</span><span class="n">QueryResultBatch</span><span class="o">.</span><span class="n">MORE_RESULTS_AFTER_CURSOR</span><span class="p">,</span>
<span class="p">)</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">query</span><span class="p">,</span> <span class="n">client</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="n">offset</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">start_cursor</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">end_cursor</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_query</span> <span class="o">=</span> <span class="n">query</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">_limit</span> <span class="o">=</span> <span class="n">limit</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_offset</span> <span class="o">=</span> <span class="n">offset</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_start_cursor</span> <span class="o">=</span> <span class="n">start_cursor</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_end_cursor</span> <span class="o">=</span> <span class="n">end_cursor</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_page</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_more_results</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_skipped_results</span> <span class="o">=</span> <span class="kc">None</span>
<div class="viewcode-block" id="Iterator.next_page"><a class="viewcode-back" href="../../../datastore-queries.html#gcloud.datastore.query.Iterator.next_page">[docs]</a> <span class="k">def</span> <span class="nf">next_page</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Fetch a single "page" of query results.</span>
<span class="sd"> Low-level API for fine control: the more convenient API is</span>
<span class="sd"> to iterate on the current Iterator.</span>
<span class="sd"> :rtype: tuple, (entities, more_results, cursor)</span>
<span class="sd"> :returns: The next page of results.</span>
<span class="sd"> """</span>
<span class="n">pb</span> <span class="o">=</span> <span class="n">_pb_from_query</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_query</span><span class="p">)</span>
<span class="n">start_cursor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_cursor</span>
<span class="k">if</span> <span class="n">start_cursor</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">pb</span><span class="o">.</span><span class="n">start_cursor</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">urlsafe_b64decode</span><span class="p">(</span><span class="n">start_cursor</span><span class="p">)</span>
<span class="n">end_cursor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_end_cursor</span>
<span class="k">if</span> <span class="n">end_cursor</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">pb</span><span class="o">.</span><span class="n">end_cursor</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">urlsafe_b64decode</span><span class="p">(</span><span class="n">end_cursor</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_limit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">pb</span><span class="o">.</span><span class="n">limit</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_limit</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_offset</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">pb</span><span class="o">.</span><span class="n">offset</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_offset</span>
<span class="n">transaction</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">current_transaction</span>
<span class="n">query_results</span> <span class="o">=</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="o">.</span><span class="n">run_query</span><span class="p">(</span>
<span class="n">query_pb</span><span class="o">=</span><span class="n">pb</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">_query</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">_query</span><span class="o">.</span><span class="n">namespace</span><span class="p">,</span>
<span class="n">transaction_id</span><span class="o">=</span><span class="n">transaction</span> <span class="ow">and</span> <span class="n">transaction</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">(</span><span class="n">entity_pbs</span><span class="p">,</span> <span class="n">cursor_as_bytes</span><span class="p">,</span>
<span class="n">more_results_enum</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skipped_results</span><span class="p">)</span> <span class="o">=</span> <span class="n">query_results</span>
<span class="k">if</span> <span class="n">cursor_as_bytes</span> <span class="o">==</span> <span class="n">b</span><span class="s1">''</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_start_cursor</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_start_cursor</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">urlsafe_b64encode</span><span class="p">(</span><span class="n">cursor_as_bytes</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_end_cursor</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">more_results_enum</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_NOT_FINISHED</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_more_results</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">elif</span> <span class="n">more_results_enum</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_FINISHED</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_more_results</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Unexpected value returned for `more_results`.'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_page</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">helpers</span><span class="o">.</span><span class="n">entity_from_protobuf</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span>
<span class="k">for</span> <span class="n">entity</span> <span class="ow">in</span> <span class="n">entity_pbs</span><span class="p">]</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_page</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_more_results</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_cursor</span></div>
<span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Generator yielding all results matching our query.</span>
<span class="sd"> :rtype: sequence of :class:`gcloud.datastore.entity.Entity`</span>
<span class="sd"> """</span>
<span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">next_page</span><span class="p">()</span>
<span class="k">for</span> <span class="n">entity</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_page</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">entity</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_more_results</span><span class="p">:</span>
<span class="k">break</span>
<span class="n">num_results</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_page</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_limit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_limit</span> <span class="o">-=</span> <span class="n">num_results</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_offset</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skipped_results</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># NOTE: The offset goes down relative to the location</span>
<span class="c1"># because we are updating the cursor each time.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_offset</span> <span class="o">-=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skipped_results</span></div>
<span class="k">def</span> <span class="nf">_pb_from_query</span><span class="p">(</span><span class="n">query</span><span class="p">):</span>
<span class="sd">"""Convert a Query instance to the corresponding protobuf.</span>
<span class="sd"> :type query: :class:`Query`</span>
<span class="sd"> :param query: The source query.</span>
<span class="sd"> :rtype: :class:`gcloud.datastore._generated.query_pb2.Query`</span>
<span class="sd"> :returns: A protobuf that can be sent to the protobuf API. N.b. that</span>
<span class="sd"> it does not contain "in-flight" fields for ongoing query</span>
<span class="sd"> executions (cursors, offset, limit).</span>
<span class="sd"> """</span>
<span class="n">pb</span> <span class="o">=</span> <span class="n">_query_pb2</span><span class="o">.</span><span class="n">Query</span><span class="p">()</span>
<span class="k">for</span> <span class="n">projection_name</span> <span class="ow">in</span> <span class="n">query</span><span class="o">.</span><span class="n">projection</span><span class="p">:</span>
<span class="n">pb</span><span class="o">.</span><span class="n">projection</span><span class="o">.</span><span class="n">add</span><span class="p">()</span><span class="o">.</span><span class="n">property</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">projection_name</span>
<span class="k">if</span> <span class="n">query</span><span class="o">.</span><span class="n">kind</span><span class="p">:</span>
<span class="n">pb</span><span class="o">.</span><span class="n">kind</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="n">query</span><span class="o">.</span><span class="n">kind</span>
<span class="n">composite_filter</span> <span class="o">=</span> <span class="n">pb</span><span class="o">.</span><span class="n">filter</span><span class="o">.</span><span class="n">composite_filter</span>
<span class="n">composite_filter</span><span class="o">.</span><span class="n">op</span> <span class="o">=</span> <span class="n">_query_pb2</span><span class="o">.</span><span class="n">CompositeFilter</span><span class="o">.</span><span class="n">AND</span>
<span class="k">if</span> <span class="n">query</span><span class="o">.</span><span class="n">ancestor</span><span class="p">:</span>
<span class="n">ancestor_pb</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">ancestor</span><span class="o">.</span><span class="n">to_protobuf</span><span class="p">()</span>
<span class="c1"># Filter on __key__ HAS_ANCESTOR == ancestor.</span>
<span class="n">ancestor_filter</span> <span class="o">=</span> <span class="n">composite_filter</span><span class="o">.</span><span class="n">filters</span><span class="o">.</span><span class="n">add</span><span class="p">()</span><span class="o">.</span><span class="n">property_filter</span>
<span class="n">ancestor_filter</span><span class="o">.</span><span class="n">property</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s1">'__key__'</span>
<span class="n">ancestor_filter</span><span class="o">.</span><span class="n">op</span> <span class="o">=</span> <span class="n">_query_pb2</span><span class="o">.</span><span class="n">PropertyFilter</span><span class="o">.</span><span class="n">HAS_ANCESTOR</span>
<span class="n">ancestor_filter</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">key_value</span><span class="o">.</span><span class="n">CopyFrom</span><span class="p">(</span><span class="n">ancestor_pb</span><span class="p">)</span>
<span class="k">for</span> <span class="n">property_name</span><span class="p">,</span> <span class="n">operator</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">query</span><span class="o">.</span><span class="n">filters</span><span class="p">:</span>
<span class="n">pb_op_enum</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">OPERATORS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">operator</span><span class="p">)</span>
<span class="c1"># Add the specific filter</span>
<span class="n">property_filter</span> <span class="o">=</span> <span class="n">composite_filter</span><span class="o">.</span><span class="n">filters</span><span class="o">.</span><span class="n">add</span><span class="p">()</span><span class="o">.</span><span class="n">property_filter</span>
<span class="n">property_filter</span><span class="o">.</span><span class="n">property</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">property_name</span>
<span class="n">property_filter</span><span class="o">.</span><span class="n">op</span> <span class="o">=</span> <span class="n">pb_op_enum</span>
<span class="c1"># Set the value to filter on based on the type.</span>
<span class="k">if</span> <span class="n">property_name</span> <span class="o">==</span> <span class="s1">'__key__'</span><span class="p">:</span>
<span class="n">key_pb</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">to_protobuf</span><span class="p">()</span>
<span class="n">property_filter</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">key_value</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">else</span><span class="p">:</span>
<span class="n">helpers</span><span class="o">.</span><span class="n">_set_protobuf_value</span><span class="p">(</span><span class="n">property_filter</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="ow">not</span> <span class="n">composite_filter</span><span class="o">.</span><span class="n">filters</span><span class="p">:</span>
<span class="n">pb</span><span class="o">.</span><span class="n">ClearField</span><span class="p">(</span><span class="s1">'filter'</span><span class="p">)</span>
<span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">query</span><span class="o">.</span><span class="n">order</span><span class="p">:</span>
<span class="n">property_order</span> <span class="o">=</span> <span class="n">pb</span><span class="o">.</span><span class="n">order</span><span class="o">.</span><span class="n">add</span><span class="p">()</span>
<span class="k">if</span> <span class="n">prop</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'-'</span><span class="p">):</span>
<span class="n">property_order</span><span class="o">.</span><span class="n">property</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">prop</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">property_order</span><span class="o">.</span><span class="n">direction</span> <span class="o">=</span> <span class="n">property_order</span><span class="o">.</span><span class="n">DESCENDING</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">property_order</span><span class="o">.</span><span class="n">property</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">prop</span>
<span class="n">property_order</span><span class="o">.</span><span class="n">direction</span> <span class="o">=</span> <span class="n">property_order</span><span class="o">.</span><span class="n">ASCENDING</span>
<span class="k">for</span> <span class="n">distinct_on_name</span> <span class="ow">in</span> <span class="n">query</span><span class="o">.</span><span class="n">distinct_on</span><span class="p">:</span>
<span class="n">pb</span><span class="o">.</span><span class="n">distinct_on</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="n">distinct_on_name</span>
<span class="k">return</span> <span class="n">pb</span>
</pre></div>
</section><!-- end of .content -->
<nav class="side-nav">
<p class="caption"><span class="caption-text">gcloud</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../gcloud-api.html">Shared Core Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../gcloud-config.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../gcloud-auth.html">Authentication</a></li>
</ul>
<p class="caption"><span class="caption-text">Datastore</span></p>
<ul>
<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="../../../datastore-helpers.html">Helpers</a></li>
</ul>
<p class="caption"><span class="caption-text">Storage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../storage-client.html">Client</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="../../../storage-batch.html">Batches</a></li>
</ul>
<p class="caption"><span class="caption-text">Pub/Sub</span></p>
<ul>
<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-client.html">Client</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="../../../pubsub-message.html">Message</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pubsub-iam.html">IAM Policy</a></li>
</ul>
<p class="caption"><span class="caption-text">BigQuery</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../bigquery-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigquery-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigquery-dataset.html">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigquery-job.html">Jobs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigquery-table.html">Tables</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigquery-query.html">Query</a></li>
</ul>
<p class="caption"><span class="caption-text">Cloud Bigtable</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../happybase-package.html">HappyBase</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-client-intro.html">Base for Everything</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-instance-api.html">Instance Admin API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-table-api.html">Table Admin API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-data-api.html">Data API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-instance.html">Instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-cluster.html">Cluster</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-table.html">Table</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-column-family.html">Column Families</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-row.html">Bigtable Row</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-row-filters.html">Bigtable Row Filters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bigtable-row-data.html">Row Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../happybase-connection.html">HappyBase Connection</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../happybase-pool.html">HappyBase Connection Pool</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../happybase-table.html">HappyBase Table</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../happybase-batch.html">HappyBase Batch</a></li>
</ul>
<p class="caption"><span class="caption-text">Resource Manager</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../resource-manager-api.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../resource-manager-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../resource-manager-project.html">Projects</a></li>
</ul>
<p class="caption"><span class="caption-text">DNS</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../dns-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dns-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dns-zone.html">Managed Zones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dns-resource-record-set.html">Resource Record Sets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dns-changes.html">Change Sets</a></li>
</ul>
<p class="caption"><span class="caption-text">Stackdriver Logging</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../logging-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../logging-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../logging-logger.html">Logger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../logging-entries.html">Entries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../logging-metric.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../logging-sink.html">Sinks</a></li>
</ul>
<p class="caption"><span class="caption-text">Stackdriver Error Reporting</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../error-reporting-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../error-reporting-client.html">Client</a></li>
</ul>
<p class="caption"><span class="caption-text">Stackdriver Monitoring</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../monitoring-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../monitoring-client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../monitoring-metric.html">Metric Descriptors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../monitoring-resource.html">Monitored Resource Descriptors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../monitoring-query.html">Time Series Query</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../monitoring-timeseries.html">Time Series</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../monitoring-label.html">Label Descriptors</a></li>
</ul>
<p class="caption"><span class="caption-text">Translate</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../translate-usage.html">Using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../translate-client.html">Client</a></li>
</ul>
<p class="caption"><span class="caption-text">External Links</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://github.com/GoogleCloudPlatform/gcloud-python/">GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/GoogleCloudPlatform/gcloud-python/issues">Issues</a></li>
<li class="toctree-l1"><a class="reference external" href="http://stackoverflow.com/questions/tagged/gcloud-python">Stack Overflow</a></li>
<li class="toctree-l1"><a class="reference external" href="https://pypi.python.org/pypi/gcloud">PyPI</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>