forked from apache/cassandra-python-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquery.html
More file actions
1163 lines (928 loc) · 128 KB
/
Copy pathquery.html
File metadata and controls
1163 lines (928 loc) · 128 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
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>cassandra.query — Cassandra Driver 3.13.0 documentation</title>
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '3.13.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for cassandra.query</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright DataStax, Inc.</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">"""</span>
<span class="sd">This module holds classes for working with prepared statements and</span>
<span class="sd">specifying consistency levels and retry policies for individual</span>
<span class="sd">queries.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">namedtuple</span>
<span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">struct</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">from</span> <span class="nn">six.moves</span> <span class="k">import</span> <span class="nb">range</span><span class="p">,</span> <span class="nb">zip</span>
<span class="kn">from</span> <span class="nn">cassandra</span> <span class="k">import</span> <span class="n">ConsistencyLevel</span><span class="p">,</span> <span class="n">OperationTimedOut</span>
<span class="kn">from</span> <span class="nn">cassandra.util</span> <span class="k">import</span> <span class="n">unix_time_from_uuid1</span>
<span class="kn">from</span> <span class="nn">cassandra.encoder</span> <span class="k">import</span> <span class="n">Encoder</span>
<span class="kn">import</span> <span class="nn">cassandra.encoder</span>
<span class="kn">from</span> <span class="nn">cassandra.protocol</span> <span class="k">import</span> <span class="n">_UNSET_VALUE</span>
<span class="kn">from</span> <span class="nn">cassandra.util</span> <span class="k">import</span> <span class="n">OrderedDict</span><span class="p">,</span> <span class="n">_sanitize_identifiers</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<span class="n">UNSET_VALUE</span> <span class="o">=</span> <span class="n">_UNSET_VALUE</span>
<span class="sd">"""</span>
<span class="sd">Specifies an unset value when binding a prepared statement.</span>
<span class="sd">Unset values are ignored, allowing prepared statements to be used without specify</span>
<span class="sd">See https://issues.apache.org/jira/browse/CASSANDRA-7304 for further details on semantics.</span>
<span class="sd">.. versionadded:: 2.6.0</span>
<span class="sd">Only valid when using native protocol v4+</span>
<span class="sd">"""</span>
<span class="n">NON_ALPHA_REGEX</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">'[^a-zA-Z0-9]'</span><span class="p">)</span>
<span class="n">START_BADCHAR_REGEX</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">'^[^a-zA-Z0-9]*'</span><span class="p">)</span>
<span class="n">END_BADCHAR_REGEX</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">'[^a-zA-Z0-9_]*$'</span><span class="p">)</span>
<span class="n">_clean_name_cache</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">def</span> <span class="nf">_clean_column_name</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_clean_name_cache</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="n">clean</span> <span class="o">=</span> <span class="n">NON_ALPHA_REGEX</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">"_"</span><span class="p">,</span> <span class="n">START_BADCHAR_REGEX</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">""</span><span class="p">,</span> <span class="n">END_BADCHAR_REGEX</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">""</span><span class="p">,</span> <span class="n">name</span><span class="p">)))</span>
<span class="n">_clean_name_cache</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">clean</span>
<span class="k">return</span> <span class="n">clean</span>
<div class="viewcode-block" id="tuple_factory"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.tuple_factory">[docs]</a><span class="k">def</span> <span class="nf">tuple_factory</span><span class="p">(</span><span class="n">colnames</span><span class="p">,</span> <span class="n">rows</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns each row as a tuple</span>
<span class="sd"> Example::</span>
<span class="sd"> >>> from cassandra.query import tuple_factory</span>
<span class="sd"> >>> session = cluster.connect('mykeyspace')</span>
<span class="sd"> >>> session.row_factory = tuple_factory</span>
<span class="sd"> >>> rows = session.execute("SELECT name, age FROM users LIMIT 1")</span>
<span class="sd"> >>> print rows[0]</span>
<span class="sd"> ('Bob', 42)</span>
<span class="sd"> .. versionchanged:: 2.0.0</span>
<span class="sd"> moved from ``cassandra.decoder`` to ``cassandra.query``</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">rows</span></div>
<div class="viewcode-block" id="named_tuple_factory"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.named_tuple_factory">[docs]</a><span class="k">def</span> <span class="nf">named_tuple_factory</span><span class="p">(</span><span class="n">colnames</span><span class="p">,</span> <span class="n">rows</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns each row as a `namedtuple <https://docs.python.org/2/library/collections.html#collections.namedtuple>`_.</span>
<span class="sd"> This is the default row factory.</span>
<span class="sd"> Example::</span>
<span class="sd"> >>> from cassandra.query import named_tuple_factory</span>
<span class="sd"> >>> session = cluster.connect('mykeyspace')</span>
<span class="sd"> >>> session.row_factory = named_tuple_factory</span>
<span class="sd"> >>> rows = session.execute("SELECT name, age FROM users LIMIT 1")</span>
<span class="sd"> >>> user = rows[0]</span>
<span class="sd"> >>> # you can access field by their name:</span>
<span class="sd"> >>> print "name: %s, age: %d" % (user.name, user.age)</span>
<span class="sd"> name: Bob, age: 42</span>
<span class="sd"> >>> # or you can access fields by their position (like a tuple)</span>
<span class="sd"> >>> name, age = user</span>
<span class="sd"> >>> print "name: %s, age: %d" % (name, age)</span>
<span class="sd"> name: Bob, age: 42</span>
<span class="sd"> >>> name = user[0]</span>
<span class="sd"> >>> age = user[1]</span>
<span class="sd"> >>> print "name: %s, age: %d" % (name, age)</span>
<span class="sd"> name: Bob, age: 42</span>
<span class="sd"> .. versionchanged:: 2.0.0</span>
<span class="sd"> moved from ``cassandra.decoder`` to ``cassandra.query``</span>
<span class="sd"> """</span>
<span class="n">clean_column_names</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="n">_clean_column_name</span><span class="p">,</span> <span class="n">colnames</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">Row</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span><span class="s1">'Row'</span><span class="p">,</span> <span class="n">clean_column_names</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="n">clean_column_names</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="n">_clean_column_name</span><span class="p">,</span> <span class="n">colnames</span><span class="p">))</span> <span class="c1"># create list because py3 map object will be consumed by first attempt</span>
<span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Failed creating named tuple for results with column names </span><span class="si">%s</span><span class="s2"> (cleaned: </span><span class="si">%s</span><span class="s2">) "</span>
<span class="s2">"(see Python 'namedtuple' documentation for details on name rules). "</span>
<span class="s2">"Results will be returned with positional names. "</span>
<span class="s2">"Avoid this by choosing different names, using SELECT </span><span class="se">\"</span><span class="s2"><col name></span><span class="se">\"</span><span class="s2"> AS aliases, "</span>
<span class="s2">"or specifying a different row_factory on your Session"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">colnames</span><span class="p">,</span> <span class="n">clean_column_names</span><span class="p">))</span>
<span class="n">Row</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span><span class="s1">'Row'</span><span class="p">,</span> <span class="n">_sanitize_identifiers</span><span class="p">(</span><span class="n">clean_column_names</span><span class="p">))</span>
<span class="k">return</span> <span class="p">[</span><span class="n">Row</span><span class="p">(</span><span class="o">*</span><span class="n">row</span><span class="p">)</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">rows</span><span class="p">]</span></div>
<div class="viewcode-block" id="dict_factory"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.dict_factory">[docs]</a><span class="k">def</span> <span class="nf">dict_factory</span><span class="p">(</span><span class="n">colnames</span><span class="p">,</span> <span class="n">rows</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns each row as a dict.</span>
<span class="sd"> Example::</span>
<span class="sd"> >>> from cassandra.query import dict_factory</span>
<span class="sd"> >>> session = cluster.connect('mykeyspace')</span>
<span class="sd"> >>> session.row_factory = dict_factory</span>
<span class="sd"> >>> rows = session.execute("SELECT name, age FROM users LIMIT 1")</span>
<span class="sd"> >>> print rows[0]</span>
<span class="sd"> {u'age': 42, u'name': u'Bob'}</span>
<span class="sd"> .. versionchanged:: 2.0.0</span>
<span class="sd"> moved from ``cassandra.decoder`` to ``cassandra.query``</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="p">[</span><span class="nb">dict</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">colnames</span><span class="p">,</span> <span class="n">row</span><span class="p">))</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">rows</span><span class="p">]</span></div>
<div class="viewcode-block" id="ordered_dict_factory"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.ordered_dict_factory">[docs]</a><span class="k">def</span> <span class="nf">ordered_dict_factory</span><span class="p">(</span><span class="n">colnames</span><span class="p">,</span> <span class="n">rows</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Like :meth:`~cassandra.query.dict_factory`, but returns each row as an OrderedDict,</span>
<span class="sd"> so the order of the columns is preserved.</span>
<span class="sd"> .. versionchanged:: 2.0.0</span>
<span class="sd"> moved from ``cassandra.decoder`` to ``cassandra.query``</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="p">[</span><span class="n">OrderedDict</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">colnames</span><span class="p">,</span> <span class="n">row</span><span class="p">))</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">rows</span><span class="p">]</span></div>
<span class="n">FETCH_SIZE_UNSET</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
<div class="viewcode-block" id="Statement"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.Statement">[docs]</a><span class="k">class</span> <span class="nc">Statement</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An abstract class representing a single query. There are three subclasses:</span>
<span class="sd"> :class:`.SimpleStatement`, :class:`.BoundStatement`, and :class:`.BatchStatement`.</span>
<span class="sd"> These can be passed to :meth:`.Session.execute()`.</span>
<span class="sd"> """</span>
<span class="n">retry_policy</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> An instance of a :class:`cassandra.policies.RetryPolicy` or one of its</span>
<span class="sd"> subclasses. This controls when a query will be retried and how it</span>
<span class="sd"> will be retried.</span>
<span class="sd"> """</span>
<span class="n">consistency_level</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The :class:`.ConsistencyLevel` to be used for this operation. Defaults</span>
<span class="sd"> to :const:`None`, which means that the default consistency level for</span>
<span class="sd"> the Session this is executed in will be used.</span>
<span class="sd"> """</span>
<span class="n">fetch_size</span> <span class="o">=</span> <span class="n">FETCH_SIZE_UNSET</span>
<span class="sd">"""</span>
<span class="sd"> How many rows will be fetched at a time. This overrides the default</span>
<span class="sd"> of :attr:`.Session.default_fetch_size`</span>
<span class="sd"> This only takes effect when protocol version 2 or higher is used.</span>
<span class="sd"> See :attr:`.Cluster.protocol_version` for details.</span>
<span class="sd"> .. versionadded:: 2.0.0</span>
<span class="sd"> """</span>
<span class="n">keyspace</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The string name of the keyspace this query acts on. This is used when</span>
<span class="sd"> :class:`~.TokenAwarePolicy` is configured for</span>
<span class="sd"> :attr:`.Cluster.load_balancing_policy`</span>
<span class="sd"> It is set implicitly on :class:`.BoundStatement`, and :class:`.BatchStatement`,</span>
<span class="sd"> but must be set explicitly on :class:`.SimpleStatement`.</span>
<span class="sd"> .. versionadded:: 2.1.3</span>
<span class="sd"> """</span>
<span class="n">custom_payload</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> :ref:`custom_payload` to be passed to the server.</span>
<span class="sd"> These are only allowed when using protocol version 4 or higher.</span>
<span class="sd"> .. versionadded:: 2.6.0</span>
<span class="sd"> """</span>
<span class="n">is_idempotent</span> <span class="o">=</span> <span class="kc">False</span>
<span class="sd">"""</span>
<span class="sd"> Flag indicating whether this statement is safe to run multiple times in speculative execution.</span>
<span class="sd"> """</span>
<span class="n">_serial_consistency_level</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_routing_key</span> <span class="o">=</span> <span class="kc">None</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">retry_policy</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">consistency_level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">routing_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">serial_consistency_level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">fetch_size</span><span class="o">=</span><span class="n">FETCH_SIZE_UNSET</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">custom_payload</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">is_idempotent</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="k">if</span> <span class="n">retry_policy</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">retry_policy</span><span class="p">,</span> <span class="s1">'on_read_timeout'</span><span class="p">):</span> <span class="c1"># just checking one method to detect positional parameter errors</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'retry_policy should implement cassandra.policies.RetryPolicy'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">retry_policy</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">retry_policy</span> <span class="o">=</span> <span class="n">retry_policy</span>
<span class="k">if</span> <span class="n">consistency_level</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">consistency_level</span> <span class="o">=</span> <span class="n">consistency_level</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_routing_key</span> <span class="o">=</span> <span class="n">routing_key</span>
<span class="k">if</span> <span class="n">serial_consistency_level</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">serial_consistency_level</span> <span class="o">=</span> <span class="n">serial_consistency_level</span>
<span class="k">if</span> <span class="n">fetch_size</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">FETCH_SIZE_UNSET</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fetch_size</span> <span class="o">=</span> <span class="n">fetch_size</span>
<span class="k">if</span> <span class="n">keyspace</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">keyspace</span> <span class="o">=</span> <span class="n">keyspace</span>
<span class="k">if</span> <span class="n">custom_payload</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">custom_payload</span> <span class="o">=</span> <span class="n">custom_payload</span>
<span class="bp">self</span><span class="o">.</span><span class="n">is_idempotent</span> <span class="o">=</span> <span class="n">is_idempotent</span>
<span class="k">def</span> <span class="nf">_key_parts_packed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parts</span><span class="p">):</span>
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">parts</span><span class="p">:</span>
<span class="n">l</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
<span class="k">yield</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s2">">H</span><span class="si">%d</span><span class="s2">sB"</span> <span class="o">%</span> <span class="n">l</span><span class="p">,</span> <span class="n">l</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_routing_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_routing_key</span>
<span class="k">def</span> <span class="nf">_set_routing_key</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="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_routing_key</span> <span class="o">=</span> <span class="n">key</span><span class="p">[</span><span class="mi">0</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">_routing_key</span> <span class="o">=</span> <span class="sa">b</span><span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_key_parts_packed</span><span class="p">(</span><span class="n">key</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">_routing_key</span> <span class="o">=</span> <span class="n">key</span>
<span class="k">def</span> <span class="nf">_del_routing_key</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">_routing_key</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">routing_key</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span>
<span class="n">_get_routing_key</span><span class="p">,</span>
<span class="n">_set_routing_key</span><span class="p">,</span>
<span class="n">_del_routing_key</span><span class="p">,</span>
<span class="sd">"""</span>
<span class="sd"> The :attr:`~.TableMetadata.partition_key` portion of the primary key,</span>
<span class="sd"> which can be used to determine which nodes are replicas for the query.</span>
<span class="sd"> If the partition key is a composite, a list or tuple must be passed in.</span>
<span class="sd"> Each key component should be in its packed (binary) format, so all</span>
<span class="sd"> components should be strings.</span>
<span class="sd"> """</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_serial_consistency_level</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_serial_consistency_level</span>
<span class="k">def</span> <span class="nf">_set_serial_consistency_level</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">serial_consistency_level</span><span class="p">):</span>
<span class="n">acceptable</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">SERIAL</span><span class="p">,</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">LOCAL_SERIAL</span><span class="p">)</span>
<span class="k">if</span> <span class="n">serial_consistency_level</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">acceptable</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"serial_consistency_level must be either ConsistencyLevel.SERIAL "</span>
<span class="s2">"or ConsistencyLevel.LOCAL_SERIAL"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_serial_consistency_level</span> <span class="o">=</span> <span class="n">serial_consistency_level</span>
<span class="k">def</span> <span class="nf">_del_serial_consistency_level</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">_serial_consistency_level</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">serial_consistency_level</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span>
<span class="n">_get_serial_consistency_level</span><span class="p">,</span>
<span class="n">_set_serial_consistency_level</span><span class="p">,</span>
<span class="n">_del_serial_consistency_level</span><span class="p">,</span>
<span class="sd">"""</span>
<span class="sd"> The serial consistency level is only used by conditional updates</span>
<span class="sd"> (``INSERT``, ``UPDATE`` and ``DELETE`` with an ``IF`` condition). For</span>
<span class="sd"> those, the ``serial_consistency_level`` defines the consistency level of</span>
<span class="sd"> the serial phase (or "paxos" phase) while the normal</span>
<span class="sd"> :attr:`~.consistency_level` defines the consistency for the "learn" phase,</span>
<span class="sd"> i.e. what type of reads will be guaranteed to see the update right away.</span>
<span class="sd"> For example, if a conditional write has a :attr:`~.consistency_level` of</span>
<span class="sd"> :attr:`~.ConsistencyLevel.QUORUM` (and is successful), then a</span>
<span class="sd"> :attr:`~.ConsistencyLevel.QUORUM` read is guaranteed to see that write.</span>
<span class="sd"> But if the regular :attr:`~.consistency_level` of that write is</span>
<span class="sd"> :attr:`~.ConsistencyLevel.ANY`, then only a read with a</span>
<span class="sd"> :attr:`~.consistency_level` of :attr:`~.ConsistencyLevel.SERIAL` is</span>
<span class="sd"> guaranteed to see it (even a read with consistency</span>
<span class="sd"> :attr:`~.ConsistencyLevel.ALL` is not guaranteed to be enough).</span>
<span class="sd"> The serial consistency can only be one of :attr:`~.ConsistencyLevel.SERIAL`</span>
<span class="sd"> or :attr:`~.ConsistencyLevel.LOCAL_SERIAL`. While ``SERIAL`` guarantees full</span>
<span class="sd"> linearizability (with other ``SERIAL`` updates), ``LOCAL_SERIAL`` only</span>
<span class="sd"> guarantees it in the local data center.</span>
<span class="sd"> The serial consistency level is ignored for any query that is not a</span>
<span class="sd"> conditional update. Serial reads should use the regular</span>
<span class="sd"> :attr:`consistency_level`.</span>
<span class="sd"> Serial consistency levels may only be used against Cassandra 2.0+</span>
<span class="sd"> and the :attr:`~.Cluster.protocol_version` must be set to 2 or higher.</span>
<span class="sd"> See :doc:`/lwt` for a discussion on how to work with results returned from</span>
<span class="sd"> conditional statements.</span>
<span class="sd"> .. versionadded:: 2.0.0</span>
<span class="sd"> """</span><span class="p">)</span></div>
<div class="viewcode-block" id="SimpleStatement"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.SimpleStatement">[docs]</a><span class="k">class</span> <span class="nc">SimpleStatement</span><span class="p">(</span><span class="n">Statement</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A simple, un-prepared query.</span>
<span class="sd"> """</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_string</span><span class="p">,</span> <span class="n">retry_policy</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">consistency_level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">routing_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">serial_consistency_level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">fetch_size</span><span class="o">=</span><span class="n">FETCH_SIZE_UNSET</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">custom_payload</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">is_idempotent</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> `query_string` should be a literal CQL statement with the exception</span>
<span class="sd"> of parameter placeholders that will be filled through the</span>
<span class="sd"> `parameters` argument of :meth:`.Session.execute()`.</span>
<span class="sd"> See :class:`Statement` attributes for a description of the other parameters.</span>
<span class="sd"> """</span>
<span class="n">Statement</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">retry_policy</span><span class="p">,</span> <span class="n">consistency_level</span><span class="p">,</span> <span class="n">routing_key</span><span class="p">,</span>
<span class="n">serial_consistency_level</span><span class="p">,</span> <span class="n">fetch_size</span><span class="p">,</span> <span class="n">keyspace</span><span class="p">,</span> <span class="n">custom_payload</span><span class="p">,</span> <span class="n">is_idempotent</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_query_string</span> <span class="o">=</span> <span class="n">query_string</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">query_string</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_query_string</span>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">consistency</span> <span class="o">=</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">value_to_name</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">consistency_level</span><span class="p">,</span> <span class="s1">'Not Set'</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="sa">u</span><span class="s1">'<SimpleStatement query="</span><span class="si">%s</span><span class="s1">", consistency=</span><span class="si">%s</span><span class="s1">>'</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">query_string</span><span class="p">,</span> <span class="n">consistency</span><span class="p">))</span>
<span class="fm">__repr__</span> <span class="o">=</span> <span class="fm">__str__</span></div>
<div class="viewcode-block" id="PreparedStatement"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.PreparedStatement">[docs]</a><span class="k">class</span> <span class="nc">PreparedStatement</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A statement that has been prepared against at least one Cassandra node.</span>
<span class="sd"> Instances of this class should not be created directly, but through</span>
<span class="sd"> :meth:`.Session.prepare()`.</span>
<span class="sd"> A :class:`.PreparedStatement` should be prepared only once. Re-preparing a statement</span>
<span class="sd"> may affect performance (as the operation requires a network roundtrip).</span>
<span class="sd"> |prepared_stmt_head|: Do not use ``*`` in prepared statements if you might</span>
<span class="sd"> change the schema of the table being queried. The driver and server each</span>
<span class="sd"> maintain a map between metadata for a schema and statements that were</span>
<span class="sd"> prepared against that schema. When a user changes a schema, e.g. by adding</span>
<span class="sd"> or removing a column, the server invalidates its mappings involving that</span>
<span class="sd"> schema. However, there is currently no way to propagate that invalidation</span>
<span class="sd"> to drivers. Thus, after a schema change, the driver will incorrectly</span>
<span class="sd"> interpret the results of ``SELECT *`` queries prepared before the schema</span>
<span class="sd"> change. This is currently being addressed in `CASSANDRA-10786</span>
<span class="sd"> <https://issues.apache.org/jira/browse/CASSANDRA-10786>`_.</span>
<span class="sd"> .. |prepared_stmt_head| raw:: html</span>
<span class="sd"> <b>A note about <code>*</code> in prepared statements</b></span>
<span class="sd"> """</span>
<span class="n">column_metadata</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1">#TODO: make this bind_metadata in next major</span>
<span class="n">retry_policy</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">consistency_level</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">custom_payload</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">fetch_size</span> <span class="o">=</span> <span class="n">FETCH_SIZE_UNSET</span>
<span class="n">keyspace</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># change to prepared_keyspace in major release</span>
<span class="n">protocol_version</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">query_id</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">query_string</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">result_metadata</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">result_metadata_id</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">routing_key_indexes</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_routing_key_index_set</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">serial_consistency_level</span> <span class="o">=</span> <span class="kc">None</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">column_metadata</span><span class="p">,</span> <span class="n">query_id</span><span class="p">,</span> <span class="n">routing_key_indexes</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span>
<span class="n">keyspace</span><span class="p">,</span> <span class="n">protocol_version</span><span class="p">,</span> <span class="n">result_metadata</span><span class="p">,</span> <span class="n">result_metadata_id</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">column_metadata</span> <span class="o">=</span> <span class="n">column_metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">query_id</span> <span class="o">=</span> <span class="n">query_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">routing_key_indexes</span> <span class="o">=</span> <span class="n">routing_key_indexes</span>
<span class="bp">self</span><span class="o">.</span><span class="n">query_string</span> <span class="o">=</span> <span class="n">query</span>
<span class="bp">self</span><span class="o">.</span><span class="n">keyspace</span> <span class="o">=</span> <span class="n">keyspace</span>
<span class="bp">self</span><span class="o">.</span><span class="n">protocol_version</span> <span class="o">=</span> <span class="n">protocol_version</span>
<span class="bp">self</span><span class="o">.</span><span class="n">result_metadata</span> <span class="o">=</span> <span class="n">result_metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">result_metadata_id</span> <span class="o">=</span> <span class="n">result_metadata_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">is_idempotent</span> <span class="o">=</span> <span class="kc">False</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">from_message</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">query_id</span><span class="p">,</span> <span class="n">column_metadata</span><span class="p">,</span> <span class="n">pk_indexes</span><span class="p">,</span> <span class="n">cluster_metadata</span><span class="p">,</span>
<span class="n">query</span><span class="p">,</span> <span class="n">prepared_keyspace</span><span class="p">,</span> <span class="n">protocol_version</span><span class="p">,</span> <span class="n">result_metadata</span><span class="p">,</span>
<span class="n">result_metadata_id</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">column_metadata</span><span class="p">:</span>
<span class="k">return</span> <span class="n">PreparedStatement</span><span class="p">(</span><span class="n">column_metadata</span><span class="p">,</span> <span class="n">query_id</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">prepared_keyspace</span><span class="p">,</span> <span class="n">protocol_version</span><span class="p">,</span> <span class="n">result_metadata</span><span class="p">,</span> <span class="n">result_metadata_id</span><span class="p">)</span>
<span class="k">if</span> <span class="n">pk_indexes</span><span class="p">:</span>
<span class="n">routing_key_indexes</span> <span class="o">=</span> <span class="n">pk_indexes</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">routing_key_indexes</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">first_col</span> <span class="o">=</span> <span class="n">column_metadata</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">ks_meta</span> <span class="o">=</span> <span class="n">cluster_metadata</span><span class="o">.</span><span class="n">keyspaces</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">first_col</span><span class="o">.</span><span class="n">keyspace_name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ks_meta</span><span class="p">:</span>
<span class="n">table_meta</span> <span class="o">=</span> <span class="n">ks_meta</span><span class="o">.</span><span class="n">tables</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">first_col</span><span class="o">.</span><span class="n">table_name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">table_meta</span><span class="p">:</span>
<span class="n">partition_key_columns</span> <span class="o">=</span> <span class="n">table_meta</span><span class="o">.</span><span class="n">partition_key</span>
<span class="c1"># make a map of {column_name: index} for each column in the statement</span>
<span class="n">statement_indexes</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">c</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">c</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">column_metadata</span><span class="p">))</span>
<span class="c1"># a list of which indexes in the statement correspond to partition key items</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">routing_key_indexes</span> <span class="o">=</span> <span class="p">[</span><span class="n">statement_indexes</span><span class="p">[</span><span class="n">c</span><span class="o">.</span><span class="n">name</span><span class="p">]</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">partition_key_columns</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span> <span class="c1"># we're missing a partition key component in the prepared</span>
<span class="k">pass</span> <span class="c1"># statement; just leave routing_key_indexes as None</span>
<span class="k">return</span> <span class="n">PreparedStatement</span><span class="p">(</span><span class="n">column_metadata</span><span class="p">,</span> <span class="n">query_id</span><span class="p">,</span> <span class="n">routing_key_indexes</span><span class="p">,</span>
<span class="n">query</span><span class="p">,</span> <span class="n">prepared_keyspace</span><span class="p">,</span> <span class="n">protocol_version</span><span class="p">,</span> <span class="n">result_metadata</span><span class="p">,</span>
<span class="n">result_metadata_id</span><span class="p">)</span>
<div class="viewcode-block" id="PreparedStatement.bind"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.PreparedStatement.bind">[docs]</a> <span class="k">def</span> <span class="nf">bind</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creates and returns a :class:`BoundStatement` instance using `values`.</span>
<span class="sd"> See :meth:`BoundStatement.bind` for rules on input ``values``.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">BoundStatement</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="n">values</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">is_routing_key_index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">i</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_routing_key_index_set</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_routing_key_index_set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">routing_key_indexes</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">routing_key_indexes</span> <span class="k">else</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">return</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_routing_key_index_set</span>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">consistency</span> <span class="o">=</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">value_to_name</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">consistency_level</span><span class="p">,</span> <span class="s1">'Not Set'</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="sa">u</span><span class="s1">'<PreparedStatement query="</span><span class="si">%s</span><span class="s1">", consistency=</span><span class="si">%s</span><span class="s1">>'</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">query_string</span><span class="p">,</span> <span class="n">consistency</span><span class="p">))</span>
<span class="fm">__repr__</span> <span class="o">=</span> <span class="fm">__str__</span></div>
<div class="viewcode-block" id="BoundStatement"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.BoundStatement">[docs]</a><span class="k">class</span> <span class="nc">BoundStatement</span><span class="p">(</span><span class="n">Statement</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A prepared statement that has been bound to a particular set of values.</span>
<span class="sd"> These may be created directly or through :meth:`.PreparedStatement.bind()`.</span>
<span class="sd"> """</span>
<span class="n">prepared_statement</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The :class:`PreparedStatement` instance that this was created from.</span>
<span class="sd"> """</span>
<span class="n">values</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The sequence of values that were bound to the prepared statement.</span>
<span class="sd"> """</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">prepared_statement</span><span class="p">,</span> <span class="n">retry_policy</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">consistency_level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">routing_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">serial_consistency_level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">fetch_size</span><span class="o">=</span><span class="n">FETCH_SIZE_UNSET</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">custom_payload</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> `prepared_statement` should be an instance of :class:`PreparedStatement`.</span>
<span class="sd"> See :class:`Statement` attributes for a description of the other parameters.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepared_statement</span> <span class="o">=</span> <span class="n">prepared_statement</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry_policy</span> <span class="o">=</span> <span class="n">prepared_statement</span><span class="o">.</span><span class="n">retry_policy</span>
<span class="bp">self</span><span class="o">.</span><span class="n">consistency_level</span> <span class="o">=</span> <span class="n">prepared_statement</span><span class="o">.</span><span class="n">consistency_level</span>
<span class="bp">self</span><span class="o">.</span><span class="n">serial_consistency_level</span> <span class="o">=</span> <span class="n">prepared_statement</span><span class="o">.</span><span class="n">serial_consistency_level</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fetch_size</span> <span class="o">=</span> <span class="n">prepared_statement</span><span class="o">.</span><span class="n">fetch_size</span>
<span class="bp">self</span><span class="o">.</span><span class="n">custom_payload</span> <span class="o">=</span> <span class="n">prepared_statement</span><span class="o">.</span><span class="n">custom_payload</span>
<span class="bp">self</span><span class="o">.</span><span class="n">is_idempotent</span> <span class="o">=</span> <span class="n">prepared_statement</span><span class="o">.</span><span class="n">is_idempotent</span>
<span class="bp">self</span><span class="o">.</span><span class="n">values</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">meta</span> <span class="o">=</span> <span class="n">prepared_statement</span><span class="o">.</span><span class="n">column_metadata</span>
<span class="k">if</span> <span class="n">meta</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">keyspace</span> <span class="o">=</span> <span class="n">meta</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">keyspace_name</span>
<span class="n">Statement</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">retry_policy</span><span class="p">,</span> <span class="n">consistency_level</span><span class="p">,</span> <span class="n">routing_key</span><span class="p">,</span>
<span class="n">serial_consistency_level</span><span class="p">,</span> <span class="n">fetch_size</span><span class="p">,</span> <span class="n">keyspace</span><span class="p">,</span> <span class="n">custom_payload</span><span class="p">,</span>
<span class="n">prepared_statement</span><span class="o">.</span><span class="n">is_idempotent</span><span class="p">)</span>
<div class="viewcode-block" id="BoundStatement.bind"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.BoundStatement.bind">[docs]</a> <span class="k">def</span> <span class="nf">bind</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Binds a sequence of values for the prepared statement parameters</span>
<span class="sd"> and returns this instance. Note that `values` *must* be:</span>
<span class="sd"> * a sequence, even if you are only binding one value, or</span>
<span class="sd"> * a dict that relates 1-to-1 between dict keys and columns</span>
<span class="sd"> .. versionchanged:: 2.6.0</span>
<span class="sd"> :data:`~.UNSET_VALUE` was introduced. These can be bound as positional parameters</span>
<span class="sd"> in a sequence, or by name in a dict. Additionally, when using protocol v4+:</span>
<span class="sd"> * short sequences will be extended to match bind parameters with UNSET_VALUE</span>
<span class="sd"> * names may be omitted from a dict with UNSET_VALUE implied.</span>
<span class="sd"> .. versionchanged:: 3.0.0</span>
<span class="sd"> method will not throw if extra keys are present in bound dict (PYTHON-178)</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">values</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">values</span> <span class="o">=</span> <span class="p">()</span>
<span class="n">proto_version</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepared_statement</span><span class="o">.</span><span class="n">protocol_version</span>
<span class="n">col_meta</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepared_statement</span><span class="o">.</span><span class="n">column_metadata</span>
<span class="c1"># special case for binding dicts</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="n">values_dict</span> <span class="o">=</span> <span class="n">values</span>
<span class="n">values</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># sort values accordingly</span>
<span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">col_meta</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">values</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">values_dict</span><span class="p">[</span><span class="n">col</span><span class="o">.</span><span class="n">name</span><span class="p">])</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">if</span> <span class="n">proto_version</span> <span class="o">>=</span> <span class="mi">4</span><span class="p">:</span>
<span class="n">values</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">UNSET_VALUE</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span>
<span class="s1">'Column name `</span><span class="si">%s</span><span class="s1">` not found in bound dict.'</span> <span class="o">%</span>
<span class="p">(</span><span class="n">col</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
<span class="n">value_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">values</span><span class="p">)</span>
<span class="n">col_meta_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">col_meta</span><span class="p">)</span>
<span class="k">if</span> <span class="n">value_len</span> <span class="o">></span> <span class="n">col_meta_len</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"Too many arguments provided to bind() (got </span><span class="si">%d</span><span class="s2">, expected </span><span class="si">%d</span><span class="s2">)"</span> <span class="o">%</span>
<span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">values</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">col_meta</span><span class="p">)))</span>
<span class="c1"># this is fail-fast for clarity pre-v4. When v4 can be assumed,</span>
<span class="c1"># the error will be better reported when UNSET_VALUE is implicitly added.</span>
<span class="k">if</span> <span class="n">proto_version</span> <span class="o"><</span> <span class="mi">4</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepared_statement</span><span class="o">.</span><span class="n">routing_key_indexes</span> <span class="ow">and</span> \
<span class="n">value_len</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">prepared_statement</span><span class="o">.</span><span class="n">routing_key_indexes</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"Too few arguments provided to bind() (got </span><span class="si">%d</span><span class="s2">, required </span><span class="si">%d</span><span class="s2"> for routing key)"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">value_len</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prepared_statement</span><span class="o">.</span><span class="n">routing_key_indexes</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">raw_values</span> <span class="o">=</span> <span class="n">values</span>
<span class="bp">self</span><span class="o">.</span><span class="n">values</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">value</span><span class="p">,</span> <span class="n">col_spec</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="n">col_meta</span><span class="p">):</span>
<span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">value</span> <span class="ow">is</span> <span class="n">UNSET_VALUE</span><span class="p">:</span>
<span class="k">if</span> <span class="n">proto_version</span> <span class="o">>=</span> <span class="mi">4</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_append_unset_value</span><span class="p">()</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="s2">"Attempt to bind UNSET_VALUE while using unsuitable protocol version (</span><span class="si">%d</span><span class="s2"> < 4)"</span> <span class="o">%</span> <span class="n">proto_version</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">col_spec</span><span class="o">.</span><span class="n">type</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">proto_version</span><span class="p">))</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">TypeError</span><span class="p">,</span> <span class="n">struct</span><span class="o">.</span><span class="n">error</span><span class="p">)</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="n">actual_type</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="n">message</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'Received an argument of invalid type for column "</span><span class="si">%s</span><span class="s1">". '</span>
<span class="s1">'Expected: </span><span class="si">%s</span><span class="s1">, Got: </span><span class="si">%s</span><span class="s1">; (</span><span class="si">%s</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">col_spec</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">col_spec</span><span class="o">.</span><span class="n">type</span><span class="p">,</span> <span class="n">actual_type</span><span class="p">,</span> <span class="n">exc</span><span class="p">))</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
<span class="k">if</span> <span class="n">proto_version</span> <span class="o">>=</span> <span class="mi">4</span><span class="p">:</span>
<span class="n">diff</span> <span class="o">=</span> <span class="n">col_meta_len</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">values</span><span class="p">)</span>
<span class="k">if</span> <span class="n">diff</span><span class="p">:</span>
<span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">diff</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_append_unset_value</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span></div>
<span class="k">def</span> <span class="nf">_append_unset_value</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">next_index</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">values</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepared_statement</span><span class="o">.</span><span class="n">is_routing_key_index</span><span class="p">(</span><span class="n">next_index</span><span class="p">):</span>
<span class="n">col_meta</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepared_statement</span><span class="o">.</span><span class="n">column_metadata</span><span class="p">[</span><span class="n">next_index</span><span class="p">]</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Cannot bind UNSET_VALUE as a part of the routing key '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="n">col_meta</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">UNSET_VALUE</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">routing_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepared_statement</span><span class="o">.</span><span class="n">routing_key_indexes</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_routing_key</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_routing_key</span>
<span class="n">routing_indexes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepared_statement</span><span class="o">.</span><span class="n">routing_key_indexes</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">routing_indexes</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_routing_key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="p">[</span><span class="n">routing_indexes</span><span class="p">[</span><span class="mi">0</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">_routing_key</span> <span class="o">=</span> <span class="sa">b</span><span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_key_parts_packed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">routing_indexes</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_routing_key</span>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">consistency</span> <span class="o">=</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">value_to_name</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">consistency_level</span><span class="p">,</span> <span class="s1">'Not Set'</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="sa">u</span><span class="s1">'<BoundStatement query="</span><span class="si">%s</span><span class="s1">", values=</span><span class="si">%s</span><span class="s1">, consistency=</span><span class="si">%s</span><span class="s1">>'</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prepared_statement</span><span class="o">.</span><span class="n">query_string</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_values</span><span class="p">,</span> <span class="n">consistency</span><span class="p">))</span>
<span class="fm">__repr__</span> <span class="o">=</span> <span class="fm">__str__</span></div>
<div class="viewcode-block" id="BatchType"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.BatchType">[docs]</a><span class="k">class</span> <span class="nc">BatchType</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A BatchType is used with :class:`.BatchStatement` instances to control</span>
<span class="sd"> the atomicity of the batch operation.</span>
<span class="sd"> .. versionadded:: 2.0.0</span>
<span class="sd"> """</span>
<span class="n">LOGGED</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> Atomic batch operation.</span>
<span class="sd"> """</span>
<span class="n">UNLOGGED</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> Non-atomic batch operation.</span>
<span class="sd"> """</span>
<span class="n">COUNTER</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> Batches of counter operations.</span>
<span class="sd"> """</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">name</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">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">"BatchType.</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="p">)</span></div>
<span class="n">BatchType</span><span class="o">.</span><span class="n">LOGGED</span> <span class="o">=</span> <span class="n">BatchType</span><span class="p">(</span><span class="s2">"LOGGED"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">BatchType</span><span class="o">.</span><span class="n">UNLOGGED</span> <span class="o">=</span> <span class="n">BatchType</span><span class="p">(</span><span class="s2">"UNLOGGED"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">BatchType</span><span class="o">.</span><span class="n">COUNTER</span> <span class="o">=</span> <span class="n">BatchType</span><span class="p">(</span><span class="s2">"COUNTER"</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<div class="viewcode-block" id="BatchStatement"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.BatchStatement">[docs]</a><span class="k">class</span> <span class="nc">BatchStatement</span><span class="p">(</span><span class="n">Statement</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A protocol-level batch of operations which are applied atomically</span>
<span class="sd"> by default.</span>
<span class="sd"> .. versionadded:: 2.0.0</span>
<span class="sd"> """</span>
<span class="n">batch_type</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The :class:`.BatchType` for the batch operation. Defaults to</span>
<span class="sd"> :attr:`.BatchType.LOGGED`.</span>
<span class="sd"> """</span>
<span class="n">serial_consistency_level</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The same as :attr:`.Statement.serial_consistency_level`, but is only</span>
<span class="sd"> supported when using protocol version 3 or higher.</span>
<span class="sd"> """</span>
<span class="n">_statements_and_parameters</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_session</span> <span class="o">=</span> <span class="kc">None</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">batch_type</span><span class="o">=</span><span class="n">BatchType</span><span class="o">.</span><span class="n">LOGGED</span><span class="p">,</span> <span class="n">retry_policy</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">consistency_level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">serial_consistency_level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">custom_payload</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> `batch_type` specifies The :class:`.BatchType` for the batch operation.</span>
<span class="sd"> Defaults to :attr:`.BatchType.LOGGED`.</span>
<span class="sd"> `retry_policy` should be a :class:`~.RetryPolicy` instance for</span>
<span class="sd"> controlling retries on the operation.</span>
<span class="sd"> `consistency_level` should be a :class:`~.ConsistencyLevel` value</span>
<span class="sd"> to be used for all operations in the batch.</span>
<span class="sd"> `custom_payload` is a :ref:`custom_payload` passed to the server.</span>
<span class="sd"> Note: as Statement objects are added to the batch, this map is</span>
<span class="sd"> updated with any values found in their custom payloads. These are</span>
<span class="sd"> only allowed when using protocol version 4 or higher.</span>
<span class="sd"> Example usage:</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> insert_user = session.prepare("INSERT INTO users (name, age) VALUES (?, ?)")</span>
<span class="sd"> batch = BatchStatement(consistency_level=ConsistencyLevel.QUORUM)</span>
<span class="sd"> for (name, age) in users_to_insert:</span>
<span class="sd"> batch.add(insert_user, (name, age))</span>
<span class="sd"> session.execute(batch)</span>
<span class="sd"> You can also mix different types of operations within a batch:</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> batch = BatchStatement()</span>
<span class="sd"> batch.add(SimpleStatement("INSERT INTO users (name, age) VALUES (%s, %s)"), (name, age))</span>
<span class="sd"> batch.add(SimpleStatement("DELETE FROM pending_users WHERE name=%s"), (name,))</span>
<span class="sd"> session.execute(batch)</span>
<span class="sd"> .. versionadded:: 2.0.0</span>
<span class="sd"> .. versionchanged:: 2.1.0</span>
<span class="sd"> Added `serial_consistency_level` as a parameter</span>
<span class="sd"> .. versionchanged:: 2.6.0</span>
<span class="sd"> Added `custom_payload` as a parameter</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">batch_type</span> <span class="o">=</span> <span class="n">batch_type</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_statements_and_parameters</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_session</span> <span class="o">=</span> <span class="n">session</span>
<span class="n">Statement</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">retry_policy</span><span class="o">=</span><span class="n">retry_policy</span><span class="p">,</span> <span class="n">consistency_level</span><span class="o">=</span><span class="n">consistency_level</span><span class="p">,</span>
<span class="n">serial_consistency_level</span><span class="o">=</span><span class="n">serial_consistency_level</span><span class="p">,</span> <span class="n">custom_payload</span><span class="o">=</span><span class="n">custom_payload</span><span class="p">)</span>
<div class="viewcode-block" id="BatchStatement.clear"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.BatchStatement.clear">[docs]</a> <span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This is a convenience method to clear a batch statement for reuse.</span>
<span class="sd"> *Note:* it should not be used concurrently with uncompleted execution futures executing the same</span>
<span class="sd"> ``BatchStatement``.</span>
<span class="sd"> """</span>
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_statements_and_parameters</span><span class="p">[:]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">keyspace</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">routing_key</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">custom_payload</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">custom_payload</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span></div>
<div class="viewcode-block" id="BatchStatement.add"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.BatchStatement.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">statement</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Adds a :class:`.Statement` and optional sequence of parameters</span>
<span class="sd"> to be used with the statement to the batch.</span>
<span class="sd"> Like with other statements, parameters must be a sequence, even</span>
<span class="sd"> if there is only one item.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">statement</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="k">if</span> <span class="n">parameters</span><span class="p">:</span>
<span class="n">encoder</span> <span class="o">=</span> <span class="n">Encoder</span><span class="p">()</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_session</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">_session</span><span class="o">.</span><span class="n">encoder</span>
<span class="n">statement</span> <span class="o">=</span> <span class="n">bind_params</span><span class="p">(</span><span class="n">statement</span><span class="p">,</span> <span class="n">parameters</span><span class="p">,</span> <span class="n">encoder</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_statement_and_params</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="n">statement</span><span class="p">,</span> <span class="p">())</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">statement</span><span class="p">,</span> <span class="n">PreparedStatement</span><span class="p">):</span>
<span class="n">query_id</span> <span class="o">=</span> <span class="n">statement</span><span class="o">.</span><span class="n">query_id</span>
<span class="n">bound_statement</span> <span class="o">=</span> <span class="n">statement</span><span class="o">.</span><span class="n">bind</span><span class="p">(()</span> <span class="k">if</span> <span class="n">parameters</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">parameters</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_state</span><span class="p">(</span><span class="n">bound_statement</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_statement_and_params</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="n">query_id</span><span class="p">,</span> <span class="n">bound_statement</span><span class="o">.</span><span class="n">values</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">statement</span><span class="p">,</span> <span class="n">BoundStatement</span><span class="p">):</span>
<span class="k">if</span> <span class="n">parameters</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"Parameters cannot be passed with a BoundStatement "</span>
<span class="s2">"to BatchStatement.add()"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_state</span><span class="p">(</span><span class="n">statement</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_statement_and_params</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="n">statement</span><span class="o">.</span><span class="n">prepared_statement</span><span class="o">.</span><span class="n">query_id</span><span class="p">,</span> <span class="n">statement</span><span class="o">.</span><span class="n">values</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># it must be a SimpleStatement</span>
<span class="n">query_string</span> <span class="o">=</span> <span class="n">statement</span><span class="o">.</span><span class="n">query_string</span>
<span class="k">if</span> <span class="n">parameters</span><span class="p">:</span>
<span class="n">encoder</span> <span class="o">=</span> <span class="n">Encoder</span><span class="p">()</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_session</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">_session</span><span class="o">.</span><span class="n">encoder</span>
<span class="n">query_string</span> <span class="o">=</span> <span class="n">bind_params</span><span class="p">(</span><span class="n">query_string</span><span class="p">,</span> <span class="n">parameters</span><span class="p">,</span> <span class="n">encoder</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_state</span><span class="p">(</span><span class="n">statement</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_statement_and_params</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="n">query_string</span><span class="p">,</span> <span class="p">())</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="BatchStatement.add_all"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.BatchStatement.add_all">[docs]</a> <span class="k">def</span> <span class="nf">add_all</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">statements</span><span class="p">,</span> <span class="n">parameters</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Adds a sequence of :class:`.Statement` objects and a matching sequence</span>
<span class="sd"> of parameters to the batch. Statement and parameter sequences must be of equal length or</span>
<span class="sd"> one will be truncated. :const:`None` can be used in the parameters position where are needed.</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">statement</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">statements</span><span class="p">,</span> <span class="n">parameters</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">statement</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_add_statement_and_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">is_prepared</span><span class="p">,</span> <span class="n">statement</span><span class="p">,</span> <span class="n">parameters</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_statements_and_parameters</span><span class="p">)</span> <span class="o">>=</span> <span class="mh">0xFFFF</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Batch statement cannot contain more than </span><span class="si">%d</span><span class="s2"> statements."</span> <span class="o">%</span> <span class="mh">0xFFFF</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_statements_and_parameters</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">is_prepared</span><span class="p">,</span> <span class="n">statement</span><span class="p">,</span> <span class="n">parameters</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_maybe_set_routing_attributes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">statement</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">routing_key</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">statement</span><span class="o">.</span><span class="n">keyspace</span> <span class="ow">and</span> <span class="n">statement</span><span class="o">.</span><span class="n">routing_key</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">routing_key</span> <span class="o">=</span> <span class="n">statement</span><span class="o">.</span><span class="n">routing_key</span>
<span class="bp">self</span><span class="o">.</span><span class="n">keyspace</span> <span class="o">=</span> <span class="n">statement</span><span class="o">.</span><span class="n">keyspace</span>
<span class="k">def</span> <span class="nf">_update_custom_payload</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">statement</span><span class="p">):</span>
<span class="k">if</span> <span class="n">statement</span><span class="o">.</span><span class="n">custom_payload</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">custom_payload</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">custom_payload</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">custom_payload</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">statement</span><span class="o">.</span><span class="n">custom_payload</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_update_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">statement</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_maybe_set_routing_attributes</span><span class="p">(</span><span class="n">statement</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_custom_payload</span><span class="p">(</span><span class="n">statement</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_statements_and_parameters</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">consistency</span> <span class="o">=</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">value_to_name</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">consistency_level</span><span class="p">,</span> <span class="s1">'Not Set'</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="sa">u</span><span class="s1">'<BatchStatement type=</span><span class="si">%s</span><span class="s1">, statements=</span><span class="si">%d</span><span class="s1">, consistency=</span><span class="si">%s</span><span class="s1">>'</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">batch_type</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="n">consistency</span><span class="p">))</span>
<span class="fm">__repr__</span> <span class="o">=</span> <span class="fm">__str__</span></div>
<span class="n">ValueSequence</span> <span class="o">=</span> <span class="n">cassandra</span><span class="o">.</span><span class="n">encoder</span><span class="o">.</span><span class="n">ValueSequence</span>
<span class="sd">"""</span>
<span class="sd">A wrapper class that is used to specify that a sequence of values should</span>
<span class="sd">be treated as a CQL list of values instead of a single column collection when used</span>
<span class="sd">as part of the `parameters` argument for :meth:`.Session.execute()`.</span>
<span class="sd">This is typically needed when supplying a list of keys to select.</span>
<span class="sd">For example::</span>
<span class="sd"> >>> my_user_ids = ('alice', 'bob', 'charles')</span>
<span class="sd"> >>> query = "SELECT * FROM users WHERE user_id IN %s"</span>
<span class="sd"> >>> session.execute(query, parameters=[ValueSequence(my_user_ids)])</span>
<span class="sd">"""</span>
<span class="k">def</span> <span class="nf">bind_params</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">encoder</span><span class="p">):</span>
<span class="k">if</span> <span class="n">six</span><span class="o">.</span><span class="n">PY2</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">):</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="k">return</span> <span class="n">query</span> <span class="o">%</span> <span class="nb">dict</span><span class="p">((</span><span class="n">k</span><span class="p">,</span> <span class="n">encoder</span><span class="o">.</span><span class="n">cql_encode_all_types</span><span class="p">(</span><span class="n">v</span><span class="p">))</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">six</span><span class="o">.</span><span class="n">iteritems</span><span class="p">(</span><span class="n">params</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">query</span> <span class="o">%</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">encoder</span><span class="o">.</span><span class="n">cql_encode_all_types</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">params</span><span class="p">)</span>
<div class="viewcode-block" id="TraceUnavailable"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.TraceUnavailable">[docs]</a><span class="k">class</span> <span class="nc">TraceUnavailable</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Raised when complete trace details cannot be fetched from Cassandra.</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="QueryTrace"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.QueryTrace">[docs]</a><span class="k">class</span> <span class="nc">QueryTrace</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A trace of the duration and events that occurred when executing</span>
<span class="sd"> an operation.</span>
<span class="sd"> """</span>
<span class="n">trace_id</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> :class:`uuid.UUID` unique identifier for this tracing session. Matches</span>
<span class="sd"> the ``session_id`` column in ``system_traces.sessions`` and</span>
<span class="sd"> ``system_traces.events``.</span>
<span class="sd"> """</span>
<span class="n">request_type</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> A string that very generally describes the traced operation.</span>
<span class="sd"> """</span>
<span class="n">duration</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> A :class:`datetime.timedelta` measure of the duration of the query.</span>
<span class="sd"> """</span>
<span class="n">client</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The IP address of the client that issued this request</span>
<span class="sd"> This is only available when using Cassandra 2.2+</span>
<span class="sd"> """</span>
<span class="n">coordinator</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The IP address of the host that acted as coordinator for this request.</span>
<span class="sd"> """</span>
<span class="n">parameters</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> A :class:`dict` of parameters for the traced operation, such as the</span>
<span class="sd"> specific query string.</span>
<span class="sd"> """</span>
<span class="n">started_at</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> A UTC :class:`datetime.datetime` object describing when the operation</span>
<span class="sd"> was started.</span>
<span class="sd"> """</span>
<span class="n">events</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> A chronologically sorted list of :class:`.TraceEvent` instances</span>
<span class="sd"> representing the steps the traced operation went through. This</span>
<span class="sd"> corresponds to the rows in ``system_traces.events`` for this tracing</span>
<span class="sd"> session.</span>
<span class="sd"> """</span>
<span class="n">_session</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_SELECT_SESSIONS_FORMAT</span> <span class="o">=</span> <span class="s2">"SELECT * FROM system_traces.sessions WHERE session_id = </span><span class="si">%s</span><span class="s2">"</span>
<span class="n">_SELECT_EVENTS_FORMAT</span> <span class="o">=</span> <span class="s2">"SELECT * FROM system_traces.events WHERE session_id = </span><span class="si">%s</span><span class="s2">"</span>
<span class="n">_BASE_RETRY_SLEEP</span> <span class="o">=</span> <span class="mf">0.003</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">trace_id</span><span class="p">,</span> <span class="n">session</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">trace_id</span> <span class="o">=</span> <span class="n">trace_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_session</span> <span class="o">=</span> <span class="n">session</span>
<div class="viewcode-block" id="QueryTrace.populate"><a class="viewcode-back" href="../../api/cassandra/query.html#cassandra.cluster.QueryTrace.populate">[docs]</a> <span class="k">def</span> <span class="nf">populate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">max_wait</span><span class="o">=</span><span class="mf">2.0</span><span class="p">,</span> <span class="n">wait_for_complete</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">query_cl</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Retrieves the actual tracing details from Cassandra and populates the</span>
<span class="sd"> attributes of this instance. Because tracing details are stored</span>
<span class="sd"> asynchronously by Cassandra, this may need to retry the session</span>
<span class="sd"> detail fetch. If the trace is still not available after `max_wait`</span>
<span class="sd"> seconds, :exc:`.TraceUnavailable` will be raised; if `max_wait` is</span>
<span class="sd"> :const:`None`, this will retry forever.</span>
<span class="sd"> `wait_for_complete=False` bypasses the wait for duration to be populated.</span>
<span class="sd"> This can be used to query events from partial sessions.</span>
<span class="sd"> `query_cl` specifies a consistency level to use for polling the trace tables,</span>
<span class="sd"> if it should be different than the session default.</span>
<span class="sd"> """</span>
<span class="n">attempt</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">start</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
<span class="n">time_spent</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">-</span> <span class="n">start</span>
<span class="k">if</span> <span class="n">max_wait</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">time_spent</span> <span class="o">>=</span> <span class="n">max_wait</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">TraceUnavailable</span><span class="p">(</span>
<span class="s2">"Trace information was not available within </span><span class="si">%f</span><span class="s2"> seconds. Consider raising Session.max_trace_wait."</span> <span class="o">%</span> <span class="p">(</span><span class="n">max_wait</span><span class="p">,))</span>
<span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Attempting to fetch trace info for trace ID: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">trace_id</span><span class="p">)</span>
<span class="n">session_results</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_execute</span><span class="p">(</span>
<span class="n">SimpleStatement</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_SELECT_SESSIONS_FORMAT</span><span class="p">,</span> <span class="n">consistency_level</span><span class="o">=</span><span class="n">query_cl</span><span class="p">),</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">trace_id</span><span class="p">,),</span> <span class="n">time_spent</span><span class="p">,</span> <span class="n">max_wait</span><span class="p">)</span>
<span class="c1"># PYTHON-730: There is race condition that the duration mutation is written before started_at the for fast queries</span>
<span class="n">is_complete</span> <span class="o">=</span> <span class="n">session_results</span> <span class="ow">and</span> <span class="n">session_results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">duration</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">session_results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">started_at</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">session_results</span> <span class="ow">or</span> <span class="p">(</span><span class="n">wait_for_complete</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">is_complete</span><span class="p">):</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_BASE_RETRY_SLEEP</span> <span class="o">*</span> <span class="p">(</span><span class="mi">2</span> <span class="o">**</span> <span class="n">attempt</span><span class="p">))</span>
<span class="n">attempt</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">is_complete</span><span class="p">:</span>
<span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Fetched trace info for trace ID: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">trace_id</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>