forked from scylladb/python-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexecution_profiles.html
More file actions
710 lines (677 loc) · 45 KB
/
Copy pathexecution_profiles.html
File metadata and controls
710 lines (677 loc) · 45 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
<!DOCTYPE html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width initial-scale=1" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title> Execution Profiles | Scylla Docs
</title>
<meta name="description" content="Scylla is an Apache Cassandra-compatible NoSQL data store that can handle 1 million transactions per second on a single server." />
<link
rel="icon"
href="_static/img/favicon.ico"
type="image/x-icon"
/>
<link
rel="icon"
href="_static/img/favicon-32x32.png"
sizes="32x32"
/>
<link
rel="icon"
href="_static/img/favicon-228x228.png"
sizes="192x192"
/>
<link
rel="apple-touch-icon"
href="_static/img/favicon-228x228.png"
/>
<meta
name="msapplication-TileImage"
href="_static/img/favicon-228x228.png"
/>
<link rel="canonical" href="https://docs.scylladb.com/" />
<link rel="author" href="mailto:info@scylladb.com" />
<!-- connect to domain of font files -->
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<!-- optionally increase loading priority -->
<link
rel="preload"
as="style"
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap"
/>
<!-- async CSS -->
<link
rel="stylesheet"
media="print"
onload="this.onload=null;this.removeAttribute('media');"
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap"
/>
<!-- no-JS fallback -->
<noscript>
<link
rel="stylesheet"
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap"
/>
</noscript>
<link
rel="stylesheet"
href="_static/css/main.css"
type="text/css"
/>
<link
rel="stylesheet"
href="_static/pygments.css"
type="text/css"
/> <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<script
type="text/javascript"
id="documentation_options"
data-url_root="./"
src="_static/documentation_options.js"
></script>
<script
type="text/javascript"
src="_static/js/runtime.bundle.js"
></script>
<script
type="text/javascript"
src="_static/js/main.bundle.js"
></script> <script src="_static/underscore.js"></script> <script src="_static/doctools.js"></script> <script src="_static/language_data.js"></script> <script src="_static/clipboard.min.js"></script> <script src="_static/copybutton.js"></script>
<!-- Google Tag Manager -->
<script>
(function (w, d, s, l, i) {
w[l] = w[l] || [];
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
var f = d.getElementsByTagName(s)[0],
j = d.createElement(s),
dl = l != "dataLayer" ? "&l=" + l : "";
j.async = true;
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
f.parentNode.insertBefore(j, f);
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
</script>
<!-- End Google Tag Manager -->
<!-- Marketo -->
<script type="text/javascript">
(function () {
var didInit = false;
function initMunchkin() {
if (didInit === false) {
didInit = true;
Munchkin.init("791-QBF-350");
}
}
var s = document.createElement("script");
s.type = "text/javascript";
s.async = true;
s.src = "//munchkin.marketo.net/munchkin.js";
s.onreadystatechange = function () {
if (this.readyState == "complete" || this.readyState == "loaded") {
initMunchkin();
}
};
s.onload = initMunchkin;
document.getElementsByTagName("head")[0].appendChild(s);
})();
</script>
<!-- End Marketo -->
<!-- Expertrec -->
<script>
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
var ci_search = document.createElement("script");
ci_search.type = "text/javascript";
ci_search.async = true;
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(ci_search, s);
</script>
<!-- End Expertrec -->
<!-- Font Awesome -->
<script
src="https://kit.fontawesome.com/b1870adf6a.js"
crossorigin="anonymous"
></script>
<!-- End Font Awesome -->
</head>
<body>
<header class="header">
<div class="header-logo">
<a class="header-logo__img" href="https://scylladb.com/">
<img
src="_static/img/logo-scylla-docs.svg"
alt="Scylla Documentation Logo"
/>
</a>
<span class="header-logo__bar"></span>
<a class="header-logo__text" href="https://docs.scylladb.com/">
Documentation
</a>
</div>
<div class="header-navigation">
<ul
class="dropdown menu scylla-dropdown scylla-dropdown--header"
data-dropdown-menu
>
<li class="scylla-dropdown__item">
<a href="#" class="scylla-dropdown__title"
>Server <i class="chevron scylla-icon scylla-icon--triangle-down"></i
></a>
<ul class="menu scylla-dropdown__content">
<li>
<a href="https://docs.scylladb.com/"
><i class="scylla-icon scylla-icon--about-us"></i>Scylla Open
Source</a
>
</li>
<li>
<a href="https://docs.scylladb.com/"
><i class="scylla-icon scylla-icon--enterprise"></i>Scylla
Enterprise</a
>
</li>
<li>
<a
href="https://scylla.docs.scylladb.com/master/alternator/alternator.html"
>
<i class="scylla-icon scylla-icon--overview"></i>Scylla
Alternator</a
>
</li>
</ul>
</li>
<li class="scylla-dropdown__item">
<a href="#" class="scylla-dropdown__title"
>Cloud <i class="chevron scylla-icon scylla-icon--triangle-down"></i
></a>
<ul class="menu scylla-dropdown__content">
<li>
<a href="https://cloud.scylladb.com/">
<i class="scylla-icon scylla-icon--cloud"></i>Scylla Cloud</a
>
</li>
<li>
<a href="https://docs.scylladb.com/scylla-cloud/">
<i class="scylla-icon scylla-icon--cloud-docs"></i>Scylla Cloud
Docs</a
>
</li>
</ul>
</li>
<li class="scylla-dropdown__item">
<a href="#" class="scylla-dropdown__title"
>Tools <i class="chevron scylla-icon scylla-icon--triangle-down"></i
></a>
<ul class="menu scylla-dropdown__content">
<li>
<a href="https://manager.docs.scylladb.com/">
<i class="scylla-icon scylla-icon--manager"></i>Scylla Manager</a
>
</li>
<li>
<a href="https://monitoring.docs.scylladb.com/">
<i class="scylla-icon scylla-icon--monitoring"></i>Scylla
Monitoring Stack</a
>
</li>
<li>
<a href="https://operator.docs.scylladb.com/">
<i class="scylla-icon scylla-icon--operator"></i>Scylla Operator
</a>
</li>
</ul>
</li>
<li class="scylla-dropdown__item">
<a href="#" class="scylla-dropdown__title"
>Drivers <i class="chevron scylla-icon scylla-icon--triangle-down"></i
></a>
<ul class="menu scylla-dropdown__content">
<li>
<a
href="https://docs.scylladb.com/using-scylla/drivers/cql-drivers/"
>
<i class="scylla-icon scylla-icon--nsql-guides"></i>CQL Drivers
</a>
</li>
<li>
<a
href="https://docs.scylladb.com/using-scylla/drivers/dynamo-drivers/"
>
<i class="scylla-icon scylla-icon--overview"></i>DynamoDB Drivers
</a>
</li>
</ul>
</li>
</ul>
<div class="header-button">
<a href="https://www.scylladb.com/download/" class="button">Download</a>
</div>
</div>
<div class="header-search-box">
<div class="search-box">
<ci-search></ci-search>
</div>
</div>
<div class="side-nav-toggle" data-toggle="side-nav">
<div class="side-nav-toggle__button">
<img src="_static/img/menu.svg" alt="Menu" />
</div>
</div>
</header>
<section class="layout ">
<div class="content large-order-2">
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>
You are not reading the latest stable version of this documentation.
If you want up-to-date information, please have a look at
<a href="../stable/execution_profiles.html">
3.25.1</a
>.
</p>
</div>
<div class="pre-content">
<div class="pre-content__left"><div class="breadcrumbs">
<span class="bread__item">
<a
href="index.html"
class="bread__highlight"
>
<i class="fas fa-home"></i> Cassandra Driver</a
></span
>
<span class="bread__item bread__item--last">Execution Profiles</span>
</div></div>
<div class="pre-content__right"><ul
class="dropdown menu scylla-dropdown scylla-dropdown--contribute"
data-dropdown-menu
>
<li class="scylla-dropdown__item">
<a class="scylla-dropdown__title" href="#">
<div class="scylla-dropdown__title--body">
<i class="icon fa fa-github" aria-hidden="true"></i>
Contribute
</div>
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
</a>
<ul class="menu scylla-dropdown__content">
<li>
<a
href="https://github.com/scylladb/python-driver/issues/new?title=Issue in page Execution Profiles&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://python-driver.docs.scylladb.com/master/execution_profiles%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix"
target="_blank"
>Report a doc issue
<i class="icon fa fa-external-link" aria-hidden="true"></i
></a>
</li>
<li>
<a
href="https://github.com/scylladb/python-driver/edit/master/docs/execution_profiles.rst"
target="_blank"
>Edit this page
<i class="icon fa fa-external-link" aria-hidden="true"></i
></a>
</li>
<li>
<a href="https://docs.scylladb.com/contribute/" target="_blank"
>Learn how to contribute
<i class="icon fa fa-external-link" aria-hidden="true"></i
></a>
</li>
</ul>
</li>
</ul></div>
</div>
<div class="section" id="execution-profiles">
<h1>Execution Profiles<a class="headerlink" href="#execution-profiles" title="Permalink to this headline">¶</a></h1>
<p>Execution profiles aim at making it easier to execute requests in different ways within
a single connected <code class="docutils literal notranslate"><span class="pre">Session</span></code>. Execution profiles are being introduced to deal with the exploding number of
configuration options, especially as the database platform evolves more complex workloads.</p>
<p>The legacy configuration remains intact, but legacy and Execution Profile APIs
cannot be used simultaneously on the same client <code class="docutils literal notranslate"><span class="pre">Cluster</span></code>. Legacy configuration
will be removed in the next major release (4.0).</p>
<p>An execution profile and its parameters should be unique across <code class="docutils literal notranslate"><span class="pre">Cluster</span></code> instances.
For example, an execution profile and its <code class="docutils literal notranslate"><span class="pre">LoadBalancingPolicy</span></code> should
not be applied to more than one <code class="docutils literal notranslate"><span class="pre">Cluster</span></code> instance.</p>
<p>This document explains how Execution Profiles relate to existing settings, and shows how to use the new profiles for
request execution.</p>
<div class="section" id="mapping-legacy-parameters-to-profiles">
<h2>Mapping Legacy Parameters to Profiles<a class="headerlink" href="#mapping-legacy-parameters-to-profiles" title="Permalink to this headline">¶</a></h2>
<p>Execution profiles can inherit from <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.ExecutionProfile" title="cassandra.cluster.ExecutionProfile"><code class="xref py py-class docutils literal notranslate"><span class="pre">cluster.ExecutionProfile</span></code></a>, and currently provide the following options,
previously input from the noted attributes:</p>
<ul class="simple">
<li><p>load_balancing_policy - <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.Cluster.load_balancing_policy" title="cassandra.cluster.Cluster.load_balancing_policy"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.load_balancing_policy</span></code></a></p></li>
<li><p>request_timeout - <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.Session.default_timeout" title="cassandra.cluster.Session.default_timeout"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Session.default_timeout</span></code></a>, optional <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.Session.execute" title="cassandra.cluster.Session.execute"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Session.execute()</span></code></a> parameter</p></li>
<li><p>retry_policy - <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.Cluster.default_retry_policy" title="cassandra.cluster.Cluster.default_retry_policy"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.default_retry_policy</span></code></a>, optional <code class="xref py py-attr docutils literal notranslate"><span class="pre">Statement.retry_policy</span></code> attribute</p></li>
<li><p>consistency_level - <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.Session.default_consistency_level" title="cassandra.cluster.Session.default_consistency_level"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Session.default_consistency_level</span></code></a>, optional <code class="xref py py-attr docutils literal notranslate"><span class="pre">Statement.consistency_level</span></code> attribute</p></li>
<li><p>serial_consistency_level - <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.Session.default_serial_consistency_level" title="cassandra.cluster.Session.default_serial_consistency_level"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Session.default_serial_consistency_level</span></code></a>, optional <a class="reference internal" href="api/cassandra/query.html#cassandra.query.Statement.serial_consistency_level" title="cassandra.query.Statement.serial_consistency_level"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Statement.serial_consistency_level</span></code></a> attribute</p></li>
<li><p>row_factory - <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.Session.row_factory" title="cassandra.cluster.Session.row_factory"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Session.row_factory</span></code></a> attribute</p></li>
</ul>
<p>When using the new API, these parameters can be defined by instances of <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.ExecutionProfile" title="cassandra.cluster.ExecutionProfile"><code class="xref py py-class docutils literal notranslate"><span class="pre">cluster.ExecutionProfile</span></code></a>.</p>
</div>
<div class="section" id="using-execution-profiles">
<h2>Using Execution Profiles<a class="headerlink" href="#using-execution-profiles" title="Permalink to this headline">¶</a></h2>
<div class="section" id="default">
<h3>Default<a class="headerlink" href="#default" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cassandra.cluster</span> <span class="kn">import</span> <span class="n">Cluster</span>
<span class="n">cluster</span> <span class="o">=</span> <span class="n">Cluster</span><span class="p">()</span>
<span class="n">session</span> <span class="o">=</span> <span class="n">cluster</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
<span class="n">local_query</span> <span class="o">=</span> <span class="s1">'SELECT rpc_address FROM system.local'</span>
<span class="k">for</span> <span class="n">_</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">all_hosts</span><span class="p">():</span>
<span class="nb">print</span> <span class="n">session</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">local_query</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.2'</span><span class="p">)</span>
<span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.1'</span><span class="p">)</span>
</pre></div>
</div>
<p>The default execution profile is built from Cluster parameters and default Session attributes. This profile matches existing default
parameters.</p>
</div>
<div class="section" id="initializing-cluster-with-profiles">
<h3>Initializing cluster with profiles<a class="headerlink" href="#initializing-cluster-with-profiles" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cassandra.cluster</span> <span class="kn">import</span> <span class="n">ExecutionProfile</span>
<span class="kn">from</span> <span class="nn">cassandra.policies</span> <span class="kn">import</span> <span class="n">WhiteListRoundRobinPolicy</span>
<span class="n">node1_profile</span> <span class="o">=</span> <span class="n">ExecutionProfile</span><span class="p">(</span><span class="n">load_balancing_policy</span><span class="o">=</span><span class="n">WhiteListRoundRobinPolicy</span><span class="p">([</span><span class="s1">'127.0.0.1'</span><span class="p">]))</span>
<span class="n">node2_profile</span> <span class="o">=</span> <span class="n">ExecutionProfile</span><span class="p">(</span><span class="n">load_balancing_policy</span><span class="o">=</span><span class="n">WhiteListRoundRobinPolicy</span><span class="p">([</span><span class="s1">'127.0.0.2'</span><span class="p">]))</span>
<span class="n">profiles</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'node1'</span><span class="p">:</span> <span class="n">node1_profile</span><span class="p">,</span> <span class="s1">'node2'</span><span class="p">:</span> <span class="n">node2_profile</span><span class="p">}</span>
<span class="n">session</span> <span class="o">=</span> <span class="n">Cluster</span><span class="p">(</span><span class="n">execution_profiles</span><span class="o">=</span><span class="n">profiles</span><span class="p">)</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
<span class="k">for</span> <span class="n">_</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">all_hosts</span><span class="p">():</span>
<span class="nb">print</span> <span class="n">session</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">local_query</span><span class="p">,</span> <span class="n">execution_profile</span><span class="o">=</span><span class="s1">'node1'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.1'</span><span class="p">)</span>
<span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.1'</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">_</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">all_hosts</span><span class="p">():</span>
<span class="nb">print</span> <span class="n">session</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">local_query</span><span class="p">,</span> <span class="n">execution_profile</span><span class="o">=</span><span class="s1">'node2'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.2'</span><span class="p">)</span>
<span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.2'</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">_</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">all_hosts</span><span class="p">():</span>
<span class="nb">print</span> <span class="n">session</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">local_query</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.2'</span><span class="p">)</span>
<span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.1'</span><span class="p">)</span>
</pre></div>
</div>
<p>Note that, even when custom profiles are injected, the default <code class="docutils literal notranslate"><span class="pre">TokenAwarePolicy(DCAwareRoundRobinPolicy())</span></code> is still
present. To override the default, specify a policy with the <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.EXEC_PROFILE_DEFAULT" title="cassandra.cluster.EXEC_PROFILE_DEFAULT"><code class="xref py py-data docutils literal notranslate"><span class="pre">EXEC_PROFILE_DEFAULT</span></code></a> key.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cassandra.cluster</span> <span class="kn">import</span> <span class="n">EXEC_PROFILE_DEFAULT</span>
<span class="n">profile</span> <span class="o">=</span> <span class="n">ExecutionProfile</span><span class="p">(</span><span class="n">request_timeout</span><span class="o">=</span><span class="mi">30</span><span class="p">)</span>
<span class="n">cluster</span> <span class="o">=</span> <span class="n">Cluster</span><span class="p">(</span><span class="n">execution_profiles</span><span class="o">=</span><span class="p">{</span><span class="n">EXEC_PROFILE_DEFAULT</span><span class="p">:</span> <span class="n">profile</span><span class="p">})</span>
</pre></div>
</div>
</div>
<div class="section" id="adding-named-profiles">
<h3>Adding named profiles<a class="headerlink" href="#adding-named-profiles" title="Permalink to this headline">¶</a></h3>
<p>New profiles can be added constructing from scratch, or deriving from default:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">locked_execution</span> <span class="o">=</span> <span class="n">ExecutionProfile</span><span class="p">(</span><span class="n">load_balancing_policy</span><span class="o">=</span><span class="n">WhiteListRoundRobinPolicy</span><span class="p">([</span><span class="s1">'127.0.0.1'</span><span class="p">]))</span>
<span class="n">node1_profile</span> <span class="o">=</span> <span class="s1">'node1_whitelist'</span>
<span class="n">cluster</span><span class="o">.</span><span class="n">add_execution_profile</span><span class="p">(</span><span class="n">node1_profile</span><span class="p">,</span> <span class="n">locked_execution</span><span class="p">)</span>
<span class="k">for</span> <span class="n">_</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">all_hosts</span><span class="p">():</span>
<span class="nb">print</span> <span class="n">session</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">local_query</span><span class="p">,</span> <span class="n">execution_profile</span><span class="o">=</span><span class="n">node1_profile</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.1'</span><span class="p">)</span>
<span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.1'</span><span class="p">)</span>
</pre></div>
</div>
<p>See <a class="reference internal" href="api/cassandra/cluster.html#cassandra.cluster.Cluster.add_execution_profile" title="cassandra.cluster.Cluster.add_execution_profile"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Cluster.add_execution_profile()</span></code></a> for details and optional parameters.</p>
</div>
<div class="section" id="passing-a-profile-instance-without-mapping">
<h3>Passing a profile instance without mapping<a class="headerlink" href="#passing-a-profile-instance-without-mapping" title="Permalink to this headline">¶</a></h3>
<p>We also have the ability to pass profile instances to be used for execution, but not added to the mapping:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cassandra.query</span> <span class="kn">import</span> <span class="n">tuple_factory</span>
<span class="n">tmp</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">execution_profile_clone_update</span><span class="p">(</span><span class="s1">'node1'</span><span class="p">,</span> <span class="n">request_timeout</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">row_factory</span><span class="o">=</span><span class="n">tuple_factory</span><span class="p">)</span>
<span class="nb">print</span> <span class="n">session</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">local_query</span><span class="p">,</span> <span class="n">execution_profile</span><span class="o">=</span><span class="n">tmp</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="nb">print</span> <span class="n">session</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">local_query</span><span class="p">,</span> <span class="n">execution_profile</span><span class="o">=</span><span class="s1">'node1'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="s1">'127.0.0.1'</span><span class="p">,)</span>
<span class="n">Row</span><span class="p">(</span><span class="n">rpc_address</span><span class="o">=</span><span class="s1">'127.0.0.1'</span><span class="p">)</span>
</pre></div>
</div>
<p>The new profile is a shallow copy, so the <code class="docutils literal notranslate"><span class="pre">tmp</span></code> profile shares a load balancing policy with one managed by the cluster.
If reference objects are to be updated in the clone, one would typically set those attributes to a new instance.</p>
</div>
</div>
</div>
<div class="content-navigation">
<div class="navigation navigation--prev">
<a class="navigation__link" href="upgrading.html">
<button class="navigation__button">
<i class="scylla-icon scylla-icon--chevron-left"></i>
</button>
<div class="navigation__title">
<span class="colored">PREVIOUS</span> <br />Upgrading
</div>
</a>
</div>
<div class="navigation navigation--next">
<a class="navigation__link" href="performance.html">
<div class="navigation__title">
<span class="colored">NEXT</span> <br />Performance Notes
</div>
<button class="navigation__button">
<i class="scylla-icon scylla-icon--chevron-right"></i>
</button>
</a>
</div>
</div>
</div>
<div
class="sidebar-left large-order-1"
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
<button class="collapsible-button">
<i class="scylla-icon scylla-icon--chevron-left"></i>
</button>
<div class="side-nav-content">
<div class="side-nav__search">
<div class="search-box">
<ci-search></ci-search>
</div>
</div>
<div class="side-nav__versions">
<ul
class="dropdown menu scylla-dropdown scylla-dropdown--versions "
data-dropdown-menu
>
<li class="scylla-dropdown__item">
<a class="scylla-dropdown__title" href="#">
master
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
</a>
<ul class="menu scylla-dropdown__content">
<li>
<a href="../stable/execution_profiles.html"
>3.25.1</a
>
</li>
<li>
<a href="../3.24.8-scylla/execution_profiles.html"
>3.24.8</a
>
</li>
<li>
<a href="../3.22.3-scylla/execution_profiles.html"
>3.22.3</a
>
</li>
<li>
<a href="../3.21.0-scylla/execution_profiles.html"
>3.21.0</a
>
</li>
</ul>
</li>
</ul>
</div>
<div class="side-nav__content">
<ul class="current">
<li class="toctree-l1 has-children"><a class="reference internal" href="api/index.html">API Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">cassandra</span></code> - Exceptions and Enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/cluster.html"><code class="docutils literal notranslate"><span class="pre">cassandra.cluster</span></code> - Clusters and Sessions</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/policies.html"><code class="docutils literal notranslate"><span class="pre">cassandra.policies</span></code> - Load balancing and Failure Handling Policies</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/auth.html"><code class="docutils literal notranslate"><span class="pre">cassandra.auth</span></code> - Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/graph.html"><code class="docutils literal notranslate"><span class="pre">cassandra.graph</span></code> - Graph Statements, Options, and Row Factories</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/metadata.html"><code class="docutils literal notranslate"><span class="pre">cassandra.metadata</span></code> - Schema and Ring Topology</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/metrics.html"><code class="docutils literal notranslate"><span class="pre">cassandra.metrics</span></code> - Performance Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/query.html"><code class="docutils literal notranslate"><span class="pre">cassandra.query</span></code> - Prepared Statements, Batch Statements, Tracing, and Row Factories</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/pool.html"><code class="docutils literal notranslate"><span class="pre">cassandra.pool</span></code> - Hosts and Connection Pools</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/protocol.html"><code class="docutils literal notranslate"><span class="pre">cassandra.protocol</span></code> - Protocol Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/encoder.html"><code class="docutils literal notranslate"><span class="pre">cassandra.encoder</span></code> - Encoders for non-prepared Statements</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/decoder.html"><code class="docutils literal notranslate"><span class="pre">cassandra.decoder</span></code> - Data Return Formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/concurrent.html"><code class="docutils literal notranslate"><span class="pre">cassandra.concurrent</span></code> - Utilities for Concurrent Statement Execution</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/connection.html"><code class="docutils literal notranslate"><span class="pre">cassandra.connection</span></code> - Low Level Connection Info</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/util.html"><code class="docutils literal notranslate"><span class="pre">cassandra.util</span></code> - Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/timestamps.html"><code class="docutils literal notranslate"><span class="pre">cassandra.timestamps</span></code> - Timestamp Generation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/io/asyncioreactor.html"><code class="docutils literal notranslate"><span class="pre">cassandra.io.asyncioreactor</span></code> - <code class="docutils literal notranslate"><span class="pre">asyncio</span></code> Event Loop</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/io/asyncorereactor.html"><code class="docutils literal notranslate"><span class="pre">cassandra.io.asyncorereactor</span></code> - <code class="docutils literal notranslate"><span class="pre">asyncore</span></code> Event Loop</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/io/eventletreactor.html"><code class="docutils literal notranslate"><span class="pre">cassandra.io.eventletreactor</span></code> - <code class="docutils literal notranslate"><span class="pre">eventlet</span></code>-compatible Connection</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/io/libevreactor.html"><code class="docutils literal notranslate"><span class="pre">cassandra.io.libevreactor</span></code> - <code class="docutils literal notranslate"><span class="pre">libev</span></code> Event Loop</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/io/geventreactor.html"><code class="docutils literal notranslate"><span class="pre">cassandra.io.geventreactor</span></code> - <code class="docutils literal notranslate"><span class="pre">gevent</span></code>-compatible Event Loop</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/io/twistedreactor.html"><code class="docutils literal notranslate"><span class="pre">cassandra.io.twistedreactor</span></code> - Twisted Event Loop</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/cqlengine/models.html"><code class="docutils literal notranslate"><span class="pre">cassandra.cqlengine.models</span></code> - Table models for object mapping</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/cqlengine/columns.html"><code class="docutils literal notranslate"><span class="pre">cassandra.cqlengine.columns</span></code> - Column types for object mapping models</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/cqlengine/query.html"><code class="docutils literal notranslate"><span class="pre">cassandra.cqlengine.query</span></code> - Query and filter model objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/cqlengine/connection.html"><code class="docutils literal notranslate"><span class="pre">cassandra.cqlengine.connection</span></code> - Connection management for cqlengine</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/cqlengine/management.html"><code class="docutils literal notranslate"><span class="pre">cassandra.cqlengine.management</span></code> - Schema management for cqlengine</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/cqlengine/usertype.html"><code class="docutils literal notranslate"><span class="pre">cassandra.cqlengine.usertype</span></code> - Model classes for User Defined Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/datastax/graph/index.html"><code class="docutils literal notranslate"><span class="pre">cassandra.datastax.graph</span></code> - Graph Statements, Options, and Row Factories</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/datastax/graph/fluent/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">cassandra.datastax.graph.fluent</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/datastax/graph/fluent/query.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">cassandra.datastax.graph.fluent.query</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cassandra/datastax/graph/fluent/predicates.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">cassandra.datastax.graph.fluent.predicates</span></code></a></li>
</ul>
</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="scylla_specific.html">Scylla Specific Features</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="upgrading.html">Upgrading</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul class="simple">
</ul>
</li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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 has-children"><a class="reference internal" href="object_mapper.html">Object Mapper</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
<li class="toctree-l2"><a class="reference internal" href="cqlengine/upgrade_guide.html">Upgrade Guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="cqlengine/models.html">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="cqlengine/queryset.html">Making Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="cqlengine/batches.html">Batch Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="cqlengine/connections.html">Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="cqlengine/third_party.html">Third party integrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="cqlengine/faq.html">Frequently Asked Questions</a></li>
</ul>
</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="scylla_cloud.html">Scylla Cloud</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sidebar-right large-order-3">
<div class="secondary-side-nav custom-scroll-bar">
<div class="secondary-side-nav__content">
<p class="topic-title">On this page</p>
<ul>
<li><a class="reference internal" href="#">Execution Profiles</a><ul>
<li><a class="reference internal" href="#mapping-legacy-parameters-to-profiles">Mapping Legacy Parameters to Profiles</a></li>
<li><a class="reference internal" href="#using-execution-profiles">Using Execution Profiles</a><ul>
<li><a class="reference internal" href="#default">Default</a></li>
<li><a class="reference internal" href="#initializing-cluster-with-profiles">Initializing cluster with profiles</a></li>
<li><a class="reference internal" href="#adding-named-profiles">Adding named profiles</a></li>
<li><a class="reference internal" href="#passing-a-profile-instance-without-mapping">Passing a profile instance without mapping</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</section>
<footer class="footer">
<div class="footer-group">
<div class="footer-top">
<a class="footer-logo" href="https://www.scylladb.com"
><img
src="_static/img/logo-scylla-horizontal-RGB.svg"
alt="Logo"
/></a>
<div class="footer-links">
<a class="footer-links__link" href="https://docs.scylladb.com/">Docs</a>
<a
class="footer-links__link"
href="https://www.scylladb.com/company/contact-us/"
>Contact Us</a
>
<a class="footer-links__link" href="https://www.scylladb.com/company/"
>About Us</a
>
</div>
<div class="footer-actions">
<a
class="footer-actions__link"
href="https://groups.google.com/g/scylladb-users"
target="_blank"
><span
data-tooltip
tabindex="1"
title="User mailing list"
data-position="bottom"
>
<img
src="_static/img/icons/icon-mail-list.svg"
alt="Mail List Icon"
/>
</span>
</a>
<a
class="footer-actions__link"
href="http://slack.scylladb.com/"
target="_blank"
><span
data-tooltip
tabindex="1"
title="User Slack channel"
data-position="bottom"
>
<img
src="_static/img/icons/icon-slack.svg"
alt="Slack Icon"
/></span>
</a>
</div>
</div>
<div class="footer-bottom">
<div class="footer-bottom__copyright"> © ScyllaDB 2021 and © DataStax 2013-2017
</div>
<div class="footer-bottom__version">
Powered by
<a href="http://sphinx-doc.org/">Sphinx 2.4.4</a> &
<a href="https://sphinx-theme.scylladb.com/"
>ScyllaDB Theme 1.0.6</a
>
</div>
</div>
</div>
</footer>
<noscript>
<iframe
src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP"
height="0"
width="0"
style="display: none; visibility: hidden"
></iframe>
</noscript>
</body>
</html>