cursor.explain()（mongoshメソッド）

定義

cursor.explain(verbosity)

重要

mongosh メソッド

このページでは メソッドについて説明します。これはNode.jsなどの言語固有のドライバーのドキュメントではありませんmongosh 。

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 のバージョン

必要なアクセス権

explain を使用するには、基礎のコマンドを実行する権限が必要です。

動作

出力

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

• explainVersion、出力形式のバージョン（"1" など）。

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

• queryShapeHash は、MongoDB 8.0 以降、クエリシェイプのハッシュを持つ 16 進数文字列です。詳細については、「クエリシェイプ」「クエリシェイプハッシュ」および explain.queryShapeHash を参照してください。

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

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

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

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

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

Explain の出力は、 BSON ドキュメントの最大ネスト深度（100 レベルのネスト）によって制限されます。制限を超える出力は切り捨てられます。

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

例

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

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