AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

explain の結果

クエリ プランとクエリ プランの実行統計に関する情報を返すために、MongoDB は次のメソッドを提供します。

重要な Explain プラン フィールドとその解釈方法については、「Explain プラン 結果の解釈」を参照してください。

重要

explain はプラン キャッシュを無視します。その代わりに、候補プランのセットが生成され、プラン キャッシュをコンサルティングすることなく勝者が選ばれます。さらに、explain は MongoDB クエリ プランナーが当選プランをキャッシュするのを防ぎます。

注意

このページには最も重要な出力フィールドのみが表示され、内部使用のフィールドについては文書化されていません。出力に記載されているフィールドは変更される場合があります。

explain の結果は、クエリプランがステージのツリーとして表示されます。出力構造は、操作で使用されるクエリ エンジンによって異なる場合があります。操作には、クラシック クエリ エンジンまたはスロットベースの実行クエリ エンジンを使用できます。

この構造は、db.collection.find()、およびcount、distinct、update、findAndModifyなど、同じクエリシステムを使用するコマンドに適用されます。集計操作は、最上位の stages 配列を持つ異なる構造を返します。集計のexplain出力の読み方を学ぶには、集計 Explain Outputを参照してください。

2 つの実行エンジン間で出力構造がどのように異なるかを確認するには、次の例を参照してください。

winningPlan: { stage: <STAGE1>, ... inputStage: { stage: <STAGE2>, ... inputStage: { stage: <STAGE3>, ... } }},

各ステージでは、結果のドキュメントまたはインデックス キーが親ノードに渡されます。リーフ ノードはコレクションまたはインデックスにアクセスします。内部ノードは、子ノードから生成されたドキュメントまたはインデックス キーを使用します。ルート ノードは、MongoDB が最終的に結果セットを導き出すステージを表します。

ステージは、操作について説明しています。例は次のとおりです。

  • COLLSCAN 、コレクションスキャン用

  • IXSCAN 、インデックス キーのスキャン用

  • FETCH 、ドキュメント検索用

  • GROUP 、ドキュメントのグループ化用

  • SHARD_MERGE シャードからの結果のマージ用

  • SHARDING_FILTER 、シャードから孤立したドキュメントのフィルタリング用

  • TS_MODIFY は、時系列コレクションの変更

  • BATCHED_DELETE 複数のドキュメントを内部的に一括削除する場合(MongoDB 6.1 以降)

  • EXPRESS は、最適化されたインデックススキャンプランを使用するために、通常のクエリプランをバイパスすることができる限られたクエリのセットのためのステージです(バージョン 8.0 の新機能)。

    EXPRESS ステージは次のいずれかになります。

    • EXPRESS_CLUSTERED_IXSCAN

    • EXPRESS_DELETE

    • EXPRESS_IXSCAN

    • EXPRESS_UPDATE

このセクションで示されているのは、MongoDB 5.1 以降の explain 出力です。MongoDB 5.1 より前のバージョンの explain 出力を確認するには、該当バージョンのドキュメントを参照してください。

explain.explainVersion

整数フィールドです。

explainVersion はプランの出力形式のバージョンです("1" や "2" など)。

バージョン5.1の新機能。

explain.queryPlanner 情報には、クエリオプティマイザによって選択されたプランの詳細が示されます。

これらの例では、MongoDB のクラシック実行エンジンとスロットベースの実行エンジンの出力構造を組み合わせることができます。どちらも典型的という意図はありません。出力が著しく異なる場合があります。

シャーディングされていないコレクションの場合、explain は次の queryPlanner 情報を返します。

queryPlanner: { namespace: <string>, indexFilterSet: <boolean>, parsedQuery: { ... }, planCacheShapeHash: <hexadecimal string>, planCacheKey: <hexadecimal string>, maxIndexedOrSolutionsReached: <boolean>, maxIndexedAndSolutionsReached: <boolean>, maxScansToExplodeReached: <boolean>, winningPlan: { stage: <STAGE1>, inputStage: { stage: <string>, ... } }, rejectedPlans: [ <candidate plan1>, ]}

