com.arangodb.util

Class AqlQueryOptions

java.lang.Object

com.arangodb.util.AqlQueryOptions

All Implemented Interfaces:

OptionsInterface

public class AqlQueryOptions
extends Object
implements OptionsInterface

Constructor Summary

Constructors

Constructor and Description
AqlQueryOptions()

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getBatchSize() maximum number of result documents to be transferred from the server to the client in one roundtrip (optional).
Boolean	getCache() flag to determine whether the AQL query cache shall be used.
Boolean	getCount() boolean flag that indicates whether the number of documents in the result set should be returned in the "count" attribute of the result (optional).
Boolean	getFullCount() if set to true and the query contains a LIMIT clause, then the result will contain an extra attribute extra with a sub-attribute fullCount.
Integer	getTtl() an optional time-to-live for the cursor (in seconds).
AqlQueryOptions	setBatchSize(Integer batchSize) maximum number of result documents to be transferred from the server to the client in one roundtrip (optional).
AqlQueryOptions	setCache(Boolean cache) flag to determine whether the AQL query cache shall be used.
AqlQueryOptions	setCount(Boolean count) boolean flag that indicates whether the number of documents in the result set should be returned in the "count" attribute of the result (optional).
AqlQueryOptions	setFullCount(Boolean fullCount) if set to true and the query contains a LIMIT clause, then the result will contain an extra attribute extra with a sub-attribute fullCount.
AqlQueryOptions	setTtl(Integer ttl) an optional time-to-live for the cursor (in seconds).
Map<String,Object>	toMap()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AqlQueryOptions

public AqlQueryOptions()

Method Detail

getCount

public Boolean getCount()

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

Returns:

flag that indicates whether the number of documents in the result set should be returned

setCount

public AqlQueryOptions setCount(Boolean count)

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

Parameters:

count - boolean flag

Returns:

this

getBatchSize

public Integer getBatchSize()

maximum number of result documents to be transferred from the server to the client in one roundtrip (optional). If this attribute is not set, a server-controlled default value will be used. The batch size has to be greater than 0.

Returns:

maximum number of result documents

setBatchSize

public AqlQueryOptions setBatchSize(Integer batchSize)

maximum number of result documents to be transferred from the server to the client in one roundtrip (optional). If this attribute is not set, a server-controlled default value will be used. The batch size has to be greater than 0.

Parameters:

batchSize - maximum number of result documents

Returns:

this

getFullCount

public Boolean getFullCount()

if set to true and the query contains a LIMIT clause, then the result will contain an extra attribute extra with a sub-attribute fullCount. This sub-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.

Returns:

boolean flag

setFullCount

public AqlQueryOptions setFullCount(Boolean fullCount)

if set to true and the query contains a LIMIT clause, then the result will contain an extra attribute extra with a sub-attribute fullCount. This sub-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.

Parameters:

fullCount - boolean flag

Returns:

this

getTtl

public Integer getTtl()

an optional 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.

Returns:

optional time-to-live

setTtl

public AqlQueryOptions setTtl(Integer ttl)

an optional 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.

Parameters:

ttl - optional time-to-live

Returns:

this

getCache

public Boolean getCache()

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. (since ArangoDB 2.7)

Returns:

boolean flag

setCache

public AqlQueryOptions setCache(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. (since ArangoDB 2.7)

Parameters:

cache - boolean flag

Returns:

this

toMap

public Map<String,Object> toMap()

Specified by:

toMap in interface OptionsInterface