Struct QueryOptions

pub struct QueryOptions {
    pub include_instance_types: Option<bool>,
    pub prefetch_size: Option<u64>,
}

TypeDB query options. QueryOptions object can be used to override the default server behaviour for executed queries.

Examples

let options = QueryOptions::new().include_instance_types(true);

Fields

include_instance_types: Option<bool>

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.

prefetch_size: Option<u64>

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.

Implementations

impl QueryOptions

pub fn new() -> Self

pub fn include_instance_types(self, include_instance_types: bool) -> Self

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 prefetch_size(self, prefetch_size: u64) -> 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.

Trait Implementations

impl Clone for QueryOptions

fn clone(&self) -> QueryOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryOptions

fn default() -> QueryOptions

Returns the “default value” for a type.

impl Copy for QueryOptions