Interfacebeta
ExplainResult
The query plan the server reports for a find. The shape is experimental and may change in any release; see docs/compatibility.md.
interface ExplainResultDefined in packages/driver/src/indexes.ts:122
Properties#
access
#betareadonly access?: "equality" | "in" | "range"How the index is read: by equality, by a list of values, or by a range.
Defined in packages/driver/src/indexes.ts:141
documents
#betareadonly documents: numberHow many documents the collection holds.
Defined in packages/driver/src/indexes.ts:149
estimatedCandidates
#betareadonly estimatedCandidates: numberHow many documents the server expects to examine.
Defined in packages/driver/src/indexes.ts:147
field
#betareadonly field?: stringThe first field the index covers, for IXSCAN.
Defined in packages/driver/src/indexes.ts:131
fields
#betareadonly fields?: readonly string[]Every field of a compound index, in order, for IXSCAN.
Defined in packages/driver/src/indexes.ts:133
index
#betareadonly index?: stringThe index used, for IXSCAN.
Defined in packages/driver/src/indexes.ts:129
lower
#betareadonly lower?: IndexBoundInfoThe lower end of a range scan.
Defined in packages/driver/src/indexes.ts:143
prefixLength
#betareadonly prefixLength?: numberHow many leading fields of a compound index the query fixes by equality.
Defined in packages/driver/src/indexes.ts:137
stage
#betareadonly stage: "COLLSCAN" | "IDLOOKUP" | "IXSCAN"The strategy: COLLSCAN reads every document, IDLOOKUP reads by _id,
and IXSCAN scans an index.
Defined in packages/driver/src/indexes.ts:127
upper
#betareadonly upper?: IndexBoundInfoThe upper end of a range scan.
Defined in packages/driver/src/indexes.ts:145