planCacheListFilters

定義

planCacheListFilters

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

次の値を返します。	インデックス フィルターを一覧表示するドキュメント。 詳しくは出力を参照してください。

互換性

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

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

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

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

構文

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

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

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

必要なアクセス権

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

出力

planCacheListFiltersコマンドは、次の形式のドキュメントを返します。

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

planCacheListFilters.filters

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

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

planCacheListFilters.filters.query

このフィルターに関連付けられたクエリ述語。 queryにはインデックス フィルターの作成に使用される特定の値が表示されていますが、述語の値は重要ではありません。クエリ述語は、値のみが異なる類似のクエリをカバーします。

たとえば、 { "type": "electronics", "status" : "A" }のquery述語は次のクエリ述語をカバーします。

{ type: "food", status: "A" }
{ type: "utensil", status: "D" }

sortおよびprojectionとともに、 queryは、指定されたインデックス フィルターのクエリシェイプを構成します。

planCacheListFilters.filters.sort

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

queryおよびprojectionとともに、 sortは、指定されたインデックス フィルターのクエリシェイプを構成します。

planCacheListFilters.filters.projection

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

queryおよびsortとともに、 projectionは、指定されたインデックス フィルターのクエリシェイプを構成します。

planCacheListFilters.filters.indexes

このクエリシェイプのインデックスの配列。 最適なクエリプランを選択するために、クエリオプティマイザはリストされたindexesとコレクションスキャンのみを評価します。

planCacheListFilters.ok

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