Type alias ExplainOptions

ExplainOptions: {
    allPlans?: boolean;
    maxNumberOfPlans?: number;
    optimizer?: {
        rules: string[];
    };
}

Options for explaining a query.

Optional allPlans?: boolean

If set to true, all possible execution plans will be returned as the plans property. Otherwise only the optimal execution plan will be returned as the plan property.

Default: false
Optional maxNumberOfPlans?: number

Maximum number of plans that the optimizer is allowed to generate. Setting this to a low value limits the amount of work the optimizer does.
Optional optimizer?: {
rules: string[];
}

An object with a rules property specifying a list of optimizer rules to be included or excluded by the optimizer for this query. Prefix a rule name with + to include it, or - to exclude it. The name all acts as an alias matching all optimizer rules.
- rules: string[]