explain（データベースコマンド）

定義

explain

explainコマンドは、次のコマンドの実行に関する情報を提供します:aggregate 、count 、 、distinct find、findAndModify 、delete 、mapReduce 、update

Tip

mongoshでは、このコマンドはdb.collection.explain() およびcursor.explain() ヘルパーメソッドを通じても実行できます。

ヘルパー メソッドはmongosh ユーザーには便利ですが、データベースコマンドと同じレベルの情報は返されない可能性があります。便宜上必要ない場合、または追加の戻りフィールドが必要な場合は、データベースコマンド を使用します。

注意

explainを使用すると、既存のすべてのプラン キャッシュ エントリが無視され、MongoDB クエリ プランナーが新しいプラン キャッシュ エントリを作成できなくなります。

互換性

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

• MongoDB Atlas はクラウドでの MongoDB 配置のための完全管理サービスです

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

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

必要なアクセス権

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

構文

このコマンドの構文は、次のとおりです。

db.runCommand(
   {
     explain: <command>,
     verbosity: <string>,
     comment: <any>
   }
)

コマンドフィールド

このコマンドは、次のフィールドを使用します。

動作

出力

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 の結果を参照してください。

例

db.runCommand(
   {
     explain: { count: "products", query: { quantity: { $gt: 50 } } },
     verbosity: "queryPlanner"
   }
)

db.runCommand(
   {
      explain: { count: "products", query: { quantity: { $gt: 50 } } },
      verbosity: "executionStats"
   }
)

db.runCommand(
   {
     explain: {
        update: "products",
        updates: [
           {
               q: { quantity: 1057, category: "apparel" },
               u: { $set: { reorder: true } }
           }
        ]
     }
   }
)