forked from apache/cassandra-python-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcassandra.html
More file actions
731 lines (565 loc) · 61.1 KB
/
Copy pathcassandra.html
File metadata and controls
731 lines (565 loc) · 61.1 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
<!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 — 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</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="kn">import</span> <span class="nn">logging</span>
<span class="k">class</span> <span class="nc">NullHandler</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Handler</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">emit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
<span class="k">pass</span>
<span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">'cassandra'</span><span class="p">)</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">NullHandler</span><span class="p">())</span>
<span class="n">__version_info__</span> <span class="o">=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">__version__</span> <span class="o">=</span> <span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">__version_info__</span><span class="p">))</span>
<div class="viewcode-block" id="ConsistencyLevel"><a class="viewcode-back" href="../api/cassandra.html#cassandra.ConsistencyLevel">[docs]</a><span class="k">class</span> <span class="nc">ConsistencyLevel</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Spcifies how many replicas must respond for an operation to be considered</span>
<span class="sd"> a success. By default, ``ONE`` is used for all operations.</span>
<span class="sd"> """</span>
<span class="n">ANY</span> <span class="o">=</span> <span class="mi">0</span>
<span class="sd">"""</span>
<span class="sd"> Only requires that one replica receives the write *or* the coordinator</span>
<span class="sd"> stores a hint to replay later. Valid only for writes.</span>
<span class="sd"> """</span>
<span class="n">ONE</span> <span class="o">=</span> <span class="mi">1</span>
<span class="sd">"""</span>
<span class="sd"> Only one replica needs to respond to consider the operation a success</span>
<span class="sd"> """</span>
<span class="n">TWO</span> <span class="o">=</span> <span class="mi">2</span>
<span class="sd">"""</span>
<span class="sd"> Two replicas must respond to consider the operation a success</span>
<span class="sd"> """</span>
<span class="n">THREE</span> <span class="o">=</span> <span class="mi">3</span>
<span class="sd">"""</span>
<span class="sd"> Three replicas must respond to consider the operation a success</span>
<span class="sd"> """</span>
<span class="n">QUORUM</span> <span class="o">=</span> <span class="mi">4</span>
<span class="sd">"""</span>
<span class="sd"> ``ceil(RF/2)`` replicas must respond to consider the operation a success</span>
<span class="sd"> """</span>
<span class="n">ALL</span> <span class="o">=</span> <span class="mi">5</span>
<span class="sd">"""</span>
<span class="sd"> All replicas must respond to consider the operation a success</span>
<span class="sd"> """</span>
<span class="n">LOCAL_QUORUM</span> <span class="o">=</span> <span class="mi">6</span>
<span class="sd">"""</span>
<span class="sd"> Requires a quorum of replicas in the local datacenter</span>
<span class="sd"> """</span>
<span class="n">EACH_QUORUM</span> <span class="o">=</span> <span class="mi">7</span>
<span class="sd">"""</span>
<span class="sd"> Requires a quorum of replicas in each datacenter</span>
<span class="sd"> """</span>
<span class="n">SERIAL</span> <span class="o">=</span> <span class="mi">8</span>
<span class="sd">"""</span>
<span class="sd"> For conditional inserts/updates that utilize Cassandra's lightweight</span>
<span class="sd"> transactions, this requires consensus among all replicas for the</span>
<span class="sd"> modified data.</span>
<span class="sd"> """</span>
<span class="n">LOCAL_SERIAL</span> <span class="o">=</span> <span class="mi">9</span>
<span class="sd">"""</span>
<span class="sd"> Like :attr:`~ConsistencyLevel.SERIAL`, but only requires consensus</span>
<span class="sd"> among replicas in the local datacenter.</span>
<span class="sd"> """</span>
<span class="n">LOCAL_ONE</span> <span class="o">=</span> <span class="mi">10</span>
<span class="sd">"""</span>
<span class="sd"> Sends a request only to replicas in the local datacenter and waits for</span>
<span class="sd"> one response.</span>
<span class="sd"> """</span></div>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">value_to_name</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">ANY</span><span class="p">:</span> <span class="s1">'ANY'</span><span class="p">,</span>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">ONE</span><span class="p">:</span> <span class="s1">'ONE'</span><span class="p">,</span>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">TWO</span><span class="p">:</span> <span class="s1">'TWO'</span><span class="p">,</span>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">THREE</span><span class="p">:</span> <span class="s1">'THREE'</span><span class="p">,</span>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">QUORUM</span><span class="p">:</span> <span class="s1">'QUORUM'</span><span class="p">,</span>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">ALL</span><span class="p">:</span> <span class="s1">'ALL'</span><span class="p">,</span>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">LOCAL_QUORUM</span><span class="p">:</span> <span class="s1">'LOCAL_QUORUM'</span><span class="p">,</span>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">EACH_QUORUM</span><span class="p">:</span> <span class="s1">'EACH_QUORUM'</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="s1">'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="s1">'LOCAL_SERIAL'</span><span class="p">,</span>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">LOCAL_ONE</span><span class="p">:</span> <span class="s1">'LOCAL_ONE'</span>
<span class="p">}</span>
<span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">name_to_value</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'ANY'</span><span class="p">:</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">ANY</span><span class="p">,</span>
<span class="s1">'ONE'</span><span class="p">:</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">ONE</span><span class="p">,</span>
<span class="s1">'TWO'</span><span class="p">:</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">TWO</span><span class="p">,</span>
<span class="s1">'THREE'</span><span class="p">:</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">THREE</span><span class="p">,</span>
<span class="s1">'QUORUM'</span><span class="p">:</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">QUORUM</span><span class="p">,</span>
<span class="s1">'ALL'</span><span class="p">:</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">ALL</span><span class="p">,</span>
<span class="s1">'LOCAL_QUORUM'</span><span class="p">:</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">LOCAL_QUORUM</span><span class="p">,</span>
<span class="s1">'EACH_QUORUM'</span><span class="p">:</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">EACH_QUORUM</span><span class="p">,</span>
<span class="s1">'SERIAL'</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="s1">'LOCAL_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="s1">'LOCAL_ONE'</span><span class="p">:</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">LOCAL_ONE</span>
<span class="p">}</span>
<span class="k">def</span> <span class="nf">consistency_value_to_name</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="k">return</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">value_to_name</span><span class="p">[</span><span class="n">value</span><span class="p">]</span> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="s2">"Not Set"</span>
<div class="viewcode-block" id="ProtocolVersion"><a class="viewcode-back" href="../api/cassandra.html#cassandra.ProtocolVersion">[docs]</a><span class="k">class</span> <span class="nc">ProtocolVersion</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Defines native protocol versions supported by this driver.</span>
<span class="sd"> """</span>
<span class="n">V1</span> <span class="o">=</span> <span class="mi">1</span>
<span class="sd">"""</span>
<span class="sd"> v1, supported in Cassandra 1.2-->2.2</span>
<span class="sd"> """</span>
<span class="n">V2</span> <span class="o">=</span> <span class="mi">2</span>
<span class="sd">"""</span>
<span class="sd"> v2, supported in Cassandra 2.0-->2.2;</span>
<span class="sd"> added support for lightweight transactions, batch operations, and automatic query paging.</span>
<span class="sd"> """</span>
<span class="n">V3</span> <span class="o">=</span> <span class="mi">3</span>
<span class="sd">"""</span>
<span class="sd"> v3, supported in Cassandra 2.1-->3.x+;</span>
<span class="sd"> added support for protocol-level client-side timestamps (see :attr:`.Session.use_client_timestamp`),</span>
<span class="sd"> serial consistency levels for :class:`~.BatchStatement`, and an improved connection pool.</span>
<span class="sd"> """</span>
<span class="n">V4</span> <span class="o">=</span> <span class="mi">4</span>
<span class="sd">"""</span>
<span class="sd"> v4, supported in Cassandra 2.2-->3.x+;</span>
<span class="sd"> added a number of new types, server warnings, new failure messages, and custom payloads. Details in the</span>
<span class="sd"> `project docs <https://github.com/apache/cassandra/blob/trunk/doc/native_protocol_v4.spec>`_</span>
<span class="sd"> """</span>
<span class="n">V5</span> <span class="o">=</span> <span class="mi">5</span>
<span class="sd">"""</span>
<span class="sd"> v5, in beta from 3.x+</span>
<span class="sd"> """</span>
<span class="n">SUPPORTED_VERSIONS</span> <span class="o">=</span> <span class="p">(</span><span class="n">V5</span><span class="p">,</span> <span class="n">V4</span><span class="p">,</span> <span class="n">V3</span><span class="p">,</span> <span class="n">V2</span><span class="p">,</span> <span class="n">V1</span><span class="p">)</span>
<span class="sd">"""</span>
<span class="sd"> A tuple of all supported protocol versions</span>
<span class="sd"> """</span>
<span class="n">BETA_VERSIONS</span> <span class="o">=</span> <span class="p">(</span><span class="n">V5</span><span class="p">,)</span>
<span class="sd">"""</span>
<span class="sd"> A tuple of all beta protocol versions</span>
<span class="sd"> """</span>
<span class="n">MIN_SUPPORTED</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">SUPPORTED_VERSIONS</span><span class="p">)</span>
<span class="sd">"""</span>
<span class="sd"> Minimum protocol version supported by this driver.</span>
<span class="sd"> """</span>
<span class="n">MAX_SUPPORTED</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">SUPPORTED_VERSIONS</span><span class="p">)</span>
<span class="sd">"""</span>
<span class="sd"> Maximum protocol versioni supported by this driver.</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="ProtocolVersion.get_lower_supported"><a class="viewcode-back" href="../api/cassandra.html#cassandra.ProtocolVersion.get_lower_supported">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">get_lower_supported</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">previous_version</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return the lower supported protocol version. Beta versions are omitted.</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">version</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="n">v</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">ProtocolVersion</span><span class="o">.</span><span class="n">SUPPORTED_VERSIONS</span><span class="p">,</span> <span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">if</span>
<span class="n">v</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">ProtocolVersion</span><span class="o">.</span><span class="n">BETA_VERSIONS</span> <span class="ow">and</span> <span class="n">v</span> <span class="o"><</span> <span class="n">previous_version</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span>
<span class="n">version</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">return</span> <span class="n">version</span></div>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">uses_int_query_flags</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
<span class="k">return</span> <span class="n">version</span> <span class="o">>=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">V5</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">uses_prepare_flags</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
<span class="k">return</span> <span class="n">version</span> <span class="o">>=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">V5</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">uses_prepared_metadata</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
<span class="k">return</span> <span class="n">version</span> <span class="o">>=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">V5</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">uses_error_code_map</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
<span class="k">return</span> <span class="n">version</span> <span class="o">>=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">V5</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">uses_keyspace_flag</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
<span class="k">return</span> <span class="n">version</span> <span class="o">>=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">V5</span></div>
<span class="k">class</span> <span class="nc">SchemaChangeType</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="n">DROPPED</span> <span class="o">=</span> <span class="s1">'DROPPED'</span>
<span class="n">CREATED</span> <span class="o">=</span> <span class="s1">'CREATED'</span>
<span class="n">UPDATED</span> <span class="o">=</span> <span class="s1">'UPDATED'</span>
<span class="k">class</span> <span class="nc">SchemaTargetType</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="n">KEYSPACE</span> <span class="o">=</span> <span class="s1">'KEYSPACE'</span>
<span class="n">TABLE</span> <span class="o">=</span> <span class="s1">'TABLE'</span>
<span class="n">TYPE</span> <span class="o">=</span> <span class="s1">'TYPE'</span>
<span class="n">FUNCTION</span> <span class="o">=</span> <span class="s1">'FUNCTION'</span>
<span class="n">AGGREGATE</span> <span class="o">=</span> <span class="s1">'AGGREGATE'</span>
<span class="k">class</span> <span class="nc">SignatureDescriptor</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">argument_types</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">argument_types</span> <span class="o">=</span> <span class="n">argument_types</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">signature</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> function signature string in the form 'name([type0[,type1[...]]])'</span>
<span class="sd"> can be used to uniquely identify overloaded function names within a keyspace</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_signature</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="bp">self</span><span class="o">.</span><span class="n">argument_types</span><span class="p">)</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">format_signature</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">argument_types</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">(</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="s1">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">t</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">argument_types</span><span class="p">))</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">"</span><span class="si">%s</span><span class="s2">(</span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="bp">self</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">argument_types</span><span class="p">)</span>
<div class="viewcode-block" id="UserFunctionDescriptor"><a class="viewcode-back" href="../api/cassandra.html#cassandra.UserFunctionDescriptor">[docs]</a><span class="k">class</span> <span class="nc">UserFunctionDescriptor</span><span class="p">(</span><span class="n">SignatureDescriptor</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Describes a User function by name and argument signature</span>
<span class="sd"> """</span>
<span class="n">name</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> name of the function</span>
<span class="sd"> """</span>
<span class="n">argument_types</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> Ordered list of CQL argument type names comprising the type signature</span>
<span class="sd"> """</span></div>
<div class="viewcode-block" id="UserAggregateDescriptor"><a class="viewcode-back" href="../api/cassandra.html#cassandra.UserAggregateDescriptor">[docs]</a><span class="k">class</span> <span class="nc">UserAggregateDescriptor</span><span class="p">(</span><span class="n">SignatureDescriptor</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Describes a User aggregate function by name and argument signature</span>
<span class="sd"> """</span>
<span class="n">name</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> name of the aggregate</span>
<span class="sd"> """</span>
<span class="n">argument_types</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> Ordered list of CQL argument type names comprising the type signature</span>
<span class="sd"> """</span></div>
<div class="viewcode-block" id="DriverException"><a class="viewcode-back" href="../api/cassandra.html#cassandra.DriverException">[docs]</a><span class="k">class</span> <span class="nc">DriverException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Base for all exceptions explicitly raised by the driver.</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="RequestExecutionException"><a class="viewcode-back" href="../api/cassandra.html#cassandra.RequestExecutionException">[docs]</a><span class="k">class</span> <span class="nc">RequestExecutionException</span><span class="p">(</span><span class="n">DriverException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Base for request execution exceptions returned from the server.</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="Unavailable"><a class="viewcode-back" href="../api/cassandra.html#cassandra.Unavailable">[docs]</a><span class="k">class</span> <span class="nc">Unavailable</span><span class="p">(</span><span class="n">RequestExecutionException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> There were not enough live replicas to satisfy the requested consistency</span>
<span class="sd"> level, so the coordinator node immediately failed the request without</span>
<span class="sd"> forwarding it to any replicas.</span>
<span class="sd"> """</span>
<span class="n">consistency</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">""" The requested :class:`ConsistencyLevel` """</span>
<span class="n">required_replicas</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">""" The number of replicas that needed to be live to complete the operation """</span>
<span class="n">alive_replicas</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">""" The number of replicas that were actually alive """</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">summary_message</span><span class="p">,</span> <span class="n">consistency</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">required_replicas</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">alive_replicas</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">consistency</span> <span class="o">=</span> <span class="n">consistency</span>
<span class="bp">self</span><span class="o">.</span><span class="n">required_replicas</span> <span class="o">=</span> <span class="n">required_replicas</span>
<span class="bp">self</span><span class="o">.</span><span class="n">alive_replicas</span> <span class="o">=</span> <span class="n">alive_replicas</span>
<span class="ne">Exception</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">summary_message</span> <span class="o">+</span> <span class="s1">' info='</span> <span class="o">+</span>
<span class="nb">repr</span><span class="p">({</span><span class="s1">'consistency'</span><span class="p">:</span> <span class="n">consistency_value_to_name</span><span class="p">(</span><span class="n">consistency</span><span class="p">),</span>
<span class="s1">'required_replicas'</span><span class="p">:</span> <span class="n">required_replicas</span><span class="p">,</span>
<span class="s1">'alive_replicas'</span><span class="p">:</span> <span class="n">alive_replicas</span><span class="p">}))</span></div>
<div class="viewcode-block" id="Timeout"><a class="viewcode-back" href="../api/cassandra.html#cassandra.Timeout">[docs]</a><span class="k">class</span> <span class="nc">Timeout</span><span class="p">(</span><span class="n">RequestExecutionException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Replicas failed to respond to the coordinator node before timing out.</span>
<span class="sd"> """</span>
<span class="n">consistency</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">""" The requested :class:`ConsistencyLevel` """</span>
<span class="n">required_responses</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">""" The number of required replica responses """</span>
<span class="n">received_responses</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The number of replicas that responded before the coordinator timed out</span>
<span class="sd"> the operation</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">summary_message</span><span class="p">,</span> <span class="n">consistency</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">required_responses</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">received_responses</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">consistency</span> <span class="o">=</span> <span class="n">consistency</span>
<span class="bp">self</span><span class="o">.</span><span class="n">required_responses</span> <span class="o">=</span> <span class="n">required_responses</span>
<span class="bp">self</span><span class="o">.</span><span class="n">received_responses</span> <span class="o">=</span> <span class="n">received_responses</span>
<span class="ne">Exception</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">summary_message</span> <span class="o">+</span> <span class="s1">' info='</span> <span class="o">+</span>
<span class="nb">repr</span><span class="p">({</span><span class="s1">'consistency'</span><span class="p">:</span> <span class="n">consistency_value_to_name</span><span class="p">(</span><span class="n">consistency</span><span class="p">),</span>
<span class="s1">'required_responses'</span><span class="p">:</span> <span class="n">required_responses</span><span class="p">,</span>
<span class="s1">'received_responses'</span><span class="p">:</span> <span class="n">received_responses</span><span class="p">}))</span></div>
<div class="viewcode-block" id="ReadTimeout"><a class="viewcode-back" href="../api/cassandra.html#cassandra.ReadTimeout">[docs]</a><span class="k">class</span> <span class="nc">ReadTimeout</span><span class="p">(</span><span class="n">Timeout</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A subclass of :exc:`Timeout` for read operations.</span>
<span class="sd"> This indicates that the replicas failed to respond to the coordinator</span>
<span class="sd"> node before the configured timeout. This timeout is configured in</span>
<span class="sd"> ``cassandra.yaml`` with the ``read_request_timeout_in_ms``</span>
<span class="sd"> and ``range_request_timeout_in_ms`` options.</span>
<span class="sd"> """</span>
<span class="n">data_retrieved</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> A boolean indicating whether the requested data was retrieved</span>
<span class="sd"> by the coordinator from any replicas before it timed out the</span>
<span class="sd"> operation</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">message</span><span class="p">,</span> <span class="n">data_retrieved</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">Timeout</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">message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data_retrieved</span> <span class="o">=</span> <span class="n">data_retrieved</span></div>
<div class="viewcode-block" id="WriteTimeout"><a class="viewcode-back" href="../api/cassandra.html#cassandra.WriteTimeout">[docs]</a><span class="k">class</span> <span class="nc">WriteTimeout</span><span class="p">(</span><span class="n">Timeout</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A subclass of :exc:`Timeout` for write operations.</span>
<span class="sd"> This indicates that the replicas failed to respond to the coordinator</span>
<span class="sd"> node before the configured timeout. This timeout is configured in</span>
<span class="sd"> ``cassandra.yaml`` with the ``write_request_timeout_in_ms``</span>
<span class="sd"> option.</span>
<span class="sd"> """</span>
<span class="n">write_type</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The type of write operation, enum on :class:`~cassandra.policies.WriteType`</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">message</span><span class="p">,</span> <span class="n">write_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">Timeout</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">message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_type</span> <span class="o">=</span> <span class="n">write_type</span></div>
<span class="k">class</span> <span class="nc">CDCWriteFailure</span><span class="p">(</span><span class="n">RequestExecutionException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Hit limit on data in CDC folder, writes are rejected</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">message</span><span class="p">):</span>
<span class="ne">Exception</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">message</span><span class="p">)</span>
<div class="viewcode-block" id="CoordinationFailure"><a class="viewcode-back" href="../api/cassandra.html#cassandra.CoordinationFailure">[docs]</a><span class="k">class</span> <span class="nc">CoordinationFailure</span><span class="p">(</span><span class="n">RequestExecutionException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Replicas sent a failure to the coordinator.</span>
<span class="sd"> """</span>
<span class="n">consistency</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">""" The requested :class:`ConsistencyLevel` """</span>
<span class="n">required_responses</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">""" The number of required replica responses """</span>
<span class="n">received_responses</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The number of replicas that responded before the coordinator timed out</span>
<span class="sd"> the operation</span>
<span class="sd"> """</span>
<span class="n">failures</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The number of replicas that sent a failure message</span>
<span class="sd"> """</span>
<span class="n">error_code_map</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> A map of inet addresses to error codes representing replicas that sent</span>
<span class="sd"> a failure message. Only set when `protocol_version` is 5 or higher.</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">summary_message</span><span class="p">,</span> <span class="n">consistency</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">required_responses</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">received_responses</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">failures</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">error_code_map</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">consistency</span> <span class="o">=</span> <span class="n">consistency</span>
<span class="bp">self</span><span class="o">.</span><span class="n">required_responses</span> <span class="o">=</span> <span class="n">required_responses</span>
<span class="bp">self</span><span class="o">.</span><span class="n">received_responses</span> <span class="o">=</span> <span class="n">received_responses</span>
<span class="bp">self</span><span class="o">.</span><span class="n">failures</span> <span class="o">=</span> <span class="n">failures</span>
<span class="bp">self</span><span class="o">.</span><span class="n">error_code_map</span> <span class="o">=</span> <span class="n">error_code_map</span>
<span class="n">info_dict</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'consistency'</span><span class="p">:</span> <span class="n">consistency_value_to_name</span><span class="p">(</span><span class="n">consistency</span><span class="p">),</span>
<span class="s1">'required_responses'</span><span class="p">:</span> <span class="n">required_responses</span><span class="p">,</span>
<span class="s1">'received_responses'</span><span class="p">:</span> <span class="n">received_responses</span><span class="p">,</span>
<span class="s1">'failures'</span><span class="p">:</span> <span class="n">failures</span>
<span class="p">}</span>
<span class="k">if</span> <span class="n">error_code_map</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># make error codes look like "0x002a"</span>
<span class="n">formatted_map</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">addr</span><span class="p">,</span> <span class="s1">'0x</span><span class="si">%04x</span><span class="s1">'</span> <span class="o">%</span> <span class="n">err_code</span><span class="p">)</span>
<span class="k">for</span> <span class="p">(</span><span class="n">addr</span><span class="p">,</span> <span class="n">err_code</span><span class="p">)</span> <span class="ow">in</span> <span class="n">error_code_map</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
<span class="n">info_dict</span><span class="p">[</span><span class="s1">'error_code_map'</span><span class="p">]</span> <span class="o">=</span> <span class="n">formatted_map</span>
<span class="ne">Exception</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">summary_message</span> <span class="o">+</span> <span class="s1">' info='</span> <span class="o">+</span> <span class="nb">repr</span><span class="p">(</span><span class="n">info_dict</span><span class="p">))</span></div>
<div class="viewcode-block" id="ReadFailure"><a class="viewcode-back" href="../api/cassandra.html#cassandra.ReadFailure">[docs]</a><span class="k">class</span> <span class="nc">ReadFailure</span><span class="p">(</span><span class="n">CoordinationFailure</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A subclass of :exc:`CoordinationFailure` for read operations.</span>
<span class="sd"> This indicates that the replicas sent a failure message to the coordinator.</span>
<span class="sd"> """</span>
<span class="n">data_retrieved</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> A boolean indicating whether the requested data was retrieved</span>
<span class="sd"> by the coordinator from any replicas before it timed out the</span>
<span class="sd"> operation</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">message</span><span class="p">,</span> <span class="n">data_retrieved</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">CoordinationFailure</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">message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data_retrieved</span> <span class="o">=</span> <span class="n">data_retrieved</span></div>
<div class="viewcode-block" id="WriteFailure"><a class="viewcode-back" href="../api/cassandra.html#cassandra.WriteFailure">[docs]</a><span class="k">class</span> <span class="nc">WriteFailure</span><span class="p">(</span><span class="n">CoordinationFailure</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A subclass of :exc:`CoordinationFailure` for write operations.</span>
<span class="sd"> This indicates that the replicas sent a failure message to the coordinator.</span>
<span class="sd"> """</span>
<span class="n">write_type</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The type of write operation, enum on :class:`~cassandra.policies.WriteType`</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">message</span><span class="p">,</span> <span class="n">write_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">CoordinationFailure</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">message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_type</span> <span class="o">=</span> <span class="n">write_type</span></div>
<div class="viewcode-block" id="FunctionFailure"><a class="viewcode-back" href="../api/cassandra.html#cassandra.FunctionFailure">[docs]</a><span class="k">class</span> <span class="nc">FunctionFailure</span><span class="p">(</span><span class="n">RequestExecutionException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> User Defined Function failed during execution</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"> Keyspace of the function</span>
<span class="sd"> """</span>
<span class="n">function</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> Name of the function</span>
<span class="sd"> """</span>
<span class="n">arg_types</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> List of argument type names of the function</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">summary_message</span><span class="p">,</span> <span class="n">keyspace</span><span class="p">,</span> <span class="n">function</span><span class="p">,</span> <span class="n">arg_types</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="bp">self</span><span class="o">.</span><span class="n">function</span> <span class="o">=</span> <span class="n">function</span>
<span class="bp">self</span><span class="o">.</span><span class="n">arg_types</span> <span class="o">=</span> <span class="n">arg_types</span>
<span class="ne">Exception</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">summary_message</span><span class="p">)</span></div>
<div class="viewcode-block" id="RequestValidationException"><a class="viewcode-back" href="../api/cassandra.html#cassandra.RequestValidationException">[docs]</a><span class="k">class</span> <span class="nc">RequestValidationException</span><span class="p">(</span><span class="n">DriverException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Server request validation failed</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="ConfigurationException"><a class="viewcode-back" href="../api/cassandra.html#cassandra.ConfigurationException">[docs]</a><span class="k">class</span> <span class="nc">ConfigurationException</span><span class="p">(</span><span class="n">RequestValidationException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Server indicated request errro due to current configuration</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="AlreadyExists"><a class="viewcode-back" href="../api/cassandra.html#cassandra.AlreadyExists">[docs]</a><span class="k">class</span> <span class="nc">AlreadyExists</span><span class="p">(</span><span class="n">ConfigurationException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An attempt was made to create a keyspace or table that already exists.</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 name of the keyspace that already exists, or, if an attempt was</span>
<span class="sd"> made to create a new table, the keyspace that the table is in.</span>
<span class="sd"> """</span>
<span class="n">table</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The name of the table that already exists, or, if an attempt was</span>
<span class="sd"> make to create a keyspace, :const:`None`.</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">keyspace</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">table</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="n">table</span><span class="p">:</span>
<span class="n">message</span> <span class="o">=</span> <span class="s2">"Table '</span><span class="si">%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2">' already exists"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyspace</span><span class="p">,</span> <span class="n">table</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">message</span> <span class="o">=</span> <span class="s2">"Keyspace '</span><span class="si">%s</span><span class="s2">' already exists"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyspace</span><span class="p">,)</span>
<span class="ne">Exception</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">message</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="bp">self</span><span class="o">.</span><span class="n">table</span> <span class="o">=</span> <span class="n">table</span></div>
<div class="viewcode-block" id="InvalidRequest"><a class="viewcode-back" href="../api/cassandra.html#cassandra.InvalidRequest">[docs]</a><span class="k">class</span> <span class="nc">InvalidRequest</span><span class="p">(</span><span class="n">RequestValidationException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A query was made that was invalid for some reason, such as trying to set</span>
<span class="sd"> the keyspace for a connection to a nonexistent keyspace.</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="Unauthorized"><a class="viewcode-back" href="../api/cassandra.html#cassandra.Unauthorized">[docs]</a><span class="k">class</span> <span class="nc">Unauthorized</span><span class="p">(</span><span class="n">RequestValidationException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> The current user is not authorized to perform the requested operation.</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="AuthenticationFailed"><a class="viewcode-back" href="../api/cassandra.html#cassandra.AuthenticationFailed">[docs]</a><span class="k">class</span> <span class="nc">AuthenticationFailed</span><span class="p">(</span><span class="n">DriverException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Failed to authenticate.</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="OperationTimedOut"><a class="viewcode-back" href="../api/cassandra.html#cassandra.OperationTimedOut">[docs]</a><span class="k">class</span> <span class="nc">OperationTimedOut</span><span class="p">(</span><span class="n">DriverException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> The operation took longer than the specified (client-side) timeout</span>
<span class="sd"> to complete. This is not an error generated by Cassandra, only</span>
<span class="sd"> the driver.</span>
<span class="sd"> """</span>
<span class="n">errors</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> A dict of errors keyed by the :class:`~.Host` against which they occurred.</span>
<span class="sd"> """</span>
<span class="n">last_host</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd"> The last :class:`~.Host` this operation was attempted against.</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">errors</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">last_host</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">errors</span> <span class="o">=</span> <span class="n">errors</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_host</span> <span class="o">=</span> <span class="n">last_host</span>
<span class="n">message</span> <span class="o">=</span> <span class="s2">"errors=</span><span class="si">%s</span><span class="s2">, last_host=</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">errors</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_host</span><span class="p">)</span>
<span class="ne">Exception</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">message</span><span class="p">)</span></div>
<span class="k">class</span> <span class="nc">UnsupportedOperation</span><span class="p">(</span><span class="n">DriverException</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An attempt was made to use a feature that is not supported by the</span>
<span class="sd"> selected protocol version. See :attr:`Cluster.protocol_version`</span>
<span class="sd"> for more details.</span>
<span class="sd"> """</span>
<span class="k">pass</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">Cassandra Driver</a></h1>
<p class="blurb">Python driver for Cassandra</p>
<p>
<iframe src="https://ghbtns.com/github-btn.html?user=datastax&repo=python-driver&type=star&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/index.html">API Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="../execution_profiles.html">Execution Profiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../performance.html">Performance Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../query_paging.html">Paging Large Queries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lwt.html">Lightweight Transactions (Compare-and-set)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user_defined_types.html">User Defined Types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../object_mapper.html">Object Mapper</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dates_and_times.html">Working with Dates and Times</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2013-2017 DataStax.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
</div>
</body>
</html>