planCacheListFilters
定義
planCacheListFilters
コレクションの プランキャッシュクエリシェイプ に関連付けられている インデックスフィルター を一覧表示します。
次の値を返します。 インデックス フィルターを一覧表示するドキュメント。 詳しくは出力を参照してください。
クエリ設定
MongoDB 8.0以降では、インデックス フィルターを追加する 代わりに、 クエリ設定を使用します 。 インデックス フィルターは MongoDB 8.0以降非推奨です。
クエリ設定は、インデックス フィルターよりも多くの機能を持ちます。 また、インデックス フィルターは永続的ではなく、すべてのクラスター ノードに対してインデックス フィルターを簡単に作成することはできません。 クエリ設定を追加して例を探すには、 setQuerySettings
を参照してください。
互換性
このコマンドは、次の環境でホストされている配置で使用できます。
MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです
重要
このコマンドは、M0 、M2 、M5 、および Flex クラスターではサポートされていません。詳細については、「 サポートされていないコマンド 」を参照してください。
MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン
構文
このコマンドの構文は、次のとおりです。
db.runCommand( { planCacheListFilters: <collection> } )
コマンドフィールド
コマンドには次のフィールドがあります:
フィールド | タイプ | 説明 |
---|---|---|
| string | コレクションの名前。 |
| any | 任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。
コメントには、有効な BSON 型(string, integer, object, array など)を使用できます。 |
必要なアクセス権
ユーザーには、 planCacheIndexFilter
アクションを含むアクセス権が必要です。
出力
planCacheListFilters
コマンドは、次の形式のドキュメントを返します。
{ "filters" : [ { "query" : <query> "sort" : <sort>, "projection" : <projection>, "collation" : <collation>, "indexes" : [ <index1>, ... ] }, ... ], "ok" : 1 }
planCacheListFilters.filters
インデックス フィルター情報を含むドキュメントの配列。
各ドキュメントには、次のフィールドが含まれています。
planCacheListFilters.filters.query
このフィルターに関連付けられたクエリ述語。
query
にはインデックス フィルターの作成に使用される特定の値が表示されていますが、述語の値は重要ではありません。クエリ述語は、値のみが異なる類似のクエリをカバーします。たとえば、
{ "type": "electronics", "status" : "A" }
のquery
述語は次のクエリ述語をカバーします。{ type: "food", status: "A" } { type: "utensil", status: "D" }
planCacheListFilters.filters.collation
このフィルターに関連付けられている照合。 空のドキュメントを指定できます。
planCacheListFilters.filters.indexes
プランキャッシュクエリシェイプのインデックスの配列。
プランキャッシュのクエリシェイプは、次のフィールドの組み合わせです。
最適なクエリプランを選択するために、クエリオプティマイザは
indexes
とコレクションスキャンを評価します。