explain の結果

queryPlanner

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

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

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>,
   ]
}

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

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 を使用している場合は、 planCacheShapeHashではなくqueryHashが表示されます。

プランキャッシュクエリシェイプのハッシュを表す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 クエリの最適化に費やされた時間は含まれません。

バージョン8.0の新機能。

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フィールドには、勝利プランを選択するために使用されたクエリの部分のみが含まれます。

executionStats

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

• executionStats

• allPlansExecution の冗長モードです。プラン選択中にキャプチャされた部分的な実行データを含めるには、allPlansExecution モードを使用します。

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

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>,
         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>
   }
}

executionStats: {
   nReturned: <int>,
   executionTimeMillis: <int>,
   totalKeysExamined: <int>,
   totalDocsExamined: <int>,
   executionStages: {
      stage: <STAGE1>
      nReturned: <int>,
      executionTimeMillis: <int>,
      opens: <int>, // Starting in MongoDB 5.1
      closes: <int>, // Starting in MongoDB 5.1
      totalKeysExamined: <int>,
      totalDocsExamined: <int>,
      totalChildMillis: <NumberLong>,
      shards: [
         {
            shardName: <string>,
            executionSuccess: <boolean>,
            executionStages: {
               stage: <STAGE2>,
               nReturned: <int>,
               executionTimeMillisEstimate: <int>,
               ...
               chunkSkips: <int>,
               inputStage: {
                  stage: <STAGE3>,
                  ...
                  numReads: <int>, // Starting in MongoDB 5.1
                  ...
                  inputStage: {
                     ...
                  }
               }
            }
         },
         ...
      ]
   }
   allPlansExecution: [
      {
         shardName: <string>,
         allPlans: [
            {
               nReturned: <int>,
               executionTimeMillisEstimate: <int>,
               totalKeysExamined: <int>,
               totalDocsExamined:<int>,
               executionStages: {
                  stage: <STAGEA>,
                  nReturned: <int>,
                  executionTimeMillisEstimate: <int>,
                  ...
                  inputStage: {
                     stage: <STAGEB>,
                     ...
                     inputStage: {
                       ...
                     }
                  }
               }
            },
            ...
         ]
      },
      {
         shardName: <string>,
         allPlans: [
          ...
         ]
      },
      ...
   ]
}

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 が有効な場合のみです。

serverInfo

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

queryPlanner: {
   ...
   winningPlan: {
      stage: <STAGE1>,
      shards: [
         {
            shardName: <string>,
            connectionString: <string>,
            serverInfo: {
               host: <string>,
               port: <int>,
               version: <string>,
               gitVersion: <string>
            },
            ...
         }
         ...
      ]
   }
 },
 serverInfo: {      // serverInfo for mongos
   host: <string>,
   port: <int>,
   version: <string>,
   gitVersion: <string>
 }
 ...