MongoDB 8.0 以降では、既存の queryHashフィールドはplanCacheShapeHash という名前の新しいフィールドに重複します。 以前のバージョンのMongoDBを使用している場合は、queryHashフィールドのみが表示されます。 今後のMongoDBバージョンでは、非推奨の queryHashフィールドが排除されます。代わりに planCacheShapeHashフィールドを使用する必要があります。

explain.queryPlanner

クエリオプティマイザによるクエリプランの選択に関する情報が含まれています。

explain.queryPlanner.namespace

クエリによってアクセスされるデータベースとコレクションの名前を含む名前空間を指定する文字列です。名前空間の形式は <database>.<collection> です。

explain.queryPlanner.indexFilterSet

MongoDB でプランキャッシュクエリシェイプにインデックス フィルターが適用されたかどうかを指定するブール値。

explain.queryPlanner.querySettings

クエリ設定が設定されている場合、querySettings にはクエリシェイプに適用されるクエリ設定の詳細が含まれます。

クエリ設定を追加し、querySettings での explain() 出力を含む例を確認するには、setQuerySettings を参照してください。

バージョン8.0の新機能。

explain.queryPlanner.planCacheShapeHash

MongoDB 8.0 以降では、既存の queryHashフィールドはplanCacheShapeHash という名前の新しいフィールドに重複します。 以前のバージョンのMongoDBを使用している場合は、queryHashフィールドのみが表示されます。 今後のMongoDBバージョンでは、非推奨の queryHashフィールドが排除されます。代わりに planCacheShapeHashフィールドを使用する必要があります。

プランキャッシュクエリシェイプのハッシュを表す16進数文字列で、プランキャッシュクエリシェイプにのみ依存します。planCacheShapeHash は、同じプランキャッシュクエリシェイプを持つ遅いクエリ(書き込み操作のクエリフィルタを含む)を識別するのに役立ちます。

注意

他のハッシュ関数と同様に、2 つの異なるプランキャッシュクエリシェイプで同じハッシュ値が生成される場合があります。ただし、異なるプランキャッシュクエリシェイプ間でハッシュ衝突が発生する可能性は低くなります。

planCacheShapeHash と planCacheKey の詳細については、planCacheShapeHash と planCacheKey を参照してください。

explain.queryPlanner.planCacheKey

クエリに関連付けられたプラン キャッシュ エントリのキーのハッシュです。

explain.queryPlanner.planCacheShapeHash とは異なり、explain.queryPlanner.planCacheKey は、プランキャッシュクエリシェイプとそのシェイプで現在使用可能なインデックスの両方の関数です。具体的には、クエリシェイプをサポートできるインデックスを追加または削除すると、planCacheKey の値は変わりますが planCacheShapeHash の値は変わりません。

planCacheShapeHash と planCacheKey の詳細については、planCacheShapeHash と planCacheKey を参照してください。

explain.queryPlanner.optimizationTimeMillis

クエリ プランナーがクエリの最適化に費やした時間(ミリ秒)。この結果には、内部 $lookup クエリの最適化に費やされた時間は含まれません。

explain.queryPlanner.optimizedPipeline

集計パイプライン操作全体が最適化され、クエリプランの実行ステージをツリー形式に体系化して実行されるようになったことを示すブール値。

たとえば、次の集計操作は集計パイプラインを使用するのではなく、クエリプラン実行のツリーで実行できます。

db.example.aggregate([ { $match: { someFlag: true } } ] )

このフィールドは、値が true の場合にのみ表示され、集計パイプライン操作を説明する目的でのみ適用されます。値を true に設定すると、パイプラインが最適化されたため、集計ステージ情報は出力に表示されません。

explain.queryPlanner.winningPlan

クエリオプティマイザによって選択されたプランの詳細が記載されたドキュメントです。

explain.queryPlanner.winningPlan.stage

ステージ名を示す文字列。

各ステージは、ステージに固有の情報で構成されます。たとえば、IXSCAN ステージには、インデックスの限界と、インデックス スキャンに固有の他のデータが含まれます。ステージに子ステージが 1 つまたは複数ある場合、そのステージには inputStage または inputStages が含まれます。

このフィールドは、操作でクラシック クエリ実行エンジンが使用された場合に表示されます。

