cursor.explain()

定義

cursor.explain(verbosity)

重要

mongosh メソッド

これはmongoshメソッドです。 これは、 Node.jsまたはその他のプログラミング言語固有のドライバー メソッドのドキュメントではありません。

ほとんどの場合、 mongoshメソッドはレガシーの mongo shell メソッドと同じように動作します。 ただし、一部のレガシー メソッドはmongoshでは利用できません。

レガシーmongo shell のドキュメントについては、対応する MongoDB Server リリースのドキュメントを参照してください。

• mongo shell v4.4

• mongo shell v4.2

• mongo shell v4.0

MongoDB API ドライバーについては、各言語のMongoDB ドライバードキュメント を参照してください。

db.collection.find()メソッドのクエリプランに関する情報を提供します。

explain()メソッドの形式は次のとおりです。

db.collection.find().explain()

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

Parameter	必要性	タイプ	説明
verbose	任意	文字列	explain の出力に含める情報の量を決定します。 使用可能な冗長モードは次のとおりです。 allPlansExecution executionStats queryPlanner （デフォルト） 以前のバージョンの explain() との下位互換性のため、 MongoDB はtrue を allPlansExecution として、false を queryPlanner として解釈します。 このモードについて詳しくは、「 冗長モード 」を参照してください。

explain()メソッドは、クエリプランと、オプションで実行統計を含むドキュメントを返します。

互換性

このメソッドは、次の環境でホストされている配置で使用できます。

• MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

動作

出力

cursor.explain() 操作は、次の情報を返す場合があります。

• explainVersion、出力形式のバージョン（例: "1" ）

• command、説明されているコマンドの詳細が表示されます。

• queryPlannerは、クエリオプティマイザによって選択されたプランの詳細を示し、拒否されたプランを一覧で表示します。

• executionStats、当選したプランと拒否されたプランの実行の詳細が表示されます

• serverInfo、MongoDB インスタンスに関する情報を提供しますおよび

• serverParameters内部パラメータの詳細が表示されます。

冗長モード（つまり、queryPlanner 、 executionStats 、 allPlansExecution）は、結果にexecutionStatsが含まれるかどうか、およびexecutionStatsにプラン選択中にキャプチャされたデータが含まれるかどうかを決定します。

出力の詳細については explain の結果を参照してください。

例

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

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