`$searchMeta`

項目一覧

構文

フィールド
動作
メタデータ結果のタイプ
例
トラブルシューティング

$searchMeta

$searchMetaステージでは、さまざまなタイプのメタデータ結果ドキュメントが返されます。

注意

シャーディングされたコレクションに対して$searchMetaクエリを実行するには、クラスターで MongoDB v 6.0以降を実行する必要があります。

構文

$searchMetaパイプラインステージには次のプロトタイプ形式があります。

{
  $searchMeta: {
    "index": "<index-name>",
    "<collector-name>"|"<operator-name>": {
      <collector-specification>|<operator-specification>
    },
    "count": {
      <count-options>
    }
  }
}

フィールド

$searchMetaステージは、次のフィールドを持つドキュメントを取得します。

フィールド	タイプ	必要性	説明
`<collector-name>`	オブジェクト	条件付き	クエリで使用するコレクターの名前。このフィールドの値として、コレクター固有のオプションを含むドキュメントを提供できます。定義されたファセット名と、そのファセットのバケットの配列とのマッピングを検索するには、値が`facet`である必要があります。詳細については、「ファセット」を参照してください。これを指定するか、 `<operator-name>`を指定する必要があります。
`count`	オブジェクト	任意	結果のカウントを取得するためのカウントオプションを指定するドキュメント。詳しくは、「 Atlas Search結果のカウント」を参照してください。
`index`	string	任意	使用する Atlas Search インデックスの名前。省略した場合、デフォルトは`default`になります。インデックス名のスペルをうっかり間違えた場合、または指定されたインデックスがクラスターにまだ存在しない場合は、Atlas Search では結果が返されません。
`<operator-name>`	オブジェクト	条件付き	Name of the operator to search with. You can provide a document that contains the operator-specific options as the value for this field. You must specify this or `<collector-name>`. `$searchMeta` returns the default `count` metadata only.

動作

$searchMetaステージは、すべてのパイプラインの最初のステージである必要があります。

メタデータ結果のタイプ

$searchMetaステージによって返されるメタデータ結果ドキュメントの構造は、結果のタイプによって異なります。 Atlas Search は次の結果のタイプをサポートしています。

タイプ	結果構造
`count`	結果に含まれるカウント結果は、結果として返されるカウントが検索結果の合計数であるか、下限値であるかを示します。詳細については、「結果のカウント」を参照してください。
`facet`	ファセットクエリの結果は、定義されたファセット名を、そのファセットのバケットの配列にマッピングしたものです。詳細については、「ファセット結果」を参照してください。

例

sample_mflix.moviesコレクションに次のインデックスがあるとします。

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "year": {
        "type": "number"
      }
    }
  }
}

次のクエリは、 $searchMetaステージを使用して、 1998で公開された映画の数を検索します。

db.movies.aggregate([
  {
    "$searchMeta": {
      "range": {
        "path": "year",
        "gte": 1998,
        "lt": 1999
      },
      "count": {
        "type": "total"
      }
    }
  }
])

[ { count: { total: Long("552") } } ]

トラブルシューティング

Atlas Search $searchクエリで問題が発生している場合は、Atlas Search エラーのトラブルシューティングを参照してください。

戻る

$search

2. 演算子とコレクターの使用