AqlQueryExplainOptions (arangodb-java-driver 7.6.0 API)

java.lang.Object
- com.arangodb.model.AqlQueryExplainOptions

public final class AqlQueryExplainOptions
extends Object

Author:: Mark Vollmary, Michele Rastelli

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AqlQueryExplainOptions.Optimizer

static class AqlQueryExplainOptions.Options

Constructor Summary

Constructors
Constructor Description

AqlQueryExplainOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AqlQueryExplainOptions`	`allPlans(Boolean allPlans)`
`Boolean`	`getAllPlans()`
`Map<String,Object>`	`getBindVars()`
`Integer`	`getMaxNumberOfPlans()`
`String`	`getQuery()`
`Collection<String>`	`getRules()`
`AqlQueryExplainOptions`	`maxNumberOfPlans(Integer maxNumberOfPlans)`
`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
```
public Map<String,Object> getBindVars()
```
  - getQuery
```
public String getQuery()
```
  - 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