ExplainField uses ConstantsTrait

Keys of the `POST /_api/explain` response (and of the nested execution plan).

Tags

see

ExplainResult

https://docs.arangodb.com/stable/aql/execution-and-performance/explaining-queries/

Table of Contents

Constants

CACHEABLE  : string = 'cacheable'

Whether the query result could be served from the query cache.

COLLECTION  : string = 'collection'

The collection a node operates on.

COLLECTIONS  : string = 'collections'

The collections accessed by the query (`{ name, type }`).

ESTIMATED_COST  : string = 'estimatedCost'

The optimizer's estimated total cost of the plan.

ESTIMATED_NR_ITEMS  : string = 'estimatedNrItems'

The optimizer's estimated number of result items.

FIELDS  : string = 'fields'

An index's covered fields.

INDEX_NODE  : string = 'IndexNode'

The node type that carries the indexes actually used by the query.

INDEXES  : string = 'indexes'

The indexes used by an {@see self::INDEX_NODE}.

IS_MODIFICATION_QUERY  : string = 'isModificationQuery'

Whether the query writes data.

NAME  : string = 'name'

An index/collection name.

NODES  : string = 'nodes'

The ordered execution nodes of the plan.

PLAN  : string = 'plan'

The execution plan object (present when `allPlans` is not set).

PLANS  : string = 'plans'

The list of execution plans (present when `allPlans: true`).

RULES  : string = 'rules'

The names of the optimizer rules that were applied.

SELECTIVITY_ESTIMATE  : string = 'selectivityEstimate'

An index's selectivity estimate (0 … 1).

SPARSE  : string = 'sparse'

Whether an index is sparse.

STATS  : string = 'stats'

Optimizer statistics (rulesExecuted, plansCreated, peakMemoryUsage, …).

TYPE  : string = 'type'

A plan node's type discriminator (e.g. `"IndexNode"`).

UNIQUE  : string = 'unique'

Whether an index is unique.

VARIABLES  : string = 'variables'

The variables used in the plan.

WARNINGS  : string = 'warnings'

The optimizer warnings raised while planning the query.