explain.queryPlanner.winningPlan.inputStage

子ステージを記述するドキュメントで、ドキュメントまたはインデックス キーを親に提供します。このフィールドは、親ステージに子ステージが 1 つのみという条件を満たす場合に表示されます。

explain.queryPlanner.winningPlan.inputStages

子ステージを説明するドキュメントの配列。 子ステージは、親ステージにドキュメントまたはインデックス キーを提供します。 このフィールドは、親ステージに複数の子ノードがある場合に表示されます。 たとえば、 $or 式の ステージは複数のソースからの入力を消費する可能性があります。

このフィールドは、操作でクラシック クエリ実行エンジンが使用された場合に表示されます。

explain.queryPlanner.winningPlan.isCached

winPlan がプラン キャッシュにあるかどうかを示すブール値。

このフィールドは、当選プランと拒否されたプランの間に最大 1 つのプランがある場合、 trueです。 クエリにキャッシュされたプランがない場合、このフィールドは当選したプランと拒否されたプランのfalseになります。

explain.queryPlanner.winningPlan.queryPlan

クエリオプティマイザによって選択されたプランの詳細が記載されたドキュメントです。MongoDB では、プランはステージのツリーとして表示されます。

このドキュメントは、クエリがスロットベースの実行クエリエンジンを使用した場合に表示されます。

バージョン5.1の新機能。

explain.queryPlanner.winningPlan.queryPlan.stage

ステージ名を示す文字列。

各ステージは、ステージに固有の情報で構成されます。たとえば、IXSCAN ステージには、インデックスの限界と、インデックス スキャンに固有の他のデータが含まれます。

explain.queryPlanner.winningPlan.queryPlan.planNodeId

実行プランの各ステージを識別するユニークな整数フィールドで、explain 結果全体をカバーするすべてのステージに含まれます。

バージョン5.1の新機能。

explain.queryPlanner.winningPlan.queryPlan.inputStage

「explain.queryPlanner.winningPlan.inputStage」を参照してください。

explain.queryPlanner.winningPlan.slotBasedPlan

スロットベースのクエリ実行プランのツリーとステージに関する情報が記載されたドキュメント。MongoDB の内部使用ドキュメントです。

バージョン5.1の新機能。

explain.queryPlanner.winningPlan.slotBasedPlan.stages

実行順序、操作、スロット割り当てなど、スロットベースのクエリ実行プランの各ステージに関する情報を含むstring。MongoDB の内部使用ドキュメントです。

MongoDB 8.0 以降では、クエリでブロック処理が使用される場合、block_to_row と ts_bucket_to_cellblock はstages 出力に表示されます。

バージョン8.0で変更。

explain.queryPlanner.rejectedPlans

クエリオプティマイザによって検討および拒否された候補プランの配列です。他に候補プランがなければ、配列は空にできます。

拒否されたプランにはexplain.queryPlanner.winningPlanと同じフィールドが含まれます。

MongoDB 8.0以降、拒否されたクエリプランにはクエリのfind部分のみが含まれます。 以前のバージョンでは、拒否されたプランには$groupのような 集計ステージ が含まれることがあります。 これらの集計ステージは勝利プランを選択するためにクエリ プランナーによって使用されることはありません。そのため、 rejectedPlansフィールドには、勝利プランを選択するために使用されたクエリの部分のみが含まれます。

返されたexplain.executionStats情報には、当選プランの実行の詳細が表示されます。 結果にexecutionStatsを含めるには、次のいずれかで explain を実行する必要があります。

これらの例では、MongoDB のクラシック実行エンジンとスロットベースの実行エンジンの出力構造を組み合わせることができます。どちらも典型的という意図はありません。出力が著しく異なる場合があります。

シャーディングされていないコレクションの場合、explain は次の executionStats 情報を返します。

