PlanCache.clientPlansByQuery()

項目一覧

定義

PlanCache.clearPlansByQuery( <query>, <projection>, <sort> )

このページでは、mongosh メソッドについて説明します。ただし、データベースコマンドや Node.js などの言語固有のドライバーのドキュメントには該当しません。

データベースコマンドについては、planCacheClear コマンドを参照してください。

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

メソッドは、特定のコレクションのplan cache objectからのみ使用できます。すなわち

db.collection.getPlanCache().clearPlansByQuery( <query>, <projection>, <sort> )

PlanCache.clearPlansByQuery()メソッドは次のパラメータを受け入れます。

Parameter	タイプ	説明
`query`	ドキュメント	クエリシェイプのクエリ述語。フィールド名を含む述語の構造のみがシェイプにとって重要です。クエリ述部の値は重要ではない。
`projection`	ドキュメント	任意。クエリシェイプに関連付けられたプロジェクション。 `sort`パラメータを指定する場合は必須です。
`sort`	ドキュメント	任意。クエリシェイプに関連付けられた並べ替え。

キャッシュされたクエリプランが存在するクエリシェイプを確認するには、「クエリシェイプを一覧表示する」を参照してください。

authorizationで実行されているシステムでは、ユーザーにplanCacheWriteアクションを含むアクセス権が必要です。

コレクションordersが次のクエリシェイプを持つ場合:

{
  "query" : { "qty" : { "$gt" : 10 } },
  "sort" : { "ord_date" : 1 },
  "projection" : { },
  "queryHash" : "9AAD95BE"
}

次の操作により、シェイプに対してキャッシュされたクエリプランが削除されます。

db.orders.getPlanCache().clearPlansByQuery(
   { "qty" : { "$gt" : 10 } },
   { },
   { "ord_date" : 1 }
)

戻る

PlanCache.client

PlanCache.help