Struct typedb_driver::Options

pub struct Options {
    pub infer: Option<bool>,
    pub trace_inference: Option<bool>,
    pub explain: Option<bool>,
    pub parallel: Option<bool>,
    pub prefetch: Option<bool>,
    pub prefetch_size: Option<i32>,
    pub session_idle_timeout: Option<Duration>,
    pub transaction_timeout: Option<Duration>,
    pub schema_lock_acquire_timeout: Option<Duration>,
    pub read_any_replica: Option<bool>,
}

TypeDB session and transaction options. TypeDBOptions object can be used to override the default server behaviour. Options are specified using properties assignment.

Examples

let options = Options::new().infer(true).explain(true);

Fields

infer: Option<bool>

If set to True, enables inference for queries. Only settable at transaction level and above. Only affects read transactions.

trace_inference: Option<bool>

If set to True, reasoning tracing graphs are output in the logging directory. Should be used with parallel = False.

explain: Option<bool>

If set to True, enables explanations for queries. Only affects read transactions.

parallel: Option<bool>

If set to True, the server uses parallel instead of single-threaded execution.

prefetch: Option<bool>

If set to True, the first batch of answers is streamed to the driver even without an explicit request for it.

prefetch_size: Option<i32>

If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request.

session_idle_timeout: Option<Duration>

If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive.

transaction_timeout: Option<Duration>

If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions.

schema_lock_acquire_timeout: Option<Duration>

If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock.

read_any_replica: Option<bool>

If set to True, enables reading data from any replica, potentially boosting read throughput. Only settable in TypeDB Cloud.

Implementations

impl Options

pub fn new() -> Self

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

If set to True, enables inference for queries. Only settable at transaction level and above. Only affects read transactions.

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

If set to True, reasoning tracing graphs are output in the logging directory. Should be used with parallel = False.

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

If set to True, enables explanations for queries. Only affects read transactions.

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

If set to True, the server uses parallel instead of single-threaded execution.

pub fn prefetch(self, prefetch: bool) -> 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_size(self, prefetch_size: i32) -> Self

If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request.

pub fn session_idle_timeout(self, timeout: Duration) -> Self

If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive.

pub fn transaction_timeout(self, timeout: Duration) -> Self

If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions.

pub fn schema_lock_acquire_timeout(self, timeout: Duration) -> Self

If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock.

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

If set to True, enables reading data from any replica, potentially boosting read throughput. Only settable in TypeDB Cloud.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl Copy for Options