typedb_driver/common/
options.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
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

use std::time::Duration;

/// TypeDB transaction options.
/// `TypeDBOptions` object can be used to override the default server behaviour.
/// Options are specified using properties assignment.
///
/// # Examples
///
/// ```rust
/// let options = Options::new().explain(true);
/// ```
#[derive(Clone, Copy, Debug, Default)]
pub struct Options {
    /// If set to `True`, the server uses parallel instead of single-threaded execution.
    pub parallel: Option<bool>,
    /// If set to `True`, the first batch of answers is streamed to the driver even without an explicit request for it.
    pub prefetch: Option<bool>,
    /// If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request.
    pub prefetch_size: Option<u64>,
    /// If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions.
    pub transaction_timeout: Option<Duration>,
    /// If set, specifies how long the driver should wait if opening a transaction is blocked by an exclusive schema write lock.
    pub schema_lock_acquire_timeout: Option<Duration>,
    /// If set to `True`, enables reading data from any replica, potentially boosting read throughput. Only settable in TypeDB Cloud.
    pub read_any_replica: Option<bool>,
}

impl Options {
    pub fn new() -> Self {
        Self::default()
    }

    /// If set to `True`, the server uses parallel instead of single-threaded execution.
    pub fn parallel(self, parallel: bool) -> Self {
        Self { parallel: Some(parallel), ..self }
    }

    /// If set to `True`, the first batch of answers is streamed to the driver even without an explicit request for it.
    pub fn prefetch(self, prefetch: bool) -> Self {
        Self { prefetch: Some(prefetch), ..self }
    }

    /// If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request.
    pub fn prefetch_size(self, prefetch_size: u64) -> Self {
        Self { prefetch_size: Some(prefetch_size), ..self }
    }

    /// If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions.
    pub fn transaction_timeout(self, timeout: Duration) -> Self {
        Self { transaction_timeout: Some(timeout), ..self }
    }

    /// If set, specifies how long the driver should wait if opening a transaction is blocked by an exclusive schema write lock.
    pub fn schema_lock_acquire_timeout(self, timeout: Duration) -> Self {
        Self { schema_lock_acquire_timeout: Some(timeout), ..self }
    }

    /// If set to `True`, enables reading data from any replica, potentially boosting read throughput. Only settable in TypeDB Cloud.
    pub fn read_any_replica(self, read_any_replica: bool) -> Self {
        Self { read_any_replica: Some(read_any_replica), ..self }
    }
}