Package com.c8db.model

Class C8qlQueryOptions

java.lang.Object

com.c8db.model.C8qlQueryOptions

All Implemented Interfaces:

Serializable

public class C8qlQueryOptions
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
C8qlQueryOptions()

Method Summary

Modifier and Type	Method	Description
protected C8qlQueryOptions	bindVars(com.arangodb.velocypack.VPackSlice bindVars)
C8qlQueryOptions	cache(Boolean cache)
C8qlQueryOptions	count(Boolean count)
protected com.arangodb.velocypack.VPackSlice	getBindVars()
Boolean	getCache()
Boolean	getCount()
Boolean	getProfile()
protected String	getQuery()
Collection<String>	getRules()
C8qlQueryOptions	profile(Boolean profile)
protected C8qlQueryOptions	query(String query)
C8qlQueryOptions	rules(Collection<String> rules)

Methods inherited from class java.lang.Object

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

Constructor Detail

C8qlQueryOptions

public C8qlQueryOptions()

Method Detail

getCount

public Boolean getCount()

count

public C8qlQueryOptions 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

getCache

public Boolean getCache()

cache

public C8qlQueryOptions 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 com.arangodb.velocypack.VPackSlice getBindVars()

bindVars

protected C8qlQueryOptions bindVars(com.arangodb.velocypack.VPackSlice bindVars)

Parameters:

bindVars - key/value pairs representing the bind parameters

Returns:

options

getQuery

protected String getQuery()

query

protected C8qlQueryOptions 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 C8qlQueryOptions 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

getRules

public Collection<String> getRules()

rules

public C8qlQueryOptions 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