executionStats: { executionSuccess: <boolean>, nReturned: <int>, executionTimeMillis: <int>, totalKeysExamined: <int>, totalDocsExamined: <int>, executionStages: { stage: <STAGE1> nReturned: <int>, executionTimeMillisEstimate: <int>, opens: <int>, // Starting in MongoDB 5.1 closes: <int>, // Starting in MongoDB 5.1 works: <int>, advanced: <int>, needTime: <int>, needYield: <int>, saveState: <int>, restoreState: <int>, isEOF: <boolean>, ... inputStage: { stage: <STAGE2>, nReturned: <int>, ... numReads: <int>, // Starting in MongoDB 5.1 ... executionTimeMillisEstimate: <int>, ... inputStage: { ... } } }, allPlansExecution: [ { nReturned: <int>, executionTimeMillisEstimate: <int>, totalKeysExamined: <int>, totalDocsExamined: <int>, score: <double>, executionStages: { stage: <STAGEA>, nReturned: <int>, executionTimeMillisEstimate: <int>, ... inputStage: { stage: <STAGEB>, ... inputStage: { ... } } } }, ... ] operationMetrics: { cpuNanos: <int>, cursorSeeks: <int>, docBytesRead: <int>, docBytesWritten: <int>, docUnitsRead: <int>, docUnitsReturned: <int>, docUnitsWritten: <int>, idxEntryBytesRead: <int>, idxEntryBytesWritten: <int>, idxEntryUnitsRead: <int>, idxEntryUnitsWritten: <int>, totalUnitsWritten: <int>, keysSorted: <int>, sorterSpills: <int> }}
explain.executionStats

当選プランの完了したクエリ実行を示す統計が含まれます。書込み (write) 操作の場合、完了したクエリの実行とは、実行される予定の変更を指しますが、変更はデータベースに適用されません。

explain.executionStats.nReturned

当選したクエリプランが返したドキュメントの数。nReturned は、MongoDB の以前のバージョンで cursor.explain() によって返された n フィールドに対応しています。

explain.executionStats.executionTimeMillis

クエリプランの選択とクエリの実行に必要な合計時間(ミリ秒)。これには、プラン選択プロセスの試用段階を実行する時間は含まれるが、データをクライアントに送り返すためのネットワーク時間は含まれません。

explain.executionStats.executionTimeMillis によって報告される時間は、必ずしも実際のクエリ時間を表していません。定常状態の操作中(クエリプランがキャッシュされている場合)、または cursor.hint() を cursor.explain() とともに使用している場合、MongoDB はプラン選択プロセスをバイパスし、実際の時間が短縮されて explain.executionStats.executionTimeMillis 値が低くなります。

explain.executionStats.totalKeysExamined

スキャンされたインデックスエントリの数。explain.executionStats.totalKeysExamined は、MongoDB の以前のバージョンで cursor.explain() によって返された nscanned フィールドに対応しています。

explain.executionStats.totalDocsExamined

クエリの実行中に検査されたドキュメントの数。ドキュメントを検査する一般的なクエリ実行ステージは、COLLSCAN と FETCH です。

注意

explain.executionStats.totalDocsExamined は、返されたドキュメント数ではなく、検査されたドキュメントの合計数を示します。たとえば、ステージではフィルターを適用するためにドキュメントを調べることができます。ドキュメントがフィルターで除外された場合、そのドキュメントは検査済みですが、クエリ結果セットの一部として返されません。

クエリの実行中にドキュメントが複数回検査された場合、 explain.executionStats.totalDocsExaminedはそれぞれの検査でカウントします。 つまり、 explain.executionStats.totalDocsExaminedは検査された一意のドキュメントの合計数ではありません。

explain.executionStats.executionStages

当選プランの実行が完了したことをステージのツリーとして表示します。つまり、1 つのステージに 1 つの inputStage または複数の inputStages があってもかまいません。

MongoDB 5.1 以降では、次の入力ステージをステージに含めることができます。

  • thenStage

  • elseStage

  • innerStage

  • outerStage

各ステージは、ステージに固有の実行情報で構成されます。

explain.executionStats.executionStages.executionTimeMillisEstimate

クエリ実行の推定時間(ミリ秒単位)。

explain.executionStats.executionStages.opens

MongoDB 5.1 以降では、クエリの実行中にステージが開かれた回数を表します。

explain.executionStats.executionStages.closes

MongoDB 5.1 以降では、クエリ実行中にステージが閉じられた回数を表します。

explain.executionStats.executionStages.works

クエリ実行ステージで実行される「ワーク ユニット」の数を指定します。クエリの実行では、作業が小さな単位に分割されます。「ワークユニット」には、1 つのインデックス キーの調査、コレクションから 1 つのドキュメントの取り出し、1 つのドキュメントにプロジェクションを適用、あるいは、内部ブックキーピングの実行で構成される場合があります。

このフィールドは、操作でクラシック クエリ実行エンジンが使用された場合に表示されます。

explain.executionStats.executionStages.saveState

クエリ ステージで処理が中断され、現在の実行状態(ロックを解除する準備など)が保存された回数。

explain.executionStats.executionStages.restoreState

クエリ ステージが保存された実行状態を復元した回数です。たとえば、以前に生成したロックをリカバリした後です。

explain.executionStats.executionStages.isEOF

実行ステージがストリームの終わりに達したかどうかを次のとおり指定します。

  • true または 1 の場合、実行ステージはストリームの終端に達しています。

  • false または 0 の場合、ステージにまだ返される結果がある可能性があります。たとえば、制限のあるクエリで、実行ステージを構成するLIMIT ステージに、IXSCAN とクエリ用に入力するステージがあるものを考えてみましょう。このクエリから指定した制限を超える値が返される場合、LIMIT ステージでは isEOF: 1 と報告されますが、その基礎となる IXSCAN ステージでは isEOF: 0 と報告されます。

explain.executionStats.executionStages.opType

時系列コレクションに対する操作の場合、操作のタイプ。

explain.executionStats.executionStages.bucketFilter

時系列コレクションに対する操作の場合、バケット カタログでクエリされるバケットの数を絞るために使用されるフィルター。

explain.executionStats.executionStages.residualFilter

時系列コレクションに対する操作の場合、バケット カタログをクエリするために使用されるフィルター。

explain.executionStats.executionStages.nBucketsUnpacked

時系列コレクションに対する操作の場合、操作を解決するために開いたバケットの数。

explain.executionStats.executionStages.nMeasurementsDeleted

時系列コレクションに対する操作の場合、削除されたドキュメントの数。

explain.executionStats.executionStages.nMeasurementsInserted

時系列コレクション に対する操作の場合、挿入されたドキュメントの数。

explain.executionStats.executionStages.nMeasurementsMatched

時系列コレクションに対する操作の場合、一致したドキュメントの数。

explain.executionStats.executionStages.nMeasurementsModified

時系列コレクション に対する操作の場合、変更されたドキュメントの数。

explain.executionStats.executionStages.nMeasurementsUpserted

時系列コレクションに対する操作の場合、アップサートされたドキュメントの数。

explain.executionStats.executionStages.inputStage

各inputStage のフィールドは、inputStage.stage の値に応じて異なる可能性があります。次の表では、使用可能なフィールドとフィールドが表示される可能性のあるステージについて説明しています。

各inputStageには、別のinputStageをフィールドとして含めることができます。 出力構造の説明 を参照してください。

フィールド
説明
適用可能なステージ

docsExamined

クエリ実行ステージでスキャンされるドキュメントの数を指定します。

COLLSCAN, FETCH

keysExamined

インデックスをスキャンするクエリ実行ステージの場合、keysExamined はインデックス スキャンのプロセスで検査される限界内のキーと限界外のキーの総数。インデックス スキャンが 1 つの連続したキー範囲で構成されている場合は、範囲内のキーのみを調べる必要があります。インデックスの限界が複数のキー範囲で構成されている場合、インデックス スキャンの実行プロセスでは、ある範囲の終わりから次の範囲の先頭にスキップするために、範囲外のキーを調べることがあります。

IXSCAN

numReads

クエリ実行段階でスキャンされたドキュメントの数、または検査されたインデックス キーの数。

バージョン5.1の新機能。

COLLSCAN, IXSCAN

seeks

インデックス カーソルがインデックス スキャンを完了するための新しい位置を探すのに必要だった回数。

IXSCAN

spilledBytesApprox

ステージ内でディスクにスピルしたインメモリのバイト数の概算。

バージョン5.3の新機能。

GROUP

spilledRecords

ステージ内でディスクにスピルした、生成されたレコードの数。

バージョン5.3の新機能。

GROUP

usedDisk

ステージでディスクに書込み (write) されたかどうか。

バージョン5.3の新機能。

GROUP

explain.executionStats.allPlansExecution

当選したプランと拒否されたプランの両方について、プラン選択フェーズ中にキャプチャされた部分的な実行情報が含まれます。このフィールドは、explain が allPlansExecution 冗長モードで実行されている場合にのみ存在します。

explain.executionStats.operationMetrics

リソース消費統計が含まれます(0 の場合を除く)。このフィールドが表示されるのは、explain が executionStats 冗長モード以上で実行され、かつ profileOperationResourceConsumptionMetrics が有効な場合のみです。

シャーディングされていないコレクションの場合、explain は MongoDB インスタンスの次の serverInfo 情報を返します。

serverInfo: { host: <string>, port: <int>, version: <string>, gitVersion: <string>}

バージョン 5.0 の新機能。

explain の結果には、$lookup のパイプライン ステージを使用するクエリの実行統計を含めることができます。これらの実行統計を含めるには、以下のいずれかの実行冗長モードで説明操作を実行する必要があります。

$lookup クエリの explain の結果には次のフィールドが含まれます。

'$lookup': { from: <string>, as: <string>, localField: <string>, foreignField: <string>},totalDocsExamined: <long>,totalKeysExamined: <long>,collectionScans: <long>,indexesUsed: [ <string_1>, <string_2>, ..., <string_n> ],executionTimeMillisEstimate: <long>

$lookup セクションのフィールドの説明については、$lookup ページを参照してください。

その他のフィールドは次のとおりです。

explain.totalDocsExamined

クエリの実行中に調査されたドキュメントの数。

explain.totalKeysExamined

検査されたインデックス キーの数。

explain.collectionScans

クエリの実行中にコレクションスキャンが発生した回数です。コレクションスキャン中に、コレクション内の各ドキュメントがクエリ述語と比較されます。クエリをカバーする適切なインデックスが存在しない場合は、コレクションスキャンが実行されます。

explain.indexesUsed

クエリで使用されるインデックス名を含む文字列の配列。

explain.executionTimeMillisEstimate

クエリ実行の推定時間(ミリ秒単位)。

クエリ プランナーがコレクションスキャンを選択した場合、explain の結果には COLLSCAN ステージが含まれます。

クエリ プランナーによってインデックスが選択された場合、explain の結果には IXSCAN ステージが加わります。このステージでは、インデックス キーのパターン、トラバースの方向、インデックスの限界などの情報が提供されます。

MongoDB 5.3 以降では、クエリ プランナーでクラスター化されたコレクションにクラスター化されたインデックスが選択され、かつ検索するインデックス部分を定義する限界がクエリに含まれている場合、explain の結果には CLUSTERED_IXSCAN ステージが加わります。このステージでは、クラスター化されたインデックスキーとインデックスの限界に関する情報が提供されます。

クエリ プランナーによってクラスター化されたコレクションにクラスター化されたインデックスが選択され、かつクエリに限界が含まれていない場合、クエリでは、限界抜きでコレクションのスキャンが実行され、explain の結果には COLLSCAN ステージが加わります。

注意

限界が設定されていないクエリで、クラスター化インデックスを使用するものは、コレクションのフル スキャンが必要なため、notablescan パラメーターでは許可されません。

コレクションスキャンの実行統計の詳細については、Explain プラン 結果の解釈を参照してください。

インデックスがクエリをカバーする場合、MongoDB ではクエリの条件を一致させること、およびインデックスキーのみを使用して結果を返すこともできます。MongoDBでは、クエリの一部を実行するためにコレクションのドキュメントを検査する必要はありません。

インデックスがクエリを補う場合、explain の結果には FETCH ステージの子孫ではない、IXSCAN ステージがあり、executionStats では explain.executionStats.totalDocsExamined は 0 です。

MongoDB が $or 式にインデックスを使用する場合、結果にはインデックスの詳細を示す explain.queryPlanner.winningPlan.inputStages 配列を含む、OR ステージが含まれます。以下がその例です。

{ stage: 'OR', inputStages: [ { stage: 'IXSCAN', ... }, { stage : 'IXSCAN', ... }, ... ]}

MongoDB の以前のバージョンでは、cursor.explain() インデックスの詳細を示す clauses 配列を返していました。

集計で explain を実行すると、出力には単一のクエリプランツリーではなく、最上位の stages 配列が含まれます。配列の最初の要素は通常 $cursor であり、これにはパイプラインのデータアクセス部分が含まれます。$cursor エントリには、find explain 出力が返すのと同じ queryPlanner および executionStats オブジェクトが保持されます。$cursor に続くエントリは、集計フレームワークで実行されます。

stages 配列は、パイプラインのステージと一致しないことがよくあります。最適化中、MongoDBはパイプライン作業の一部をクエリシステムに移動します。クエリシステムはインデックスを使用して、その作業をより効率的に完了できます。例、MongoDBは次の最適化を実行できます。

  • 先行する $match、$sort、および $limit ステージは $cursor に吸収されます。吸収された $match はクエリプランでは filter として表示され、吸収された $limit は LIMIT ステージとして表示されます。

  • $group と $lookup は、GROUP ステージおよび EQ_LOOKUP ステージとしてクエリプランにプッシュできます。さらに学ぶには、$group の最適化 および $lookup の最適化。 を参照してください。

  • インデックスが要求されたソート順序を提供する場合、個別の $sort エントリは表示されません。

  • $project また、MongoDBのバージョンや使用するクエリエンジンによっては、他のステージもクエリプランにプッシュされる可能性があります。

このリストは網羅的なものではありません。MongoDBがどのステージを吸収またはプッシュダウンするかは、リリースごとに変更される可能性があります。実行前にMongoDBがパイプラインをどのように再形成するかについての一般的な情報については、「集計パイプラインの最適化」を参照してください。

その結果、stages 配列には、実行したパイプラインよりも少ないエントリが含まれる場合があります。サーバーが実行したステージを確認するには、同じ出力内の stages 配列と command.pipeline フィールドを比較します。

クエリシステムがパイプライン内のすべてのステージを実行できる場合、stages 配列は出力に表示されません。代わりに、出力には true に設定された explain.queryPlanner.optimizedPipeline フィールドが含まれ、集計ステージ情報は含まれません。

explain が、executionStats または allPlansExecution 冗長モードのいずれかで実行されると、$sort および $group ステージに追加の出力があります。

ステージ
フィールド
タイプ
説明

totalDataSizeSortedBytesEstimate

long

$sort ステージで処理される推定バイト数。

usedDisk

ブール値

$sortステージでディスクに書込み(write)されたかどうか。

totalOutputDataSizeBytes

long

$group ステージによって出力されるすべてのドキュメントの合計サイズの推定値(バイト単位)。

usedDisk

ブール値

$groupステージでディスクに書込み(write)されたかどうか。

spillFileSizeBytes

long

$group ステージでディスクに書込まれたスピル ファイルのサイズ。圧縮のため、spillFileSizeBytes の値は numBytesSpilledEstimate 以下である必要があります。

numBytesSpilledEstimate

long

圧縮前の $group ステージでディスクに書込まれるバイト数の推定値です。

MongoDB がインデックスつまたは複数のインデックスを使用してソート順序を取得できない場合、結果には メモリ内ソート操作 を示す SORT ステージが含まれます。explain プランに明示的な SORT ステージが含まれていない場合、 MongoDB はインデックスを使用して並べ替え順を取得しました。

集計のexplain出力では、インメモリソートはクエリプランの SORT ステージではなく、トップレベルの stages 配列の $sort エントリとして表示される場合があります。クエリプランに SORT ステージが含まれていない場合でも、パイプラインはインメモリソートを実行できます。詳細を学ぶには、「集計のexplain出力」を参照してください。

MongoDB 8.0 以降、explain は次のフィールドを出力します。

explain.queryShapeHash

クエリシェイプのハッシュを表す16進数文字列です。詳細については、「クエリーシェイプ」を参照してください。

バージョン8.0の新機能。