db.collection.explain()

冗長モード

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

Explain 操作と Write 操作

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

制限事項

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

• 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()構造により、クエリ修飾子の追加の連鎖が可能になります。 Fクエリ修飾子のリストについては、 db.collection.explain().find().help() を参照してください。

• db.collection.find().explain() はカーソルを返します。このカーソルにが explain() の結果を返すには、.next() またはそのエイリアス .finish() を呼び出す必要があります。mongosh で対話的に実行すると、mongosh により .finish() が自動的に呼び出され、結果を返します。ただし、スクリプトの場合、結果を返すためには .next() または .finish() を明示的に呼び出す必要があります。カーソル関連のメソッドのリストについては、db.collection.explain().find().help(). を参照してください。

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()を修飾子で説明する」を参照してください。

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()は、指定された 操作に対して検討されたすべてのプランのqueryPlannerexecutionStats findAndModify()と を返します。

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()

explain().find()リターンカーソルの反復処理

db.collection.explain().find()は explain の結果へのカーソルを返します。 mongoshで対話的に実行すると、 mongoshは.next()メソッドを使用してカーソルを自動的に反復します。 ただし、スクリプトの場合、結果を返すには.next() （またはそのエイリアス.finish() ）を明示的に呼び出す必要があります。

var explainResult = db.products.explain().find( { category: "apparel" } ).next();