forked from scylladb/scylla-rust-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
/
session_builder.rs
900 lines (826 loc) · 31 KB
/
session_builder.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
//! SessionBuilder provides an easy way to create new Sessions
use super::errors::NewSessionError;
use super::load_balancing::LoadBalancingPolicy;
use super::session::{AddressTranslator, Session, SessionConfig};
use super::speculative_execution::SpeculativeExecutionPolicy;
use super::Compression;
use crate::transport::host_filter::HostFilter;
use crate::transport::{connection_pool::PoolSize, retry_policy::RetryPolicy};
use std::net::SocketAddr;
use std::sync::Arc;
use std::time::Duration;
use crate::statement::Consistency;
#[cfg(feature = "ssl")]
use openssl::ssl::SslContext;
use tracing::warn;
/// SessionBuilder is used to create new Session instances
/// # Example
///
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use scylla::transport::Compression;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .compression(Some(Compression::Snappy))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
#[derive(Clone)]
pub struct SessionBuilder {
pub config: SessionConfig,
}
impl SessionBuilder {
/// Creates new SessionBuilder with default configuration
/// # Default configuration
/// * Compression: None
///
pub fn new() -> Self {
SessionBuilder {
config: SessionConfig::new(),
}
}
/// Add a known node with a hostname
/// # Examples
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new().known_node("127.0.0.1:9042").build().await?;
/// # Ok(())
/// # }
/// ```
///
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new().known_node("db1.example.com").build().await?;
/// # Ok(())
/// # }
/// ```
pub fn known_node(mut self, hostname: impl AsRef<str>) -> Self {
self.config.add_known_node(hostname);
self
}
/// Specify a default consistency to be used for queries.
/// It's possible to override it by explicitly setting a consistency on the chosen query.
pub fn default_consistency(mut self, consistency: Consistency) -> Self {
self.config.default_consistency = consistency;
self
}
/// Add a known node with an IP address
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use std::net::{SocketAddr, IpAddr, Ipv4Addr};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node_addr(SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 9042))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn known_node_addr(mut self, node_addr: SocketAddr) -> Self {
self.config.add_known_node_addr(node_addr);
self
}
/// Add a list of known nodes with hostnames
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_nodes(&["127.0.0.1:9042", "db1.example.com"])
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn known_nodes(mut self, hostnames: &[impl AsRef<str>]) -> Self {
self.config.add_known_nodes(hostnames);
self
}
/// Add a list of known nodes with IP addresses
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use std::net::{SocketAddr, IpAddr, Ipv4Addr};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let addr1 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(172, 17, 0, 3)), 9042);
/// let addr2 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(172, 17, 0, 4)), 9042);
///
/// let session: Session = SessionBuilder::new()
/// .known_nodes_addr(&[addr1, addr2])
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn known_nodes_addr(mut self, node_addrs: &[SocketAddr]) -> Self {
self.config.add_known_nodes_addr(node_addrs);
self
}
/// Set preferred Compression algorithm.
/// The default is no compression.
/// If it is not supported by database server Session will fall back to no encryption.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use scylla::transport::Compression;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .compression(Some(Compression::Snappy))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn compression(mut self, compression: Option<Compression>) -> Self {
self.config.compression = compression;
self
}
/// Set the nodelay TCP flag.
/// The default is true.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .tcp_nodelay(true)
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn tcp_nodelay(mut self, nodelay: bool) -> Self {
self.config.tcp_nodelay = nodelay;
self
}
/// Set keyspace to be used on all connections.\
/// Each connection will send `"USE <keyspace_name>"` before sending any requests.\
/// This can be later changed with [`Session::use_keyspace`]
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use scylla::transport::Compression;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .use_keyspace("my_keyspace_name", false)
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn use_keyspace(mut self, keyspace_name: impl Into<String>, case_sensitive: bool) -> Self {
self.config.used_keyspace = Some(keyspace_name.into());
self.config.keyspace_case_sensitive = case_sensitive;
self
}
/// Set username and password for authentication.\
/// If the database server will require authentication\
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use scylla::transport::Compression;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .use_keyspace("my_keyspace_name", false)
/// .user("cassandra", "cassandra")
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn user(mut self, username: impl Into<String>, passwd: impl Into<String>) -> Self {
self.config.auth_username = Some(username.into());
self.config.auth_password = Some(passwd.into());
self
}
/// Set the delay for schema agreement check. How often driver should ask if schema is in agreement
/// The default is 200 milliseconds.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use std::time::Duration;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .schema_agreement_interval(Duration::from_secs(5))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn schema_agreement_interval(mut self, timeout: Duration) -> Self {
self.config.schema_agreement_interval = timeout;
self
}
/// Set the load balancing policy
/// The default is Token-aware Round-robin.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use scylla::transport::load_balancing::RoundRobinPolicy;
/// # use std::sync::Arc;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .load_balancing(Arc::new(RoundRobinPolicy::new()))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn load_balancing(mut self, policy: Arc<dyn LoadBalancingPolicy>) -> Self {
self.config.load_balancing = policy;
self
}
/// Set the speculative execution policy
/// The default is None
/// # Example
/// ```
/// # extern crate scylla;
/// # use scylla::Session;
/// # use std::error::Error;
/// # async fn check_only_compiles() -> Result<(), Box<dyn Error>> {
/// use std::{sync::Arc, time::Duration};
/// use scylla::{
/// Session,
/// SessionBuilder,
/// transport::speculative_execution::SimpleSpeculativeExecutionPolicy
/// };
///
/// let policy = SimpleSpeculativeExecutionPolicy {
/// max_retry_count: 3,
/// retry_interval: Duration::from_millis(100),
/// };
///
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .speculative_execution(Arc::new(policy))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn speculative_execution(mut self, policy: Arc<dyn SpeculativeExecutionPolicy>) -> Self {
self.config.speculative_execution_policy = Some(policy);
self
}
/// Sets the [`RetryPolicy`] to use by default on queries
/// The default is [DefaultRetryPolicy](crate::transport::retry_policy::DefaultRetryPolicy)
/// It is possible to implement a custom retry policy by implementing the trait [`RetryPolicy`]
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use scylla::transport::Compression;
/// use scylla::transport::retry_policy::DefaultRetryPolicy;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .retry_policy(Box::new(DefaultRetryPolicy::new()))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn retry_policy(mut self, retry_policy: Box<dyn RetryPolicy + Send + Sync>) -> Self {
self.config.retry_policy = retry_policy;
self
}
/// ssl feature
/// Provide SessionBuilder with SslContext from openssl crate that will be
/// used to create an ssl connection to the database.
/// If set to None SSL connection won't be used.
/// Default is None.
///
/// # Example
/// ```
/// # use std::fs;
/// # use std::path::PathBuf;
/// # use scylla::{Session, SessionBuilder};
/// # use openssl::ssl::{SslContextBuilder, SslVerifyMode, SslMethod, SslFiletype};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let certdir = fs::canonicalize(PathBuf::from("./examples/certs/scylla.crt"))?;
/// let mut context_builder = SslContextBuilder::new(SslMethod::tls())?;
/// context_builder.set_certificate_file(certdir.as_path(), SslFiletype::PEM)?;
/// context_builder.set_verify(SslVerifyMode::NONE);
///
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .ssl_context(Some(context_builder.build()))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "ssl")]
pub fn ssl_context(mut self, ssl_context: Option<SslContext>) -> Self {
self.config.ssl_context = ssl_context;
self
}
/// Builds the Session after setting all the options
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use scylla::transport::Compression;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .compression(Some(Compression::Snappy))
/// .build() // Turns SessionBuilder into Session
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn build(&self) -> Result<Session, NewSessionError> {
Session::connect(self.config.clone()).await
}
/// Changes connection timeout
/// The default is 5 seconds.
/// If it's higher than underlying os's default connection timeout it won't effect.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use std::time::Duration;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .connection_timeout(Duration::from_secs(30))
/// .build() // Turns SessionBuilder into Session
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn connection_timeout(mut self, duration: std::time::Duration) -> Self {
self.config.connect_timeout = duration;
self
}
/// Sets the per-node connection pool size.
/// The default is one connection per shard, which is the recommended setting for Scylla.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// use std::num::NonZeroUsize;
/// use scylla::transport::session::PoolSize;
///
/// // This session will establish 4 connections to each node.
/// // For Scylla clusters, this number will be divided across shards
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .pool_size(PoolSize::PerHost(NonZeroUsize::new(4).unwrap()))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn pool_size(mut self, size: PoolSize) -> Self {
self.config.connection_pool_size = size;
self
}
/// If true, prevents the driver from connecting to the shard-aware port, even if the node supports it.
///
/// _This is a Scylla-specific option_. It has no effect on Cassandra clusters.
///
/// By default, connecting to the shard-aware port is __allowed__ and, in general, this setting
/// _should not be changed_. The shard-aware port (19042 or 19142) makes the process of
/// establishing connection per shard more robust compared to the regular transport port
/// (9042 or 9142). With the shard-aware port, the driver is able to choose which shard
/// will be assigned to the connection.
///
/// In order to be able to use the shard-aware port effectively, the port needs to be
/// reachable and not behind a NAT which changes source ports (the driver uses the source port
/// to tell Scylla which shard to assign). However, the driver is designed to behave in a robust
/// way if those conditions are not met - if the driver fails to connect to the port or gets
/// a connection to the wrong shard, it will re-attempt the connection to the regular transport port.
///
/// The only cost of misconfigured shard-aware port should be a slightly longer reconnection time.
/// If it is unacceptable to you or suspect that it causes you some other problems,
/// you can use this option to disable the shard-aware port feature completely.
/// However, __you should use it as a last resort__. Before you do that, we strongly recommend
/// that you consider fixing the network issues.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .disallow_shard_aware_port(true)
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn disallow_shard_aware_port(mut self, disallow: bool) -> Self {
self.config.disallow_shard_aware_port = disallow;
self
}
/// Set the fetch schema metadata flag.
/// The default is true.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .fetch_schema_metadata(true)
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn fetch_schema_metadata(mut self, fetch: bool) -> Self {
self.config.fetch_schema_metadata = fetch;
self
}
/// Set the keepalive interval.
/// The default is `None`, it corresponds to no keepalive messages being send.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .keepalive_interval(std::time::Duration::from_secs(42))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn keepalive_interval(mut self, interval: Duration) -> Self {
if interval <= Duration::from_secs(1) {
warn!(
"Setting the keepalive interval to low values ({:?}) is not recommended as it can have a negative impact on performance. Consider setting it above 1 second.",
interval
);
}
self.config.keepalive_interval = Some(interval);
self
}
/// Enables automatic wait for schema agreement and sets the timeout for it.
/// By default, it is enabled and the timeout is 60 seconds.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .auto_schema_agreement_timeout(std::time::Duration::from_secs(120))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn auto_schema_agreement_timeout(mut self, timeout: Duration) -> Self {
self.config.auto_await_schema_agreement_timeout = Some(timeout);
self
}
/// Disables automatic wait for schema agreement.
/// By default, it is enabled and the timeout is 60 seconds.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .no_auto_schema_agreement()
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn no_auto_schema_agreement(mut self) -> Self {
self.config.auto_await_schema_agreement_timeout = None;
self
}
/// Changes client-side timeout
/// The default is 30 seconds.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # use std::time::Duration;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .request_timeout(Some(Duration::from_millis(500)))
/// .build() // Turns SessionBuilder into Session
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn request_timeout(mut self, duration: Option<std::time::Duration>) -> Self {
self.config.request_timeout = duration;
self
}
/// Uses a custom address translator for peer addresses retrieved from the cluster.
/// By default, no translation is performed.
///
/// # Example
/// ```
/// # use async_trait::async_trait;
/// # use std::net::SocketAddr;
/// # use std::sync::Arc;
/// # use scylla::{Session, SessionBuilder};
/// # use scylla::transport::session::{AddressTranslator, TranslationError};
/// # use scylla::transport::topology::UntranslatedPeer;
/// struct IdentityTranslator;
///
/// #[async_trait]
/// impl AddressTranslator for IdentityTranslator {
/// async fn translate_address(
/// &self,
/// untranslated_peer: &UntranslatedPeer
/// ) -> Result<SocketAddr, TranslationError> {
/// Ok(untranslated_peer.untranslated_address)
/// }
/// }
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .address_translator(Arc::new(IdentityTranslator))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
/// /// # Example
/// ```
/// # use std::net::SocketAddr;
/// # use std::sync::Arc;
/// # use std::collections::HashMap;
/// # use std::str::FromStr;
/// # use scylla::{Session, SessionBuilder};
/// # use scylla::transport::session::{AddressTranslator, TranslationError};
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let mut translation_rules = HashMap::new();
/// let addr_before_translation = SocketAddr::from_str("192.168.0.42").unwrap();
/// let addr_after_translation = SocketAddr::from_str("157.123.12.42").unwrap();
/// translation_rules.insert(addr_before_translation, addr_after_translation);
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .address_translator(Arc::new(translation_rules))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn address_translator(mut self, translator: Arc<dyn AddressTranslator>) -> Self {
self.config.address_translator = Some(translator);
self
}
/// Sets the host filter. The host filter decides whether any connections
/// should be opened to the node or not. The driver will also avoid
/// those nodes when re-establishing the control connection.
///
/// See the [host filter](crate::transport::host_filter) module for a list
/// of pre-defined filters. It is also possible to provide a custom filter
/// by implementing the HostFilter trait.
///
/// # Example
/// ```
/// # use async_trait::async_trait;
/// # use std::net::SocketAddr;
/// # use std::sync::Arc;
/// # use scylla::{Session, SessionBuilder};
/// # use scylla::transport::session::{AddressTranslator, TranslationError};
/// # use scylla::transport::host_filter::DcHostFilter;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// // The session will only connect to nodes from "my-local-dc"
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .host_filter(Arc::new(DcHostFilter::new("my-local-dc".to_string())))
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn host_filter(mut self, filter: Arc<dyn HostFilter>) -> Self {
self.config.host_filter = Some(filter);
self
}
/// Set the refresh metadata on schema agreement flag.
/// The default is true.
///
/// # Example
/// ```
/// # use scylla::{Session, SessionBuilder};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let session: Session = SessionBuilder::new()
/// .known_node("127.0.0.1:9042")
/// .refresh_metadata_on_auto_schema_agreement(true)
/// .build()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn refresh_metadata_on_auto_schema_agreement(mut self, refresh_metadata: bool) -> Self {
self.config.refresh_metadata_on_auto_schema_agreement = refresh_metadata;
self
}
}
/// Creates a [`SessionBuilder`] with default configuration, same as [`SessionBuilder::new`]
impl Default for SessionBuilder {
fn default() -> Self {
SessionBuilder::new()
}
}
#[cfg(test)]
mod tests {
use super::SessionBuilder;
use crate::transport::load_balancing::RoundRobinPolicy;
use crate::transport::session::KnownNode;
use crate::transport::Compression;
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
use std::sync::Arc;
#[test]
fn default_session_builder() {
let builder = SessionBuilder::new();
assert!(builder.config.known_nodes.is_empty());
assert_eq!(builder.config.compression, None);
}
#[test]
fn add_known_node() {
let mut builder = SessionBuilder::new();
builder = builder.known_node("test_hostname");
assert_eq!(
builder.config.known_nodes,
vec![KnownNode::Hostname("test_hostname".into())]
);
assert_eq!(builder.config.compression, None);
}
#[test]
fn add_known_node_addr() {
let mut builder = SessionBuilder::new();
let addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(172, 17, 0, 3)), 1357);
builder = builder.known_node_addr(addr);
assert_eq!(builder.config.known_nodes, vec![KnownNode::Address(addr)]);
assert_eq!(builder.config.compression, None);
}
#[test]
fn add_known_nodes() {
let mut builder = SessionBuilder::new();
builder = builder.known_nodes(&["test_hostname1", "test_hostname2"]);
assert_eq!(
builder.config.known_nodes,
vec![
KnownNode::Hostname("test_hostname1".into()),
KnownNode::Hostname("test_hostname2".into())
]
);
assert_eq!(builder.config.compression, None);
}
#[test]
fn add_known_nodes_addr() {
let mut builder = SessionBuilder::new();
let addr1 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(172, 17, 0, 3)), 1357);
let addr2 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(172, 17, 0, 4)), 9090);
builder = builder.known_nodes_addr(&[addr1, addr2]);
assert_eq!(
builder.config.known_nodes,
vec![KnownNode::Address(addr1), KnownNode::Address(addr2)]
);
assert_eq!(builder.config.compression, None);
}
#[test]
fn compression() {
let mut builder = SessionBuilder::new();
assert_eq!(builder.config.compression, None);
builder = builder.compression(Some(Compression::Lz4));
assert_eq!(builder.config.compression, Some(Compression::Lz4));
builder = builder.compression(Some(Compression::Snappy));
assert_eq!(builder.config.compression, Some(Compression::Snappy));
builder = builder.compression(None);
assert_eq!(builder.config.compression, None);
}
#[test]
fn tcp_nodelay() {
let mut builder = SessionBuilder::new();
assert!(builder.config.tcp_nodelay);
builder = builder.tcp_nodelay(false);
assert!(!builder.config.tcp_nodelay);
builder = builder.tcp_nodelay(true);
assert!(builder.config.tcp_nodelay);
}
#[test]
fn load_balancing() {
let mut builder = SessionBuilder::new();
assert_eq!(
builder.config.load_balancing.name(),
"TokenAwarePolicy{child_policy: RoundRobinPolicy}".to_string()
);
builder = builder.load_balancing(Arc::new(RoundRobinPolicy::new()));
assert_eq!(
builder.config.load_balancing.name(),
"RoundRobinPolicy".to_string()
);
}
#[test]
fn use_keyspace() {
let mut builder = SessionBuilder::new();
assert_eq!(builder.config.used_keyspace, None);
assert!(!builder.config.keyspace_case_sensitive);
builder = builder.use_keyspace("ks_name_1", true);
assert_eq!(builder.config.used_keyspace, Some("ks_name_1".to_string()));
assert!(builder.config.keyspace_case_sensitive);
builder = builder.use_keyspace("ks_name_2", false);
assert_eq!(builder.config.used_keyspace, Some("ks_name_2".to_string()));
assert!(!builder.config.keyspace_case_sensitive);
}
#[test]
fn connection_timeout() {
let mut builder = SessionBuilder::new();
assert_eq!(
builder.config.connect_timeout,
std::time::Duration::from_secs(5)
);
builder = builder.connection_timeout(std::time::Duration::from_secs(10));
assert_eq!(
builder.config.connect_timeout,
std::time::Duration::from_secs(10)
);
}
#[test]
fn fetch_schema_metadata() {
let mut builder = SessionBuilder::new();
assert!(builder.config.fetch_schema_metadata);
builder = builder.fetch_schema_metadata(false);
assert!(!builder.config.fetch_schema_metadata);
builder = builder.fetch_schema_metadata(true);
assert!(builder.config.fetch_schema_metadata);
}
#[test]
fn request_timeout() {
let mut builder = SessionBuilder::new();
assert_eq!(
builder.config.request_timeout,
Some(std::time::Duration::from_secs(30))
);
builder = builder.request_timeout(Some(std::time::Duration::from_secs(10)));
assert_eq!(
builder.config.request_timeout,
Some(std::time::Duration::from_secs(10))
);
}
#[test]
fn all_features() {
let mut builder = SessionBuilder::new();
let addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(172, 17, 0, 3)), 8465);
let addr1 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(172, 17, 0, 3)), 1357);
let addr2 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(172, 17, 0, 4)), 9090);
builder = builder.known_node("hostname_test");
builder = builder.known_node_addr(addr);
builder = builder.known_nodes(&["hostname_test1", "hostname_test2"]);
builder = builder.known_nodes_addr(&[addr1, addr2]);
builder = builder.compression(Some(Compression::Snappy));
builder = builder.tcp_nodelay(true);
builder = builder.load_balancing(Arc::new(RoundRobinPolicy::new()));
builder = builder.use_keyspace("ks_name", true);
builder = builder.fetch_schema_metadata(false);
assert_eq!(
builder.config.known_nodes,
vec![
KnownNode::Hostname("hostname_test".into()),
KnownNode::Address(addr),
KnownNode::Hostname("hostname_test1".into()),
KnownNode::Hostname("hostname_test2".into()),
KnownNode::Address(addr1),
KnownNode::Address(addr2),
]
);
assert_eq!(builder.config.compression, Some(Compression::Snappy));
assert!(builder.config.tcp_nodelay);
assert_eq!(
builder.config.load_balancing.name(),
"RoundRobinPolicy".to_string()
);
assert_eq!(builder.config.used_keyspace, Some("ks_name".to_string()));
assert!(builder.config.keyspace_case_sensitive);
assert!(!builder.config.fetch_schema_metadata);
}
}