Package com.c8db.model

Class C8qlQueryExplainOptions

java.lang.Object

com.c8db.model.C8qlQueryExplainOptions

public class C8qlQueryExplainOptions
extends Object

See Also:

API Documentation

Constructor Summary

Constructors

Constructor	Description
C8qlQueryExplainOptions()

Method Summary

Modifier and Type	Method	Description
C8qlQueryExplainOptions	allPlans(Boolean allPlans)
protected C8qlQueryExplainOptions	bindVars(com.arangodb.velocypack.VPackSlice bindVars)
Boolean	getAllPlans()
protected com.arangodb.velocypack.VPackSlice	getBindVars()
Integer	getMaxNumberOfPlans()
protected String	getQuery()
Collection<String>	getRules()
C8qlQueryExplainOptions	maxNumberOfPlans(Integer maxNumberOfPlans)
protected C8qlQueryExplainOptions	query(String query)
C8qlQueryExplainOptions	rules(Collection<String> rules)

Methods inherited from class java.lang.Object

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

Constructor Detail

C8qlQueryExplainOptions

public C8qlQueryExplainOptions()

Method Detail

getBindVars

protected com.arangodb.velocypack.VPackSlice getBindVars()

bindVars

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

Parameters:

bindVars - key/value pairs representing the bind parameters

Returns:

options

getQuery

protected String getQuery()

query

protected C8qlQueryExplainOptions query(String query)

Parameters:

query - the query which you want explained

Returns:

options

getMaxNumberOfPlans

public Integer getMaxNumberOfPlans()

maxNumberOfPlans

public C8qlQueryExplainOptions maxNumberOfPlans(Integer maxNumberOfPlans)

Parameters:

maxNumberOfPlans - an optional maximum number of plans that the optimizer is allowed to generate. Setting this attribute to a low value allows to put a cap on the amount of work the optimizer does.

Returns:

options

getAllPlans

public Boolean getAllPlans()

allPlans

public C8qlQueryExplainOptions allPlans(Boolean allPlans)

Parameters:

allPlans - if set to true, all possible execution plans will be returned. The default is false, meaning only the optimal plan will be returned.

Returns:

options

getRules

public Collection<String> getRules()

rules

public C8qlQueryExplainOptions rules(Collection<String> rules)

Parameters:

rules - an array 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.

Returns:

options