Repository navigation
Expand file tree
/
Copy pathmanagement.html
More file actions
670 lines (505 loc) · 88.7 KB
/
Copy pathmanagement.html
File metadata and controls
670 lines (505 loc) · 88.7 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
<!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.cqlengine.management — 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.cqlengine.management</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">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">namedtuple</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">from</span> <span class="nn">itertools</span> <span class="k">import</span> <span class="n">product</span>
<span class="kn">from</span> <span class="nn">cassandra</span> <span class="k">import</span> <span class="n">metadata</span>
<span class="kn">from</span> <span class="nn">cassandra.cqlengine</span> <span class="k">import</span> <span class="n">CQLEngineException</span>
<span class="kn">from</span> <span class="nn">cassandra.cqlengine</span> <span class="k">import</span> <span class="n">columns</span><span class="p">,</span> <span class="n">query</span>
<span class="kn">from</span> <span class="nn">cassandra.cqlengine.connection</span> <span class="k">import</span> <span class="n">execute</span><span class="p">,</span> <span class="n">get_cluster</span><span class="p">,</span> <span class="n">format_log_context</span>
<span class="kn">from</span> <span class="nn">cassandra.cqlengine.models</span> <span class="k">import</span> <span class="n">Model</span>
<span class="kn">from</span> <span class="nn">cassandra.cqlengine.named</span> <span class="k">import</span> <span class="n">NamedTable</span>
<span class="kn">from</span> <span class="nn">cassandra.cqlengine.usertype</span> <span class="k">import</span> <span class="n">UserType</span>
<span class="n">CQLENG_ALLOW_SCHEMA_MANAGEMENT</span> <span class="o">=</span> <span class="s1">'CQLENG_ALLOW_SCHEMA_MANAGEMENT'</span>
<span class="n">Field</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span><span class="s1">'Field'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'name'</span><span class="p">,</span> <span class="s1">'type'</span><span class="p">])</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="c1"># system keyspaces</span>
<span class="n">schema_columnfamilies</span> <span class="o">=</span> <span class="n">NamedTable</span><span class="p">(</span><span class="s1">'system'</span><span class="p">,</span> <span class="s1">'schema_columnfamilies'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_context</span><span class="p">(</span><span class="n">keyspaces</span><span class="p">,</span> <span class="n">connections</span><span class="p">):</span>
<span class="sd">"""Return all the execution contexts"""</span>
<span class="k">if</span> <span class="n">keyspaces</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">keyspaces</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">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'keyspaces must be a list or a tuple.'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">connections</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">connections</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">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'connections must be a list or a tuple.'</span><span class="p">)</span>
<span class="n">keyspaces</span> <span class="o">=</span> <span class="n">keyspaces</span> <span class="k">if</span> <span class="n">keyspaces</span> <span class="k">else</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span>
<span class="n">connections</span> <span class="o">=</span> <span class="n">connections</span> <span class="k">if</span> <span class="n">connections</span> <span class="k">else</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span>
<span class="k">return</span> <span class="n">product</span><span class="p">(</span><span class="n">connections</span><span class="p">,</span> <span class="n">keyspaces</span><span class="p">)</span>
<div class="viewcode-block" id="create_keyspace_simple"><a class="viewcode-back" href="../../../api/cassandra/cqlengine/management.html#cassandra.cqlengine.management.create_keyspace_simple">[docs]</a><span class="k">def</span> <span class="nf">create_keyspace_simple</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">replication_factor</span><span class="p">,</span> <span class="n">durable_writes</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">connections</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creates a keyspace with SimpleStrategy for replica placement</span>
<span class="sd"> If the keyspace already exists, it will not be modified.</span>
<span class="sd"> **This function should be used with caution, especially in production environments.</span>
<span class="sd"> Take care to execute schema modifications in a single context (i.e. not concurrently with other clients).**</span>
<span class="sd"> *There are plans to guard schema-modifying functions with an environment-driven conditional.*</span>
<span class="sd"> :param str name: name of keyspace to create</span>
<span class="sd"> :param int replication_factor: keyspace replication factor, used with :attr:`~.SimpleStrategy`</span>
<span class="sd"> :param bool durable_writes: Write log is bypassed if set to False</span>
<span class="sd"> :param list connections: List of connection names</span>
<span class="sd"> """</span>
<span class="n">_create_keyspace</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">durable_writes</span><span class="p">,</span> <span class="s1">'SimpleStrategy'</span><span class="p">,</span>
<span class="p">{</span><span class="s1">'replication_factor'</span><span class="p">:</span> <span class="n">replication_factor</span><span class="p">},</span> <span class="n">connections</span><span class="o">=</span><span class="n">connections</span><span class="p">)</span></div>
<div class="viewcode-block" id="create_keyspace_network_topology"><a class="viewcode-back" href="../../../api/cassandra/cqlengine/management.html#cassandra.cqlengine.management.create_keyspace_network_topology">[docs]</a><span class="k">def</span> <span class="nf">create_keyspace_network_topology</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">dc_replication_map</span><span class="p">,</span> <span class="n">durable_writes</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">connections</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creates a keyspace with NetworkTopologyStrategy for replica placement</span>
<span class="sd"> If the keyspace already exists, it will not be modified.</span>
<span class="sd"> **This function should be used with caution, especially in production environments.</span>
<span class="sd"> Take care to execute schema modifications in a single context (i.e. not concurrently with other clients).**</span>
<span class="sd"> *There are plans to guard schema-modifying functions with an environment-driven conditional.*</span>
<span class="sd"> :param str name: name of keyspace to create</span>
<span class="sd"> :param dict dc_replication_map: map of dc_names: replication_factor</span>
<span class="sd"> :param bool durable_writes: Write log is bypassed if set to False</span>
<span class="sd"> :param list connections: List of connection names</span>
<span class="sd"> """</span>
<span class="n">_create_keyspace</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">durable_writes</span><span class="p">,</span> <span class="s1">'NetworkTopologyStrategy'</span><span class="p">,</span> <span class="n">dc_replication_map</span><span class="p">,</span> <span class="n">connections</span><span class="o">=</span><span class="n">connections</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_create_keyspace</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">durable_writes</span><span class="p">,</span> <span class="n">strategy_class</span><span class="p">,</span> <span class="n">strategy_options</span><span class="p">,</span> <span class="n">connections</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_allow_schema_modification</span><span class="p">():</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">connections</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">connections</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">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Connections must be a list or a tuple.'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__create_keyspace</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">durable_writes</span><span class="p">,</span> <span class="n">strategy_class</span><span class="p">,</span> <span class="n">strategy_options</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">cluster</span> <span class="o">=</span> <span class="n">get_cluster</span><span class="p">(</span><span class="n">connection</span><span class="p">)</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">cluster</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">keyspaces</span><span class="p">:</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">format_log_context</span><span class="p">(</span><span class="s2">"Creating keyspace </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">),</span> <span class="n">name</span><span class="p">)</span>
<span class="n">ks_meta</span> <span class="o">=</span> <span class="n">metadata</span><span class="o">.</span><span class="n">KeyspaceMetadata</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">durable_writes</span><span class="p">,</span> <span class="n">strategy_class</span><span class="p">,</span> <span class="n">strategy_options</span><span class="p">)</span>
<span class="n">execute</span><span class="p">(</span><span class="n">ks_meta</span><span class="o">.</span><span class="n">as_cql_query</span><span class="p">(),</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">format_log_context</span><span class="p">(</span><span class="s2">"Not creating keyspace </span><span class="si">%s</span><span class="s2"> because it already exists"</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">),</span> <span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">connections</span><span class="p">:</span>
<span class="k">for</span> <span class="n">connection</span> <span class="ow">in</span> <span class="n">connections</span><span class="p">:</span>
<span class="n">__create_keyspace</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">durable_writes</span><span class="p">,</span> <span class="n">strategy_class</span><span class="p">,</span> <span class="n">strategy_options</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">__create_keyspace</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">durable_writes</span><span class="p">,</span> <span class="n">strategy_class</span><span class="p">,</span> <span class="n">strategy_options</span><span class="p">)</span>
<div class="viewcode-block" id="drop_keyspace"><a class="viewcode-back" href="../../../api/cassandra/cqlengine/management.html#cassandra.cqlengine.management.drop_keyspace">[docs]</a><span class="k">def</span> <span class="nf">drop_keyspace</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">connections</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Drops a keyspace, if it exists.</span>
<span class="sd"> *There are plans to guard schema-modifying functions with an environment-driven conditional.*</span>
<span class="sd"> **This function should be used with caution, especially in production environments.</span>
<span class="sd"> Take care to execute schema modifications in a single context (i.e. not concurrently with other clients).**</span>
<span class="sd"> :param str name: name of keyspace to drop</span>
<span class="sd"> :param list connections: List of connection names</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_allow_schema_modification</span><span class="p">():</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">connections</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">connections</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">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Connections must be a list or a tuple.'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_drop_keyspace</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">cluster</span> <span class="o">=</span> <span class="n">get_cluster</span><span class="p">(</span><span class="n">connection</span><span class="p">)</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">cluster</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">keyspaces</span><span class="p">:</span>
<span class="n">execute</span><span class="p">(</span><span class="s2">"DROP KEYSPACE </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">metadata</span><span class="o">.</span><span class="n">protect_name</span><span class="p">(</span><span class="n">name</span><span class="p">)),</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">if</span> <span class="n">connections</span><span class="p">:</span>
<span class="k">for</span> <span class="n">connection</span> <span class="ow">in</span> <span class="n">connections</span><span class="p">:</span>
<span class="n">_drop_keyspace</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">connection</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">_drop_keyspace</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_get_index_name_by_column</span><span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="n">column_name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Find the index name for a given table and column.</span>
<span class="sd"> """</span>
<span class="n">protected_name</span> <span class="o">=</span> <span class="n">metadata</span><span class="o">.</span><span class="n">protect_name</span><span class="p">(</span><span class="n">column_name</span><span class="p">)</span>
<span class="n">possible_index_values</span> <span class="o">=</span> <span class="p">[</span><span class="n">protected_name</span><span class="p">,</span> <span class="s2">"values(</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="n">protected_name</span><span class="p">]</span>
<span class="k">for</span> <span class="n">index_metadata</span> <span class="ow">in</span> <span class="n">table</span><span class="o">.</span><span class="n">indexes</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">options</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">index_metadata</span><span class="o">.</span><span class="n">index_options</span><span class="p">)</span>
<span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'target'</span><span class="p">)</span> <span class="ow">in</span> <span class="n">possible_index_values</span><span class="p">:</span>
<span class="k">return</span> <span class="n">index_metadata</span><span class="o">.</span><span class="n">name</span>
<div class="viewcode-block" id="sync_table"><a class="viewcode-back" href="../../../api/cassandra/cqlengine/management.html#cassandra.cqlengine.management.sync_table">[docs]</a><span class="k">def</span> <span class="nf">sync_table</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">keyspaces</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">connections</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Inspects the model and creates / updates the corresponding table and columns.</span>
<span class="sd"> If `keyspaces` is specified, the table will be synched for all specified keyspaces.</span>
<span class="sd"> Note that the `Model.__keyspace__` is ignored in that case.</span>
<span class="sd"> If `connections` is specified, the table will be synched for all specified connections. Note that the `Model.__connection__` is ignored in that case.</span>
<span class="sd"> If not specified, it will try to get the connection from the Model.</span>
<span class="sd"> Any User Defined Types used in the table are implicitly synchronized.</span>
<span class="sd"> This function can only add fields that are not part of the primary key.</span>
<span class="sd"> Note that the attributes removed from the model are not deleted on the database.</span>
<span class="sd"> They become effectively ignored by (will not show up on) the model.</span>
<span class="sd"> **This function should be used with caution, especially in production environments.</span>
<span class="sd"> Take care to execute schema modifications in a single context (i.e. not concurrently with other clients).**</span>
<span class="sd"> *There are plans to guard schema-modifying functions with an environment-driven conditional.*</span>
<span class="sd"> """</span>
<span class="n">context</span> <span class="o">=</span> <span class="n">_get_context</span><span class="p">(</span><span class="n">keyspaces</span><span class="p">,</span> <span class="n">connections</span><span class="p">)</span>
<span class="k">for</span> <span class="n">connection</span><span class="p">,</span> <span class="n">keyspace</span> <span class="ow">in</span> <span class="n">context</span><span class="p">:</span>
<span class="k">with</span> <span class="n">query</span><span class="o">.</span><span class="n">ContextQuery</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">keyspace</span><span class="p">)</span> <span class="k">as</span> <span class="n">m</span><span class="p">:</span>
<span class="n">_sync_table</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_sync_table</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_allow_schema_modification</span><span class="p">():</span>
<span class="k">return</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">Model</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">CQLEngineException</span><span class="p">(</span><span class="s2">"Models must be derived from base Model."</span><span class="p">)</span>
<span class="k">if</span> <span class="n">model</span><span class="o">.</span><span class="n">__abstract__</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">CQLEngineException</span><span class="p">(</span><span class="s2">"cannot create table from abstract model"</span><span class="p">)</span>
<span class="n">cf_name</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">column_family_name</span><span class="p">()</span>
<span class="n">raw_cf_name</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">_raw_column_family_name</span><span class="p">()</span>
<span class="n">ks_name</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">_get_keyspace</span><span class="p">()</span>
<span class="n">connection</span> <span class="o">=</span> <span class="n">connection</span> <span class="ow">or</span> <span class="n">model</span><span class="o">.</span><span class="n">_get_connection</span><span class="p">()</span>
<span class="n">cluster</span> <span class="o">=</span> <span class="n">get_cluster</span><span class="p">(</span><span class="n">connection</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">keyspace</span> <span class="o">=</span> <span class="n">cluster</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">keyspaces</span><span class="p">[</span><span class="n">ks_name</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">format_log_context</span><span class="p">(</span><span class="s2">"Keyspace '</span><span class="si">{0}</span><span class="s2">' for model </span><span class="si">{1}</span><span class="s2"> does not exist."</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">CQLEngineException</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">model</span><span class="p">))</span>
<span class="n">tables</span> <span class="o">=</span> <span class="n">keyspace</span><span class="o">.</span><span class="n">tables</span>
<span class="n">syncd_types</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">_columns</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">udts</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">columns</span><span class="o">.</span><span class="n">resolve_udts</span><span class="p">(</span><span class="n">col</span><span class="p">,</span> <span class="n">udts</span><span class="p">)</span>
<span class="k">for</span> <span class="n">udt</span> <span class="ow">in</span> <span class="p">[</span><span class="n">u</span> <span class="k">for</span> <span class="n">u</span> <span class="ow">in</span> <span class="n">udts</span> <span class="k">if</span> <span class="n">u</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">syncd_types</span><span class="p">]:</span>
<span class="n">_sync_type</span><span class="p">(</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">udt</span><span class="p">,</span> <span class="n">syncd_types</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">if</span> <span class="n">raw_cf_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">tables</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="n">format_log_context</span><span class="p">(</span><span class="s2">"sync_table creating new table </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">),</span> <span class="n">cf_name</span><span class="p">)</span>
<span class="n">qs</span> <span class="o">=</span> <span class="n">_get_create_table</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">execute</span><span class="p">(</span><span class="n">qs</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">except</span> <span class="n">CQLEngineException</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
<span class="c1"># 1.2 doesn't return cf names, so we have to examine the exception</span>
<span class="c1"># and ignore if it says the column family already exists</span>
<span class="k">if</span> <span class="s2">"Cannot add already existing column family"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">unicode</span><span class="p">(</span><span class="n">ex</span><span class="p">):</span>
<span class="k">raise</span>
<span class="k">else</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="n">format_log_context</span><span class="p">(</span><span class="s2">"sync_table checking existing table </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">),</span> <span class="n">cf_name</span><span class="p">)</span>
<span class="n">table_meta</span> <span class="o">=</span> <span class="n">tables</span><span class="p">[</span><span class="n">raw_cf_name</span><span class="p">]</span>
<span class="n">_validate_pk</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">table_meta</span><span class="p">)</span>
<span class="n">table_columns</span> <span class="o">=</span> <span class="n">table_meta</span><span class="o">.</span><span class="n">columns</span>
<span class="n">model_fields</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">for</span> <span class="n">model_name</span><span class="p">,</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">_columns</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">db_name</span> <span class="o">=</span> <span class="n">col</span><span class="o">.</span><span class="n">db_field_name</span>
<span class="n">model_fields</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">db_name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">db_name</span> <span class="ow">in</span> <span class="n">table_columns</span><span class="p">:</span>
<span class="n">col_meta</span> <span class="o">=</span> <span class="n">table_columns</span><span class="p">[</span><span class="n">db_name</span><span class="p">]</span>
<span class="k">if</span> <span class="n">col_meta</span><span class="o">.</span><span class="n">cql_type</span> <span class="o">!=</span> <span class="n">col</span><span class="o">.</span><span class="n">db_type</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">format_log_context</span><span class="p">(</span><span class="s1">'Existing table </span><span class="si">{0}</span><span class="s1"> has column "</span><span class="si">{1}</span><span class="s1">" with a type (</span><span class="si">{2}</span><span class="s1">) differing from the model type (</span><span class="si">{3}</span><span class="s1">).'</span>
<span class="s1">' Model should be updated.'</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">cf_name</span><span class="p">,</span> <span class="n">db_name</span><span class="p">,</span> <span class="n">col_meta</span><span class="o">.</span><span class="n">cql_type</span><span class="p">,</span> <span class="n">col</span><span class="o">.</span><span class="n">db_type</span><span class="p">)</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">col</span><span class="o">.</span><span class="n">primary_key</span> <span class="ow">or</span> <span class="n">col</span><span class="o">.</span><span class="n">primary_key</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">format_log_context</span><span class="p">(</span><span class="s2">"Cannot add primary key '</span><span class="si">{0}</span><span class="s2">' (with db_field '</span><span class="si">{1}</span><span class="s2">') to existing table </span><span class="si">{2}</span><span class="s2">"</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">CQLEngineException</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model_name</span><span class="p">,</span> <span class="n">db_name</span><span class="p">,</span> <span class="n">cf_name</span><span class="p">))</span>
<span class="n">query</span> <span class="o">=</span> <span class="s2">"ALTER TABLE </span><span class="si">{0}</span><span class="s2"> add </span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">cf_name</span><span class="p">,</span> <span class="n">col</span><span class="o">.</span><span class="n">get_column_def</span><span class="p">())</span>
<span class="n">execute</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="n">db_fields_not_in_model</span> <span class="o">=</span> <span class="n">model_fields</span><span class="o">.</span><span class="n">symmetric_difference</span><span class="p">(</span><span class="n">table_columns</span><span class="p">)</span>
<span class="k">if</span> <span class="n">db_fields_not_in_model</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">format_log_context</span><span class="p">(</span><span class="s2">"Table </span><span class="si">{0}</span><span class="s2"> has fields not referenced by model: </span><span class="si">{1}</span><span class="s2">"</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">cf_name</span><span class="p">,</span> <span class="n">db_fields_not_in_model</span><span class="p">))</span>
<span class="n">_update_options</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="n">table</span> <span class="o">=</span> <span class="n">cluster</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">keyspaces</span><span class="p">[</span><span class="n">ks_name</span><span class="p">]</span><span class="o">.</span><span class="n">tables</span><span class="p">[</span><span class="n">raw_cf_name</span><span class="p">]</span>
<span class="n">indexes</span> <span class="o">=</span> <span class="p">[</span><span class="n">c</span> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">_columns</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">index</span><span class="p">]</span>
<span class="c1"># TODO: support multiple indexes in C* 3.0+</span>
<span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="n">indexes</span><span class="p">:</span>
<span class="n">index_name</span> <span class="o">=</span> <span class="n">_get_index_name_by_column</span><span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="n">column</span><span class="o">.</span><span class="n">db_field_name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">index_name</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">qs</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'CREATE INDEX'</span><span class="p">]</span>
<span class="n">qs</span> <span class="o">+=</span> <span class="p">[</span><span class="s1">'ON </span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">cf_name</span><span class="p">)]</span>
<span class="n">qs</span> <span class="o">+=</span> <span class="p">[</span><span class="s1">'("</span><span class="si">{0}</span><span class="s1">")'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">column</span><span class="o">.</span><span class="n">db_field_name</span><span class="p">)]</span>
<span class="n">qs</span> <span class="o">=</span> <span class="s1">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">qs</span><span class="p">)</span>
<span class="n">execute</span><span class="p">(</span><span class="n">qs</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_validate_pk</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">table_meta</span><span class="p">):</span>
<span class="n">model_partition</span> <span class="o">=</span> <span class="p">[</span><span class="n">c</span><span class="o">.</span><span class="n">db_field_name</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">_partition_keys</span><span class="o">.</span><span class="n">values</span><span class="p">()]</span>
<span class="n">meta_partition</span> <span class="o">=</span> <span class="p">[</span><span class="n">c</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">table_meta</span><span class="o">.</span><span class="n">partition_key</span><span class="p">]</span>
<span class="n">model_clustering</span> <span class="o">=</span> <span class="p">[</span><span class="n">c</span><span class="o">.</span><span class="n">db_field_name</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">_clustering_keys</span><span class="o">.</span><span class="n">values</span><span class="p">()]</span>
<span class="n">meta_clustering</span> <span class="o">=</span> <span class="p">[</span><span class="n">c</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">table_meta</span><span class="o">.</span><span class="n">clustering_key</span><span class="p">]</span>
<span class="k">if</span> <span class="n">model_partition</span> <span class="o">!=</span> <span class="n">meta_partition</span> <span class="ow">or</span> <span class="n">model_clustering</span> <span class="o">!=</span> <span class="n">meta_clustering</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">_pk_string</span><span class="p">(</span><span class="n">partition</span><span class="p">,</span> <span class="n">clustering</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">"PRIMARY KEY ((</span><span class="si">{0}</span><span class="s2">)</span><span class="si">{1}</span><span class="s2">)"</span><span class="o">.</span><span class="n">format</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">partition</span><span class="p">),</span> <span class="s1">', '</span> <span class="o">+</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">clustering</span><span class="p">)</span> <span class="k">if</span> <span class="n">clustering</span> <span class="k">else</span> <span class="s1">''</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">CQLEngineException</span><span class="p">(</span><span class="s2">"Model </span><span class="si">{0}</span><span class="s2"> PRIMARY KEY composition does not match existing table </span><span class="si">{1}</span><span class="s2">. "</span>
<span class="s2">"Model: </span><span class="si">{2}</span><span class="s2">; Table: </span><span class="si">{3}</span><span class="s2">. "</span>
<span class="s2">"Update model or drop the table."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">model</span><span class="o">.</span><span class="n">column_family_name</span><span class="p">(),</span>
<span class="n">_pk_string</span><span class="p">(</span><span class="n">model_partition</span><span class="p">,</span> <span class="n">model_clustering</span><span class="p">),</span>
<span class="n">_pk_string</span><span class="p">(</span><span class="n">meta_partition</span><span class="p">,</span> <span class="n">meta_clustering</span><span class="p">)))</span>
<div class="viewcode-block" id="sync_type"><a class="viewcode-back" href="../../../api/cassandra/cqlengine/management.html#cassandra.cqlengine.management.sync_type">[docs]</a><span class="k">def</span> <span class="nf">sync_type</span><span class="p">(</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">type_model</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Inspects the type_model and creates / updates the corresponding type.</span>
<span class="sd"> Note that the attributes removed from the type_model are not deleted on the database (this operation is not supported).</span>
<span class="sd"> They become effectively ignored by (will not show up on) the type_model.</span>
<span class="sd"> **This function should be used with caution, especially in production environments.</span>
<span class="sd"> Take care to execute schema modifications in a single context (i.e. not concurrently with other clients).**</span>
<span class="sd"> *There are plans to guard schema-modifying functions with an environment-driven conditional.*</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_allow_schema_modification</span><span class="p">():</span>
<span class="k">return</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">type_model</span><span class="p">,</span> <span class="n">UserType</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">CQLEngineException</span><span class="p">(</span><span class="s2">"Types must be derived from base UserType."</span><span class="p">)</span>
<span class="n">_sync_type</span><span class="p">(</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">type_model</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_sync_type</span><span class="p">(</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">type_model</span><span class="p">,</span> <span class="n">omit_subtypes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">syncd_sub_types</span> <span class="o">=</span> <span class="n">omit_subtypes</span> <span class="ow">or</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">type_model</span><span class="o">.</span><span class="n">_fields</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">udts</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">columns</span><span class="o">.</span><span class="n">resolve_udts</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">udts</span><span class="p">)</span>
<span class="k">for</span> <span class="n">udt</span> <span class="ow">in</span> <span class="p">[</span><span class="n">u</span> <span class="k">for</span> <span class="n">u</span> <span class="ow">in</span> <span class="n">udts</span> <span class="k">if</span> <span class="n">u</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">syncd_sub_types</span><span class="p">]:</span>
<span class="n">_sync_type</span><span class="p">(</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">udt</span><span class="p">,</span> <span class="n">syncd_sub_types</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="n">syncd_sub_types</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">udt</span><span class="p">)</span>
<span class="n">type_name</span> <span class="o">=</span> <span class="n">type_model</span><span class="o">.</span><span class="n">type_name</span><span class="p">()</span>
<span class="n">type_name_qualified</span> <span class="o">=</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">ks_name</span><span class="p">,</span> <span class="n">type_name</span><span class="p">)</span>
<span class="n">cluster</span> <span class="o">=</span> <span class="n">get_cluster</span><span class="p">(</span><span class="n">connection</span><span class="p">)</span>
<span class="n">keyspace</span> <span class="o">=</span> <span class="n">cluster</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">keyspaces</span><span class="p">[</span><span class="n">ks_name</span><span class="p">]</span>
<span class="n">defined_types</span> <span class="o">=</span> <span class="n">keyspace</span><span class="o">.</span><span class="n">user_types</span>
<span class="k">if</span> <span class="n">type_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">defined_types</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="n">format_log_context</span><span class="p">(</span><span class="s2">"sync_type creating new type </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">),</span> <span class="n">type_name_qualified</span><span class="p">)</span>
<span class="n">cql</span> <span class="o">=</span> <span class="n">get_create_type</span><span class="p">(</span><span class="n">type_model</span><span class="p">,</span> <span class="n">ks_name</span><span class="p">)</span>
<span class="n">execute</span><span class="p">(</span><span class="n">cql</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="n">cluster</span><span class="o">.</span><span class="n">refresh_user_type_metadata</span><span class="p">(</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">type_name</span><span class="p">)</span>
<span class="n">type_model</span><span class="o">.</span><span class="n">register_for_keyspace</span><span class="p">(</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">type_meta</span> <span class="o">=</span> <span class="n">defined_types</span><span class="p">[</span><span class="n">type_name</span><span class="p">]</span>
<span class="n">defined_fields</span> <span class="o">=</span> <span class="n">type_meta</span><span class="o">.</span><span class="n">field_names</span>
<span class="n">model_fields</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">type_model</span><span class="o">.</span><span class="n">_fields</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">model_fields</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">field</span><span class="o">.</span><span class="n">db_field_name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">field</span><span class="o">.</span><span class="n">db_field_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">defined_fields</span><span class="p">:</span>
<span class="n">execute</span><span class="p">(</span><span class="s2">"ALTER TYPE </span><span class="si">{0}</span><span class="s2"> ADD </span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">type_name_qualified</span><span class="p">,</span> <span class="n">field</span><span class="o">.</span><span class="n">get_column_def</span><span class="p">()),</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">field_type</span> <span class="o">=</span> <span class="n">type_meta</span><span class="o">.</span><span class="n">field_types</span><span class="p">[</span><span class="n">defined_fields</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">field</span><span class="o">.</span><span class="n">db_field_name</span><span class="p">)]</span>
<span class="k">if</span> <span class="n">field_type</span> <span class="o">!=</span> <span class="n">field</span><span class="o">.</span><span class="n">db_type</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">format_log_context</span><span class="p">(</span><span class="s1">'Existing user type </span><span class="si">{0}</span><span class="s1"> has field "</span><span class="si">{1}</span><span class="s1">" with a type (</span><span class="si">{2}</span><span class="s1">) differing from the model user type (</span><span class="si">{3}</span><span class="s1">).'</span>
<span class="s1">' UserType should be updated.'</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">type_name_qualified</span><span class="p">,</span> <span class="n">field</span><span class="o">.</span><span class="n">db_field_name</span><span class="p">,</span> <span class="n">field_type</span><span class="p">,</span> <span class="n">field</span><span class="o">.</span><span class="n">db_type</span><span class="p">)</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="n">type_model</span><span class="o">.</span><span class="n">register_for_keyspace</span><span class="p">(</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">defined_fields</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">model_fields</span><span class="p">):</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">format_log_context</span><span class="p">(</span><span class="s2">"Type </span><span class="si">%s</span><span class="s2"> did not require synchronization"</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">),</span> <span class="n">type_name_qualified</span><span class="p">)</span>
<span class="k">return</span>
<span class="n">db_fields_not_in_model</span> <span class="o">=</span> <span class="n">model_fields</span><span class="o">.</span><span class="n">symmetric_difference</span><span class="p">(</span><span class="n">defined_fields</span><span class="p">)</span>
<span class="k">if</span> <span class="n">db_fields_not_in_model</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">format_log_context</span><span class="p">(</span><span class="s2">"Type </span><span class="si">%s</span><span class="s2"> has fields not referenced by model: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">type_name_qualified</span><span class="p">,</span> <span class="n">db_fields_not_in_model</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_create_type</span><span class="p">(</span><span class="n">type_model</span><span class="p">,</span> <span class="n">keyspace</span><span class="p">):</span>
<span class="n">type_meta</span> <span class="o">=</span> <span class="n">metadata</span><span class="o">.</span><span class="n">UserType</span><span class="p">(</span><span class="n">keyspace</span><span class="p">,</span>
<span class="n">type_model</span><span class="o">.</span><span class="n">type_name</span><span class="p">(),</span>
<span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">db_field_name</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">type_model</span><span class="o">.</span><span class="n">_fields</span><span class="o">.</span><span class="n">values</span><span class="p">()),</span>
<span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">db_type</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">type_model</span><span class="o">.</span><span class="n">_fields</span><span class="o">.</span><span class="n">values</span><span class="p">()))</span>
<span class="k">return</span> <span class="n">type_meta</span><span class="o">.</span><span class="n">as_cql_query</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_get_create_table</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
<span class="n">ks_table_name</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">column_family_name</span><span class="p">()</span>
<span class="n">query_strings</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'CREATE TABLE </span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">ks_table_name</span><span class="p">)]</span>
<span class="c1"># add column types</span>
<span class="n">pkeys</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># primary keys</span>
<span class="n">ckeys</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># clustering keys</span>
<span class="n">qtypes</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># field types</span>
<span class="k">def</span> <span class="nf">add_column</span><span class="p">(</span><span class="n">col</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">col</span><span class="o">.</span><span class="n">get_column_def</span><span class="p">()</span>
<span class="k">if</span> <span class="n">col</span><span class="o">.</span><span class="n">primary_key</span><span class="p">:</span>
<span class="n">keys</span> <span class="o">=</span> <span class="p">(</span><span class="n">pkeys</span> <span class="k">if</span> <span class="n">col</span><span class="o">.</span><span class="n">partition_key</span> <span class="k">else</span> <span class="n">ckeys</span><span class="p">)</span>
<span class="n">keys</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'"</span><span class="si">{0}</span><span class="s1">"'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">col</span><span class="o">.</span><span class="n">db_field_name</span><span class="p">))</span>
<span class="n">qtypes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">_columns</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">add_column</span><span class="p">(</span><span class="n">col</span><span class="p">)</span>
<span class="n">qtypes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'PRIMARY KEY ((</span><span class="si">{0}</span><span class="s1">)</span><span class="si">{1}</span><span class="s1">)'</span><span class="o">.</span><span class="n">format</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">pkeys</span><span class="p">),</span> <span class="n">ckeys</span> <span class="ow">and</span> <span class="s1">', '</span> <span class="o">+</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">ckeys</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">))</span>
<span class="n">query_strings</span> <span class="o">+=</span> <span class="p">[</span><span class="s1">'(</span><span class="si">{0}</span><span class="s1">)'</span><span class="o">.</span><span class="n">format</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">qtypes</span><span class="p">))]</span>
<span class="n">property_strings</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">_order</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'"</span><span class="si">{0}</span><span class="s1">" </span><span class="si">{1}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">db_field_name</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">clustering_order</span> <span class="ow">or</span> <span class="s1">'ASC'</span><span class="p">)</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">_clustering_keys</span><span class="o">.</span><span class="n">values</span><span class="p">()]</span>
<span class="k">if</span> <span class="n">_order</span><span class="p">:</span>
<span class="n">property_strings</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'CLUSTERING ORDER BY (</span><span class="si">{0}</span><span class="s1">)'</span><span class="o">.</span><span class="n">format</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">_order</span><span class="p">)))</span>
<span class="c1"># options strings use the V3 format, which matches CQL more closely and does not require mapping</span>
<span class="n">property_strings</span> <span class="o">+=</span> <span class="n">metadata</span><span class="o">.</span><span class="n">TableMetadataV3</span><span class="o">.</span><span class="n">_make_option_strings</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">__options__</span> <span class="ow">or</span> <span class="p">{})</span>
<span class="k">if</span> <span class="n">property_strings</span><span class="p">:</span>
<span class="n">query_strings</span> <span class="o">+=</span> <span class="p">[</span><span class="s1">'WITH </span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="s1">' AND '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">property_strings</span><span class="p">))]</span>
<span class="k">return</span> <span class="s1">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">query_strings</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_table_metadata</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># returns the table as provided by the native driver for a given model</span>
<span class="n">cluster</span> <span class="o">=</span> <span class="n">get_cluster</span><span class="p">(</span><span class="n">connection</span><span class="p">)</span>
<span class="n">ks</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">_get_keyspace</span><span class="p">()</span>
<span class="n">table</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">_raw_column_family_name</span><span class="p">()</span>
<span class="n">table</span> <span class="o">=</span> <span class="n">cluster</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">keyspaces</span><span class="p">[</span><span class="n">ks</span><span class="p">]</span><span class="o">.</span><span class="n">tables</span><span class="p">[</span><span class="n">table</span><span class="p">]</span>
<span class="k">return</span> <span class="n">table</span>
<span class="k">def</span> <span class="nf">_options_map_from_strings</span><span class="p">(</span><span class="n">option_strings</span><span class="p">):</span>
<span class="c1"># converts options strings to a mapping to strings or dict</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">option_strings</span><span class="p">:</span>
<span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="o">=</span> <span class="n">option</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'='</span><span class="p">)</span>
<span class="n">i</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">'{'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="p">[</span><span class="n">i</span><span class="p">:</span><span class="n">value</span><span class="o">.</span><span class="n">rfind</span><span class="p">(</span><span class="s1">'}'</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"'"</span><span class="p">,</span> <span class="s1">'"'</span><span class="p">)</span> <span class="c1"># from cql single quotes to json double; not aware of any values that would be escaped right now</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="n">options</span><span class="p">[</span><span class="n">name</span><span class="o">.</span><span class="n">strip</span><span class="p">()]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">return</span> <span class="n">options</span>
<span class="k">def</span> <span class="nf">_update_options</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Updates the table options for the given model if necessary.</span>
<span class="sd"> :param model: The model to update.</span>
<span class="sd"> :param connection: Name of the connection to use</span>
<span class="sd"> :return: `True`, if the options were modified in Cassandra,</span>
<span class="sd"> `False` otherwise.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="n">ks_name</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">_get_keyspace</span><span class="p">()</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">format_log_context</span><span class="p">(</span><span class="s2">"Checking </span><span class="si">%s</span><span class="s2"> for option differences"</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</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="n">msg</span><span class="p">,</span> <span class="n">model</span><span class="p">)</span>
<span class="n">model_options</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">__options__</span> <span class="ow">or</span> <span class="p">{}</span>
<span class="n">table_meta</span> <span class="o">=</span> <span class="n">_get_table_metadata</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="c1"># go to CQL string first to normalize meta from different versions</span>
<span class="n">existing_option_strings</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">table_meta</span><span class="o">.</span><span class="n">_make_option_strings</span><span class="p">(</span><span class="n">table_meta</span><span class="o">.</span><span class="n">options</span><span class="p">))</span>
<span class="n">existing_options</span> <span class="o">=</span> <span class="n">_options_map_from_strings</span><span class="p">(</span><span class="n">existing_option_strings</span><span class="p">)</span>
<span class="n">model_option_strings</span> <span class="o">=</span> <span class="n">metadata</span><span class="o">.</span><span class="n">TableMetadataV3</span><span class="o">.</span><span class="n">_make_option_strings</span><span class="p">(</span><span class="n">model_options</span><span class="p">)</span>
<span class="n">model_options</span> <span class="o">=</span> <span class="n">_options_map_from_strings</span><span class="p">(</span><span class="n">model_option_strings</span><span class="p">)</span>
<span class="n">update_options</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">model_options</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">existing_value</span> <span class="o">=</span> <span class="n">existing_options</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">msg</span> <span class="o">=</span> <span class="n">format_log_context</span><span class="p">(</span><span class="s2">"Invalid table option: '</span><span class="si">%s</span><span class="s2">'; known options: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">ks_name</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">msg</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">existing_options</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">existing_value</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">value</span> <span class="o">!=</span> <span class="n">existing_value</span><span class="p">:</span>
<span class="n">update_options</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</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">value</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">existing_value</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">!=</span> <span class="n">v</span><span class="p">:</span>
<span class="n">update_options</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">break</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="n">update_options</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">if</span> <span class="n">update_options</span><span class="p">:</span>
<span class="n">options</span> <span class="o">=</span> <span class="s1">' AND '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">metadata</span><span class="o">.</span><span class="n">TableMetadataV3</span><span class="o">.</span><span class="n">_make_option_strings</span><span class="p">(</span><span class="n">update_options</span><span class="p">))</span>
<span class="n">query</span> <span class="o">=</span> <span class="s2">"ALTER TABLE </span><span class="si">{0}</span><span class="s2"> WITH </span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">column_family_name</span><span class="p">(),</span> <span class="n">options</span><span class="p">)</span>
<span class="n">execute</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">False</span>
<div class="viewcode-block" id="drop_table"><a class="viewcode-back" href="../../../api/cassandra/cqlengine/management.html#cassandra.cqlengine.management.drop_table">[docs]</a><span class="k">def</span> <span class="nf">drop_table</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">keyspaces</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">connections</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Drops the table indicated by the model, if it exists.</span>
<span class="sd"> If `keyspaces` is specified, the table will be dropped for all specified keyspaces. Note that the `Model.__keyspace__` is ignored in that case.</span>
<span class="sd"> If `connections` is specified, the table will be synched for all specified connections. Note that the `Model.__connection__` is ignored in that case.</span>
<span class="sd"> If not specified, it will try to get the connection from the Model.</span>
<span class="sd"> **This function should be used with caution, especially in production environments.</span>
<span class="sd"> Take care to execute schema modifications in a single context (i.e. not concurrently with other clients).**</span>
<span class="sd"> *There are plans to guard schema-modifying functions with an environment-driven conditional.*</span>
<span class="sd"> """</span>
<span class="n">context</span> <span class="o">=</span> <span class="n">_get_context</span><span class="p">(</span><span class="n">keyspaces</span><span class="p">,</span> <span class="n">connections</span><span class="p">)</span>
<span class="k">for</span> <span class="n">connection</span><span class="p">,</span> <span class="n">keyspace</span> <span class="ow">in</span> <span class="n">context</span><span class="p">:</span>
<span class="k">with</span> <span class="n">query</span><span class="o">.</span><span class="n">ContextQuery</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">keyspace</span><span class="o">=</span><span class="n">keyspace</span><span class="p">)</span> <span class="k">as</span> <span class="n">m</span><span class="p">:</span>
<span class="n">_drop_table</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_drop_table</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">connection</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_allow_schema_modification</span><span class="p">():</span>
<span class="k">return</span>
<span class="n">connection</span> <span class="o">=</span> <span class="n">connection</span> <span class="ow">or</span> <span class="n">model</span><span class="o">.</span><span class="n">_get_connection</span><span class="p">()</span>
<span class="c1"># don't try to delete non existant tables</span>
<span class="n">meta</span> <span class="o">=</span> <span class="n">get_cluster</span><span class="p">(</span><span class="n">connection</span><span class="p">)</span><span class="o">.</span><span class="n">metadata</span>
<span class="n">ks_name</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">_get_keyspace</span><span class="p">()</span>
<span class="n">raw_cf_name</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">_raw_column_family_name</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">meta</span><span class="o">.</span><span class="n">keyspaces</span><span class="p">[</span><span class="n">ks_name</span><span class="p">]</span><span class="o">.</span><span class="n">tables</span><span class="p">[</span><span class="n">raw_cf_name</span><span class="p">]</span>
<span class="n">execute</span><span class="p">(</span><span class="s1">'DROP TABLE </span><span class="si">{0}</span><span class="s1">;'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">column_family_name</span><span class="p">()),</span> <span class="n">connection</span><span class="o">=</span><span class="n">connection</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">def</span> <span class="nf">_allow_schema_modification</span><span class="p">():</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="n">CQLENG_ALLOW_SCHEMA_MANAGEMENT</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">CQLENG_ALLOW_SCHEMA_MANAGEMENT</span> <span class="o">+</span> <span class="s2">" environment variable is not set. Future versions of this package will require this variable to enable management functions."</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">True</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>
<li><a href="../../cassandra.html">cassandra</a><ul>
</ul></li>
</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>