AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu

planCacheListFilters(データベースコマンド)

planCacheListFilters

コレクションの プランキャッシュクエリシェイプ に関連付けられている インデックスフィルター を一覧表示します。

次の値を返します。

インデックス フィルターを一覧表示するドキュメント。 「出力 」を参照してください。

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

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

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

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

重要

このコマンドは、M0 および Flex クラスターではサポートされていません。詳細については、サポートされていないコマンド を参照してください。

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

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

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

db.runCommand(
{
planCacheListFilters: <collection>
}
)

コマンドには次のフィールドがあります:

フィールド
タイプ
説明

planCacheListFilters

string

コレクションの名前。

comment

any

任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。

コメントには、有効な BSON 型(string, integer, object, array など)を使用できます。

ユーザーには、 planCacheIndexFilterアクションを含むアクセス権が必要です。

The planCacheListFilters command returns the document with the following form:

{
"filters" : [
{
"query" : <query>
"sort" : <sort>,
"projection" : <projection>,
"collation" : <collation>,
"indexes" : [
<index1>,
...
]
},
...
],
"ok" : 1
}
planCacheListFilters.filters

インデックス フィルター情報を含むドキュメントの配列。

各ドキュメントには、次のフィールドが含まれています。

planCacheListFilters.filters.query

The query predicate associated with this filter. Although the query shows the specific values used to create the index filter, the values in the predicate are insignificant; i.e. query predicates cover similar queries that differ only in the values.

For instance, a query predicate of { "type": "electronics", "status" : "A" } covers the following query predicates:

{ type: "food", status: "A" }
{ type: "utensil", status: "D" }
planCacheListFilters.filters.sort

このフィルターに関連付けられているソート。 空のドキュメントを指定できます。

planCacheListFilters.filters.projection

このフィルターに関連付けられたプロジェクション。 空のドキュメントを指定できます。

planCacheListFilters.filters.collation

このフィルターに関連付けられている照合。 空のドキュメントを指定できます。

planCacheListFilters.filters.indexes

プランキャッシュクエリシェイプのインデックスの配列。

プランキャッシュのクエリシェイプは、次のフィールドの組み合わせです。

To choose the best query plan, the query optimizer evaluates the indexes and the collection scan.

planCacheListFilters.ok

コマンドのステータスです。