-
Notifications
You must be signed in to change notification settings - Fork 544
/
sample.rb
681 lines (553 loc) · 17.7 KB
/
sample.rb
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
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require "google/cloud/datastore"
def incomplete_key
datastore = Google::Cloud::Datastore.new
# [START datastore_incomplete_key]
task_key = datastore.key "Task"
# [END datastore_incomplete_key]
end
def named_key task_name:
datastore = Google::Cloud::Datastore.new
# [START datastore_named_key]
# task_name = "sampleTask"
task_key = datastore.key "Task", task_name
# [END datastore_named_key]
end
def key_with_parent task_list_name:, task_name:
datastore = Google::Cloud::Datastore.new
# [START datastore_key_with_parent]
# task_list_name = "default"
# task_name = "sampleTask"
task_key = datastore.key [["TaskList", task_list_name], ["Task", task_name]]
# [END datastore_key_with_parent]
task_key
end
def key_with_multilevel_parent user_name:, task_list_name:, task_name:
datastore = Google::Cloud::Datastore.new
# [START datastore_key_with_multilevel_parent]
# user_name = "alice"
# task_list_name = "default"
# task_name = "sampleTask"
task_key = datastore.key([
["User", user_name],
["TaskList", task_list_name],
["Task", task_name]
])
# [END datastore_key_with_multilevel_parent]
task_key
end
def entity_with_parent task_list_name:, task_name:
datastore = Google::Cloud::Datastore.new
# [START datastore_entity_with_parent]
# task_list_name = "default"
# task_name = "sampleTask"
task_key = datastore.key [["TaskList", task_list_name], ["Task", task_name]]
task = datastore.entity task_key do |t|
t["category"] = "Personal"
t["done"] = false
t["priority"] = 4
t["description"] = "Learn Cloud Datastore"
end
# [END datastore_entity_with_parent]
task
end
def properties
datastore = Google::Cloud::Datastore.new
# [START datastore_properties]
task = datastore.entity "Task" do |t|
t["category"] = "Personal"
t["created"] = Time.now
t["done"] = false
t["priority"] = 4
t["percent_complete"] = 10.0
t["description"] = "Learn Cloud Datastore"
t.exclude_from_indexes! "description", true
end
# [END datastore_properties]
task
end
def array_value task_name:
datastore = Google::Cloud::Datastore.new
# [START datastore_array_value]
# task_name = "sampleTask"
task = datastore.entity "Task", task_name do |t|
t["tags"] = ["fun", "programming"]
t["collaborators"] = ["alice", "bob"]
end
# [END datastore_array_value]
end
def basic_entity
datastore = Google::Cloud::Datastore.new
# [START datastore_basic_entity]
task = datastore.entity "Task" do |t|
t["category"] = "Personal"
t["done"] = false
t["priority"] = 4
t["description"] = "Learn Cloud Datastore"
end
# [END datastore_basic_entity]
task
end
def upsert task_name:
datastore = Google::Cloud::Datastore.new
# [START datastore_upsert]
# task_name = "sampleTask"
task = datastore.entity "Task", task_name do |t|
t["category"] = "Personal"
t["done"] = false
t["priority"] = 4
t["description"] = "Learn Cloud Datastore"
end
datastore.save task
# [END datastore_upsert]
task
end
def insert
task = nil
datastore = Google::Cloud::Datastore.new
# [START datastore_insert]
datastore.transaction do |_tx|
task = datastore.entity "Task" do |t|
t["category"] = "Personal"
t["done"] = false
t["priority"] = 4
t["description"] = "Learn Cloud Datastore"
end
datastore.save task
end
# [END datastore_insert]
task
end
def lookup task_name:
datastore = Google::Cloud::Datastore.new
# [START datastore_lookup]
# task_name = "sampleTask"
task_key = datastore.key "Task", task_name
task = datastore.find task_key
# [END datastore_lookup]
task
end
def update task_name:
datastore = Google::Cloud::Datastore.new
task = datastore.entity "Task", task_name do |t|
t["category"] = "Personal"
t["done"] = false
t["priority"] = 4
t["description"] = "Learn Cloud Datastore"
end
datastore.save task
# [START datastore_update]
# task_name = "sampleTask"
datastore.transaction do |_tx|
task = datastore.find "Task", task_name
task["priority"] = 5
datastore.save task
end
# [END datastore_update]
task
end
def delete task_name:
datastore = Google::Cloud::Datastore.new
# [START datastore_delete]
# task_name = "sampleTask"
task_key = datastore.key "Task", task_name
datastore.delete task_key
# [END datastore_delete]
task_key
end
def batch_upsert
datastore = Google::Cloud::Datastore.new
# [START datastore_batch_upsert]
task_1 = datastore.entity "Task" do |t|
t["category"] = "Personal"
t["done"] = false
t["priority"] = 4
t["description"] = "Learn Cloud Datastore"
end
task_2 = datastore.entity "Task" do |t|
t["category"] = "Personal"
t["done"] = false
t["priority"] = 5
t["description"] = "Integrate Cloud Datastore"
end
tasks = datastore.save task_1, task_2
task_key_1 = tasks[0].key
task_key_2 = tasks[1].key
# [END datastore_batch_upsert]
[task_key_1, task_key_2]
end
def batch_lookup task_name_1:, task_name_2:
datastore = Google::Cloud::Datastore.new
# [START datastore_batch_lookup]
# task_name_1 = "sampleTask1"
# task_name_2 = "sampleTask2"
task_key_1 = datastore.key "Task", task_name_1
task_key_2 = datastore.key "Task", task_name_2
tasks = datastore.find_all task_key_1, task_key_2
# [END datastore_batch_lookup]
end
def batch_delete task_name_1:, task_name_2:
datastore = Google::Cloud::Datastore.new
# [START datastore_batch_delete]
# task_name_1 = "sampleTask1"
# task_name_2 = "sampleTask2"
task_key_1 = datastore.key "Task", task_name_1
task_key_2 = datastore.key "Task", task_name_2
datastore.delete task_key_1, task_key_2
# [END datastore_batch_delete]
[task_key_1, task_key_2]
end
def basic_query
datastore = Google::Cloud::Datastore.new
# [START datastore_basic_query]
query = datastore.query("Task")
.where("done", "=", false)
.where("priority", ">=", 4)
.order("priority", :desc)
# [END datastore_basic_query]
# [START datastore_run_query]
tasks = datastore.run query
# [END datastore_run_query]
end
def property_filter
datastore = Google::Cloud::Datastore.new
# [START datastore_property_filter]
query = datastore.query("Task")
.where("done", "=", false)
# [END datastore_property_filter]
end
def composite_filter
datastore = Google::Cloud::Datastore.new
# [START datastore_composite_filter]
query = datastore.query("Task")
.where("done", "=", false)
.where("priority", "=", 4)
# [END datastore_composite_filter]
end
def key_filter
datastore = Google::Cloud::Datastore.new
# [START datastore_key_filter]
query = datastore.query("Task")
.where("__key__", ">", datastore.key("Task", "someTask"))
# [END datastore_key_filter]
end
def ascending_sort
datastore = Google::Cloud::Datastore.new
# [START datastore_ascending_sort]
query = datastore.query("Task")
.order("created", :asc)
# [END datastore_ascending_sort]
end
def descending_sort
datastore = Google::Cloud::Datastore.new
# [START datastore_descending_sort]
query = datastore.query("Task")
.order("created", :desc)
# [END datastore_descending_sort]
end
def multi_sort
datastore = Google::Cloud::Datastore.new
# [START datastore_multi_sort]
query = datastore.query("Task")
.order("priority", :desc)
.order("created", :asc)
# [END datastore_multi_sort]
end
def kindless_query
datastore = Google::Cloud::Datastore.new
last_seen_key = datastore.key "Task", "a"
# [START datastore_kindless_query]
query = Google::Cloud::Datastore::Query.new
query.where "__key__", ">", last_seen_key
# [END datastore_kindless_query]
query
end
def ancestor_query task_list_name:
datastore = Google::Cloud::Datastore.new
# [START datastore_ancestor_query]
# task_list_name = "default"
ancestor_key = datastore.key "TaskList", task_list_name
query = datastore.query("Task")
.ancestor(ancestor_key)
# [END datastore_ancestor_query]
end
def projection_query
datastore = Google::Cloud::Datastore.new
# [START datastore_projection_query]
query = datastore.query("Task")
.select("priority", "percent_complete")
# [END datastore_projection_query]
# [START datastore_run_query_projection]
priorities = []
percent_completes = []
datastore.run(query).each do |task|
priorities << task["priority"]
percent_completes << task["percent_complete"]
end
# [END datastore_run_query_projection]
[priorities, percent_completes]
end
def keys_only_query
datastore = Google::Cloud::Datastore.new
# [START datastore_keys_only_query]
query = datastore.query("Task")
.select("__key__")
# [END datastore_keys_only_query]
keys = datastore.run(query).map(&:key)
end
def distinct_on_query
datastore = Google::Cloud::Datastore.new
# [START datastore_distinct_on_query]
query = datastore.query("Task")
.select("category", "priority")
.distinct_on("category")
.order("category")
.order("priority")
# [END datastore_distinct_on_query]
end
def array_value_inequality_range
datastore = Google::Cloud::Datastore.new
# [START datastore_array_value_inequality_range]
query = datastore.query("Task")
.where("tag", ">", "learn")
.where("tag", "<", "math")
# [END datastore_array_value_inequality_range]
end
def array_value_equality
datastore = Google::Cloud::Datastore.new
# [START datastore_array_value_equality]
query = datastore.query("Task")
.where("tag", "=", "fun")
.where("tag", "=", "programming")
# [END datastore_array_value_equality]
end
def inequality_range
datastore = Google::Cloud::Datastore.new
# [START datastore_inequality_range]
query = datastore.query("Task")
.where("created", ">=", Time.utc(1990, 1, 1))
.where("created", "<", Time.utc(2000, 1, 1))
# [END datastore_inequality_range]
end
def inequality_invalid
datastore = Google::Cloud::Datastore.new
# [START datastore_inequality_invalid]
query = datastore.query("Task")
.where("created", ">=", Time.utc(1990, 1, 1))
.where("priority", ">", 3)
# [END datastore_inequality_invalid]
end
def equal_and_inequality_range
datastore = Google::Cloud::Datastore.new
# [START datastore_equal_and_inequality_range]
query = datastore.query("Task")
.where("done", "=", false)
.where("priority", "=", 4)
.where("created", ">=", Time.utc(1990, 1, 1))
.where("created", "<", Time.utc(2000, 1, 1))
# [END datastore_equal_and_inequality_range]
end
def inequality_sort
datastore = Google::Cloud::Datastore.new
# [START datastore_inequality_sort]
query = datastore.query("Task")
.where("priority", ">", 3)
.order("priority")
.order("created")
# [END datastore_inequality_sort]
end
def inequality_sort_invalid_not_same
datastore = Google::Cloud::Datastore.new
# [START datastore_inequality_sort_invalid_not_same]
query = datastore.query("Task")
.where("priority", ">", 3)
.order("created")
# [END datastore_inequality_sort_invalid_not_same]
end
def inequality_sort_invalid_not_first
datastore = Google::Cloud::Datastore.new
# [START datastore_inequality_sort_invalid_not_first]
query = datastore.query("Task")
.where("priority", ">", 3)
.order("created")
.order("priority")
# [END datastore_inequality_sort_invalid_not_first]
end
def limit
datastore = Google::Cloud::Datastore.new
# [START datastore_limit]
query = datastore.query("Task")
.limit(5)
# [END datastore_limit]
end
def cursor_paging
datastore = Google::Cloud::Datastore.new
# [START datastore_cursor_paging]
page_size = 2
query = datastore.query("Task")
.limit(page_size)
tasks = datastore.run query
page_cursor = tasks.cursor
query = datastore.query("Task")
.limit(page_size)
.start(page_cursor)
# [END datastore_cursor_paging]
end
def eventual_consistent_query task_list_name:
# [START datastore_eventual_consistent_query]
# task_list_name = "default"
ancestor_key = datastore.key "TaskList", task_list_name
query = datastore.query("Task")
.ancestor(ancestor_key)
tasks = datastore.run query, consistency: :eventual
# [END datastore_eventual_consistent_query]
tasks
end
def unindexed_property_query
datastore = Google::Cloud::Datastore.new
# [START datastore_unindexed_property_query]
query = datastore.query("Task")
.where("description", "=", "A task description.")
# [END datastore_unindexed_property_query]
end
def exploding_properties
datastore = Google::Cloud::Datastore.new
# [START datastore_exploding_properties]
task = datastore.entity "Task" do |t|
t["tags"] = ["fun", "programming", "learn"]
t["collaborators"] = ["alice", "bob", "charlie"]
t["created"] = Time.now
end
# [END datastore_exploding_properties]
end
# [START datastore_transactional_update]
def transfer_funds from_key, to_key, amount
datastore.transaction do |tx|
from = tx.find from_key
from["balance"] -= amount
to = tx.find to_key
to["balance"] += amount
tx.save from, to
end
end
# [END datastore_transactional_update]
def transactional_retry from_key, to_key, amount
# [START datastore_transactional_retry]
(1..5).each do |i|
begin
return transfer_funds from_key, to_key, amount
rescue Google::Cloud::Error => e
raise e if i == 5
end
end
# [END datastore_transactional_retry]
end
def transactional_get_or_create task_key
# [START datastore_transactional_get_or_create]
task = nil
datastore.transaction do |tx|
task = tx.find task_key
if task.nil?
task = datastore.entity task_key do |t|
t["category"] = "Personal"
t["done"] = false
t["priority"] = 4
t["description"] = "Learn Cloud Datastore"
end
tx.save task
end
end
# [END datastore_transactional_get_or_create]
task
end
def transactional_single_entity_group_read_only task_list_name:
tasks_in_list = nil
# [START datastore_transactional_single_entity_group_read_only]
# task_list_name = "default"
task_list_key = datastore.key "TaskList", task_list_name
datastore.read_only_transaction do |tx|
task_list = tx.find task_list_key
query = datastore.query("Task").ancestor(task_list)
tasks_in_list = tx.run query
end
# [END datastore_transactional_single_entity_group_read_only]
tasks_in_list
end
def namespace_run_query
datastore = Google::Cloud::Datastore.new
# [START datastore_namespace_run_query]
query = datastore.query("__namespace__")
.select("__key__")
.where("__key__", ">=", datastore.key("__namespace__", "g"))
.where("__key__", "<", datastore.key("__namespace__", "h"))
namespaces = datastore.run(query).map do |entity|
entity.key.name
end
# [END datastore_namespace_run_query]
end
def kind_run_query
datastore = Google::Cloud::Datastore.new
# [START datastore_kind_run_query]
query = datastore.query("__kind__")
.select("__key__")
kinds = datastore.run(query).map do |entity|
entity.key.name
end
# [END datastore_kind_run_query]
end
def property_run_query
datastore = Google::Cloud::Datastore.new
# [START datastore_property_run_query]
query = datastore.query("__property__")
.select("__key__")
entities = datastore.run query
properties_by_kind = entities.each_with_object({}) do |entity, memo|
kind = entity.key.parent.name
prop = entity.key.name
memo[kind] ||= []
memo[kind] << prop
end
# [END datastore_property_run_query]
end
def property_by_kind_run_query
datastore = Google::Cloud::Datastore.new
# [START datastore_property_by_kind_run_query]
ancestor_key = datastore.key "__kind__", "Task"
query = datastore.query("__property__")
.ancestor(ancestor_key)
entities = datastore.run query
representations = entities.each_with_object({}) do |entity, memo|
property_name = entity.key.name
property_types = entity["property_representation"]
memo[property_name] = property_types
end
# [END datastore_property_by_kind_run_query]
end
def property_filtering_run_query
datastore = Google::Cloud::Datastore.new
# [START datastore_property_filtering_run_query]
start_key = datastore.key [["__kind__", "Task"], ["__property__", "priority"]]
query = datastore.query("__property__")
.select("__key__")
.where("__key__", ">=", start_key)
entities = datastore.run query
properties_by_kind = entities.each_with_object({}) do |entity, memo|
kind = entity.key.parent.name
prop = entity.key.name
memo[kind] ||= []
memo[kind] << prop
end
# [END datastore_property_filtering_run_query]
end