Struct arangors::aql::AqlOption

pub struct AqlOption {
    pub fail_on_warning: Option<bool>,
    pub profile: Option<bool>,
    pub max_warning_count: Option<u32>,
    pub full_count: Option<bool>,
    pub max_plans: Option<u32>,
    pub optimizer: Vec<String>,
    pub intermediate_commit_count: Option<u32>,
    pub intermediate_commit_size: Option<u32>,
    pub max_transaction_size: Option<u32>,
    pub satellite_sync_wait: Option<bool>,
}

Fields

fail_on_warning: Option<bool>

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.

profile: Option<bool>

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.

max_warning_count: Option<u32>

Limits 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.

full_count: Option<bool>

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.

max_plans: Option<u32>

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

optimizer: Vec<String>

A list string indicating to-be-included or to-be-excluded optimizer rules can be put into this attribute, telling the optimizer to include or exclude specific rules.

To disable a rule, prefix its name with a -.

To enable a rule, prefix it with a +.

There is also a pseudo-rule "all", which will match all optimizer rules.

intermediate_commit_count: Option<u32>

Maximum number of operations after which an intermediate commit is performed automatically.

Honored by the RocksDB storage engine only.

intermediate_commit_size: Option<u32>

Maximum total size of operations after which an intermediate commit is performed automatically.

Honored by the RocksDB storage engine only.

max_transaction_size: Option<u32>

Transaction size limit in bytes.

Honored by the RocksDB storage engine only.

satellite_sync_wait: Option<bool>

This enterprise parameter allows to configure 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.

Methods

impl AqlOption

pub fn set_optimizer(&mut self, optimizer: String)

Trait Implementations

impl Default for AqlOption

fn default() -> AqlOption

Returns the "default value" for a type.

impl Debug for AqlOption

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

Formats the value using the given formatter.

impl Serialize for AqlOption

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.