PlanCache.clientPlansByQuery()（mongoshメソッド）

定義

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

指定されたプランキャッシュクエリシェイプのキャッシュされたクエリプランをクリアします。

重要

mongosh メソッド

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

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

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

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

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

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

Parameter

タイプ

説明

query

ドキュメント

プランキャッシュクエリシェイプのクエリ述語。フィールド名を含む述語の構造のみがシェイプにとって重要です。クエリ述部の値は重要ではない。

projection

ドキュメント

任意。プランキャッシュクエリシェイプに関連付けられたプロジェクション。 sortパラメータを指定する場合は必須です。

sort

ドキュメント

任意。プランキャッシュクエリシェイプに関連付けられた並べ替え。

collation

ドキュメント

任意。操作に使用する照合を指定します。

照合を指定すると、大文字・小文字やアクセント記号など、文字列を比較するための言語独自のルールを指定できます。

照合オプションの構文は次のとおりです。

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

照合を指定する場合、locale フィールドは必須ですが、その他の照合フィールドはすべて任意です。フィールドの説明については、照合ドキュメントを参照してください。

照合が指定されていなくても、コレクションにデフォルトの照合が設定されている場合（db.createCollection() を参照）には、コレクションの照合が使用されます。

コレクションにも操作にも照合が指定されていない場合、MongoDB では以前のバージョンで使用されていた単純なバイナリ比較によって文字列が比較されます。

1 つの操作に複数の照合は指定できません。たとえば、フィールドごとに異なる照合を指定できません。また、ソートと検索を一度に実行する場合、検索とソートで別の照合を使用できません。

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

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

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

互換性

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

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

MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

必要なアクセス権

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

例

コレクションordersに次のプランキャッシュクエリシェイプがある場合:

{
  "query" : { "qty" : { "$gt" : 10 } },
  "sort" : { "ord_date" : 1 },
  "collation" : { locale : "fr" },
  "projection" : { },
  "planCacheShapeHash" : "9AAD95BE"
}

警告

MongoDB 8.0 以降では、既存の queryHashフィールドはplanCacheShapeHash という名前の新しいフィールドに重複します。以前のバージョンのMongoDBを使用している場合は、queryHashフィールドのみが表示されます。今後のMongoDBバージョンでは、非推奨の queryHashフィールドが排除されます。代わりに planCacheShapeHashフィールドを使用する必要があります。

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

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

Tip

戻る

PlanCache.client

PlanCache.help