com.arangodb.model

Class AqlQueryOptions

java.lang.Object

com.arangodb.model.AqlQueryOptions

public class AqlQueryOptions
extends Object

Author:

Mark - mark at arangodb.com

See Also:

API Documentation

Constructor Summary

Constructors

Constructor and Description
AqlQueryOptions()

Method Summary

Modifier and Type	Method and Description
AqlQueryOptions	batchSize(Integer batchSize)
protected AqlQueryOptions	bindVars(Map<String,Object> bindVars)
AqlQueryOptions	cache(Boolean cache)
AqlQueryOptions	count(Boolean count)
AqlQueryOptions	fullCount(Boolean fullCount)
Integer	getBatchSize()
protected Map<String,Object>	getBindVars()
Boolean	getCache()
Boolean	getCount()
Boolean	getFullCount()
Integer	getMaxPlans()
Boolean	getProfile()
protected String	getQuery()
Collection<String>	getRules()
Integer	getTtl()
AqlQueryOptions	maxPlans(Integer maxPlans)
AqlQueryOptions	profile(Boolean profile)
protected AqlQueryOptions	query(String query)
AqlQueryOptions	rules(Collection<String> rules)
AqlQueryOptions	ttl(Integer ttl)

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()

count

public AqlQueryOptions count(Boolean count)

Parameters:

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.

Returns:

options

getTtl

public Integer getTtl()

ttl

public AqlQueryOptions ttl(Integer ttl)

Parameters:

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.

Returns:

options

getBatchSize

public Integer getBatchSize()

batchSize

public AqlQueryOptions batchSize(Integer batchSize)

Parameters:

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.

Returns:

options

getCache

public Boolean getCache()

cache

public AqlQueryOptions cache(Boolean cache)

Parameters:

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.

Returns:

options

getBindVars

protected Map<String,Object> getBindVars()

bindVars

protected AqlQueryOptions bindVars(Map<String,Object> bindVars)

Parameters:

bindVars - key/value pairs representing the bind parameters

Returns:

options

getQuery

protected String getQuery()

query

protected AqlQueryOptions query(String query)

Parameters:

query - the query which you want parse

Returns:

options

getProfile

public Boolean getProfile()

Returns:

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.

profile

public AqlQueryOptions profile(Boolean profile)

Parameters:

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.

Returns:

options

getFullCount

public Boolean getFullCount()

fullCount

public AqlQueryOptions fullCount(Boolean fullCount)

Parameters:

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.

Returns:

options

getMaxPlans

public Integer getMaxPlans()

maxPlans

public AqlQueryOptions maxPlans(Integer maxPlans)

Parameters:

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

Returns:

options

getRules

public Collection<String> getRules()

rules

public AqlQueryOptions rules(Collection<String> rules)

Parameters:

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

Returns:

options