Struct rincon_client::cursor::types::CursorOptions

pub struct CursorOptions { /* fields omitted */ }

Optional parameters for tweaking query execution.

Methods

impl CursorOptions

pub fn set_fail_on_warning<W>(&mut self, fail_on_warning: W) where
    W: Into<Option<bool>>, 

Sets the flag indicating whether the query shall fail on warnings.

When set to true, the query will throw an exception and abort instead of producing a warning. This option should be used during development to catch potential issues early. When the attribute is set to false, warnings will not be propagated to exceptions and will be returned with the query result. There is also a server configuration option --query.fail-on-warning for setting the default value for fail_on_warning so it does not need to be set on a per-query level.

pub fn is_fail_on_warning(&self) -> Option<bool>

Returns whether the query shall fail on warnings.

pub fn set_profile<P>(&mut self, profile: P) where
    P: Into<Option<bool>>, 

Sets the flag indicating whether additional query profiling information shall be returned.

If set to true, then the additional query profiling information will be returned in the sub-attribute profile of the extra return attribute if the query result is not served from the query cache.

pub fn is_profile(&self) -> Option<bool>

Returns whether additional query profiling information shall be returned.

pub fn set_max_warning_count<C>(&mut self, max_warning_count: C) where
    C: Into<Option<u32>>, 

Sets the maximum number of warnings a query will return.

The number of warnings a query will return is limited to 10 by default, but that number can be increased or decreased by setting this attribute.

pub fn max_warning_count(&self) -> Option<u32>

Returns the maximum number of warnings a query will return.

pub fn set_full_count<C>(&mut self, full_count: C) where
    C: Into<Option<bool>>, 

Set the flag indicating whether full count and stats should be returned.

If set to true and the query contains a LIMIT clause, then the result will have an extra attribute with the sub-attributes stats and fullCount, { ... , "extra": { "stats": { "fullCount": 123 } } }. The fullCount attribute will contain the number of documents in the result before the last LIMIT in the query was applied. It can be used to count the number of documents that match certain filter criteria, but only return a subset of them, in one go. It is thus similar to MySQL's SQL_CALC_FOUND_ROWS hint. Note that setting the option will disable a few LIMIT optimizations and may lead to more documents being processed, and thus make queries run longer. Note that the fullCount attribute will only be present in the result if the query has a LIMIT clause and the LIMIT clause is actually used in the query.

pub fn is_full_count(&self) -> Option<bool>

Returns whether full count and stats should be returned.

pub fn set_max_plans<P>(&mut self, max_plans: P) where
    P: Into<Option<u32>>, 

Sets the maximum number of plans that are created by the AQL query optimizer.

pub fn max_plans(&self) -> Option<u32>

Returns the maximum number of plans that are created by the AQL query optimizer.

pub fn optimizer_mut(&mut self) -> &mut Optimizer

Returns a mutable reference to the optimizer options.

pub fn remove_optimizer(&mut self) -> Option<Optimizer>

Removes the optimizer options from this struct and returns the them.

pub fn optimizer(&self) -> Option<&Optimizer>

Returns a reference to the optimizer options.

pub fn set_intermediate_commit_count<C>(&mut self, intermediate_commit_count: C) where
    C: Into<Option<u32>>, 

Sets the maximum number of operations after which an intermediate commit is performed automatically.

Honored by the RocksDB storage engine only.

pub fn intermediate_commit_count(&self) -> Option<u32>

Returns the maximum number of operations after which an intermediate commit is performed automatically.

Honored by the RocksDB storage engine only.

pub fn set_intermediate_commit_size<S>(&mut self, intermediate_commit_size: S) where
    S: Into<Option<u32>>, 

Sets the maximum total size of operations after which an intermediate commit is performed automatically.

Honored by the RocksDB storage engine only.

pub fn intermediate_commit_size(&self) -> Option<u32>

Returns the maximum total size of operations after which an intermediate commit is performed automatically.

Honored by the RocksDB storage engine only.

pub fn set_max_transaction_size<S>(&mut self, max_transaction_size: S) where
    S: Into<Option<u32>>, 

Sets the transaction size limit in bytes.

Honored by the RocksDB storage engine only.

pub fn max_transaction_size(&self) -> Option<u32>

Returns the transaction size limit in bytes.

Honored by the RocksDB storage engine only.

pub fn set_satellite_sync_wait<W>(&mut self, satellite_sync_wait: W) where
    W: Into<Option<bool>>, 

Sets the enterprise parameter that configures how long a DBServer will have time to bring the satellite collections involved in the query into sync.

The default value is 60.0 (seconds). When the max time has been reached the query will be stopped.

pub fn satellite_sync_wait(&self) -> Option<bool>

Returns the enterprise parameter that configures how long a DBServer will have time to bring the satellite collections involved in the query into sync.

Trait Implementations

impl Debug for CursorOptions

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for CursorOptions

fn clone(&self) -> CursorOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for CursorOptions

fn eq(&self, __arg_0: &CursorOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &CursorOptions) -> bool

This method tests for !=.

impl Default for CursorOptions

fn default() -> Self

Returns the "default value" for a type.