typedb-driver 3.10.0

TypeDB Rust Driver
Documentation 
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

/*
 * 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.
 */

/// TypeDB query options.
/// `QueryOptions` object can be used to override the default server behaviour for executed queries.
///
/// # Examples
///
/// ```rust
/// let options = QueryOptions::new().include_instance_types(true);
/// ```
#[derive(Clone, Copy, Debug, Default)]
pub struct QueryOptions {
    /// If set, specifies if types should be included in instance structs returned in ConceptRow answers.
    /// This option allows reducing the amount of unnecessary data transmitted.
    pub include_instance_types: Option<bool>,

    /// If set, specifies the number of extra query responses sent before the client side has to re-request more responses.
    /// Increasing this may increase performance for queries with a huge number of answers, as it can
    /// reduce the number of network round-trips at the cost of more resources on the server side.
    /// Minimal value: 1.
    pub prefetch_size: Option<u64>,

    /// If set, requests the server to return the structure of the query in the ConceptRow header.
    pub include_query_structure: Option<bool>,
}

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

    /// If set, specifies if types should be included in instance structs returned in ConceptRow answers.
    /// This option allows reducing the amount of unnecessary data transmitted.
    pub fn include_instance_types(self, include_instance_types: bool) -> Self {
        Self { include_instance_types: Some(include_instance_types), ..self }
    }

    /// If set, specifies the number of extra query responses sent before the client side has to re-request more responses.
    /// Increasing this may increase performance for queries with a huge number of answers, as it can
    /// reduce the number of network round-trips at the cost of more resources on the server side.
    pub fn prefetch_size(self, prefetch_size: u64) -> Self {
        Self { prefetch_size: Some(prefetch_size), ..self }
    }

    /// If set, requests the server to return the structure of the query in the ConceptRow header.
    pub fn include_query_structure(self, include_query_structure: bool) -> Self {
        Self { include_query_structure: Some(include_query_structure), ..self }
    }
}