com.arangodb.springframework.annotation

Annotation Type QueryOptions

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface QueryOptions

Annotation to set additional query options for custom AQL (ArangoDB Query Language) queries defined on repository methods.

Author:

Mark Vollmary

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowDirtyRead Set to true allows reading from followers in an active-failover setup.
int	batchSize Maximum number of result documents to be transferred from the server to the client in one roundtrip.
boolean	cache Flag to determine whether the AQL query cache shall be used.
boolean	count Indicates whether the number of documents in the result set should be returned in the "count" attribute of the result.
boolean	fullCount 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 } } }.
int	maxPlans Limits the maximum number of plans that are created by the AQL query optimizer.
long	memoryLimit The maximum number of memory (measured in bytes) that the query is allowed to use.
boolean	profile 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.
String[]	rules A list of to-be-included or to-be-excluded optimizer rules can be put into this attribute, telling the optimizer to include or exclude specific rules.
boolean	stream Specify true and the query will be executed in a streaming fashion.
int	ttl The time-to-live for the cursor (in seconds).

Element Detail

batchSize

public abstract int batchSize

Maximum number of result documents to be transferred from the server to the client in one roundtrip. If this attribute is not set, a server-controlled default value will be used. A batchSize value of 0 is disallowed.

Default:

-1

cache

public abstract boolean cache

Flag to determine whether the AQL query cache shall be used. If set to false, then any query cache lookup will be skipped for the query. If set to true, it will lead to the query cache being checked for the query if the query cache mode is either on or demand.

Default:

false

count

public abstract boolean count

Indicates whether the number of documents in the result set should be returned in the "count" attribute of the result. Calculating the "count" attribute might have a performance impact for some queries in the future so this option is turned off by default, and "count" is only returned when requested.

Default:

false

fullCount

public abstract boolean fullCount

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.

Default:

false

maxPlans

public abstract int maxPlans

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

Default:

-1

profile

public abstract boolean profile

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.

Default:

false

rules

public abstract String[] rules

A list of 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

Default:

{}

ttl

public abstract int ttl

The time-to-live for the cursor (in seconds). The cursor will be removed on the server automatically after the specified amount of time. This is useful to ensure garbage collection of cursors that are not fully fetched by clients. If not set, a server-defined value will be used.

Default:

-1

stream

public abstract boolean stream

Specify true and the query will be executed in a streaming fashion. The query result is not stored on the server, but calculated on the fly. Beware: long-running queries will need to hold the collection locks for as long as the query cursor exists. When set to false a query will be executed right away in its entirety. In that case query results are either returned right away (if the resultset is small enough), or stored on the arangod instance and accessible via the cursor API (with respect to the ttl). It is advisable to only use this option on short-running queries or without exclusive locks (write-locks on MMFiles). Please note that the query options cache, count and fullCount will not work on streaming queries. Additionally query statistics, warnings and profiling data will only be available after the query is finished. The default value is false

Since:

ArangoDB 3.4.0

Default:

false

memoryLimit

public abstract long memoryLimit

The maximum number of memory (measured in bytes) that the query is allowed to use. If set, then the query will fail with error "resource limit exceeded" in case it allocates too much memory. A value of 0 indicates that there is no memory limit.

Since:

ArangoDB 3.1.0

Default:

-1L

allowDirtyRead

public abstract boolean allowDirtyRead

Set to true allows reading from followers in an active-failover setup.

Since:

ArangoDB 3.4.0

Default:

false