com.arangodb.model

Class AqlQueryExplainOptions

java.lang.Object

com.arangodb.model.AqlQueryExplainOptions

public class AqlQueryExplainOptions
extends Object

Author:

Mark Vollmary

See Also:

API Documentation

Constructor Summary

Constructors

Constructor and Description
AqlQueryExplainOptions()

Method Summary

Modifier and Type	Method and Description
AqlQueryExplainOptions	allPlans(Boolean allPlans)
protected AqlQueryExplainOptions	bindVars(Map<String,Object> bindVars)
Boolean	getAllPlans()
protected Map<String,Object>	getBindVars()
Integer	getMaxNumberOfPlans()
protected String	getQuery()
Collection<String>	getRules()
AqlQueryExplainOptions	maxNumberOfPlans(Integer maxNumberOfPlans)
protected AqlQueryExplainOptions	query(String query)
AqlQueryExplainOptions	rules(Collection<String> rules)

Methods inherited from class java.lang.Object

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

Constructor Detail

AqlQueryExplainOptions

public AqlQueryExplainOptions()

Method Detail

getBindVars

protected Map<String,Object> getBindVars()

bindVars

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

Parameters:

bindVars - key/value pairs representing the bind parameters

Returns:

options

getQuery

protected String getQuery()

query

protected AqlQueryExplainOptions query(String query)

Parameters:

query - the query which you want explained

Returns:

options

getMaxNumberOfPlans

public Integer getMaxNumberOfPlans()

maxNumberOfPlans

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