db. コレクション.explain()（mongoshメソッド）

パラメーター

db.collection.explain()メソッドには次のパラメーターがあります。

冗長モード

db.collection.explain()の動作と返される情報の量は、verbosity モードによって異なります。

Explain 操作と Write 操作

書込み（write）操作の場合、db.collection.explain() は実行される書込み（write）操作に関する情報を返しますが、実際にはデータベースを変更しません。

制限事項

ステージを含む では、aggregation pipeline $outexplainモードまたはdb.collection.explain() executionStatsallPlansExecutionモードで コマンド/ を実行できません。代わりに、次のいずれかを実行できます。

• queryPlanner モードで explain を実行するか、

• executionStats モード、または allPlansExecution モードで、$out ステージなしでexplain を実行すると、$out ステージに先行するステージの情報が返されます。

explain() Mechanics

メソッドはdb.collection.explain() explainコマンドをラップし、explain を実行するための推奨方法です。

db.collection.explain().find()はdb.collection.find().explain() と似ていますが、次の重要な違いがあります。

• db.collection.explain().find()構造により、クエリ修飾子の追加の連鎖が可能になります。クエリ修飾子のリストについては、 db を参照してください。 コレクション.explain().find().help()

• db.collection.find().explain()explain()は、クエリプランに関する 情報を返します。

db.collection.explain().aggregate()は explain db.collection.aggregate()オプションを メソッドに渡すことと同じです。

help()

db.collection.explain()でサポートされている操作のリストを表示するには、次のコマンドを実行します。

db.collection.explain().help()

db.collection.explain().find()はカーソルを返します。これにより、クエリ修飾子の連鎖が可能になります。 でサポートされているクエリ修飾子とカーソル関連のメソッドのリストを表示するには、次のコマンドを実行します。db.collection.explain().find()

db.collection.explain().find().help()

には複数の修飾子を連鎖させることができます。例については、「 を修飾子で説明するdb.collection.explain().find() find()」を参照してください。

シャーディングされたクラスター

シャーディングされたクラスターに存在しないデータベースに対して db.collection.explain() を実行すると、実行ステージはストリームの終端に達し、操作データベースは作成されません。ストリームの終端の実行統計の詳細については、explain.executionStats.executionStages.isEOF を参照してください。

queryPlanner モード

デフォルトでは 、db.collection.explain() は 冗長モードで実行されます。"queryPlanner"

db.collection.explain()次の例では、"queryPlanner" をcount() 冗長モードで実行し、指定された 操作のクエリ計画情報を返します。

db.products.explain().count( { quantity: { $gt: 50 } } )

executionStats モード

db.collection.explain()次の例では、"executionStats" をfind() 冗長モードで実行し、指定された 操作のクエリ計画と実行情報を返します。

db.products.explain("executionStats").find(
   { quantity: { $gt: 50 }, category: "apparel" }
)

allPlansExecution モード

db.collection.explain()次の例では、"allPlansExecution" 冗長モードで を実行しています。db.collection.explain() は、指定されたqueryPlanner 操作のすべての検討済みプランのexecutionStatsfindAndModify() と を返します。

db.products.explain( "allPlansExecution" ).findAndModify( {
   query: { name: "Tom", state: "active", rating: { $gt: 10 } },
   sort: { rating: 1 },
   update: { $inc: { score: 1 } }
} )

修飾語 を使って find() を説明する

db.collection.explain().find()構造により、クエリ修飾子の連鎖が可能になります。例、次の操作では、find() sort()クエリ修飾子とhint() クエリ修飾子を持つ メソッドに関する情報が提供されます。

db.products.explain("executionStats").find(
   { quantity: { $gt: 50 }, category: "apparel" }
).sort( { quantity: -1 } ).hint( { category: 1, quantity: -1 } )

使用可能なクエリ修飾子のリストについては、mongosh で以下を実行します。

db.collection.explain().find().help()

finish() メソッドで explain() の結果にアクセスする

はdb.collection.explain().find() explain()の結果を返します。 で対話的に実行する場合は、 メソッドを使用してクエリプランにアクセスできます。mongosh.finish()

db.products.explain().find( { category: "apparel" } ).finish().queryPlanner.winningPlan;