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

定義

db.collection.getPlanCache()

This page documents a mongosh method. This is not the documentation for a language-specific driver, such as Node.js.

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

コレクションのクエリプランキャッシュにアクセスするためのインターフェースを返します。インターフェースには、クエリプランキャッシュを表示およびクリアするメソッドが用意されています。

次の値を返します。	クエリプランキャッシュにアクセスするためのインターフェース。

クエリオプティマイザは、実行可能なプランが複数ある可能性のあるプランキャッシュクエリシェイプのプランのみをキャッシュします。

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

MongoDB 8.0以降では、インデックスフィルターを追加する代わりに、クエリ設定を使用します。インデックスフィルターは MongoDB 8.0以降非推奨です。

クエリ設定は、インデックスフィルターよりも多くの機能を持ちます。また、インデックスフィルターは永続的ではなく、すべてのクラスターノードに対してインデックスフィルターを簡単に作成することはできません。クエリ設定を追加して例を探すには、 setQuerySettingsを参照してください。

インターフェースを通じて次のメソッドが利用できます。

名前	説明
`PlanCache.help()`	コレクションのクエリプランキャッシュに使用できるメソッドを表示します。特定のコレクションのプランキャッシュオブジェクト（`db.collection.getPlanCache().help()`）を通じてアクセスできます。
`PlanCache.clearPlansByQuery()`	指定されたプランキャッシュクエリシェイプのキャッシュされたクエリプランをクリアします。特定のコレクションのプランキャッシュオブジェクト（`db.collection.getPlanCache().clearPlansByQuery()`）を通じてアクセスできます。
`PlanCache.clear()`	コレクションのすべてのキャッシュされたクエリプランをクリアします。特定のコレクションのプランキャッシュオブジェクト（`db.collection.getPlanCache().clear()`）を通じてアクセスできます。
`PlanCache.list()`	コレクションのプランキャッシュ情報を返します。特定のコレクションのプランキャッシュオブジェクト（`db.collection.getPlanCache().list()`）を通じてアクセスできます。