$match（集計ステージ）

定義

$match: 指定されたクエリ述語に基づいてドキュメントをフィルタリングします。一致したドキュメントは、次のパイプラインステージに渡されます。

互換性

次の環境でホストされる配置には $match を使用できます。

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

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

構文

{ $match: { <query predicate> } }

クエリ述語の構文は、$match コマンドのクエリ find()引数で使用される構文と同じです。

動作

パイプラインの最適化

$matchを集計パイプラインのできるだけ早く配置します。 $matchは集計パイプライン内のドキュメントの合計数を制限するため、以前の$match操作はパイプを下降する処理量を最小限に抑えます。
パイプラインの先頭に $match を配置すると、クエリは他の db.collection.find() や db.collection.findOne() と同様にインデックスを利用できます。

クエリ述語の式

クエリ述語に式を含めるには、 $expr演算子を使用します。

0 、NULL、false、または欠損値

次のいずれかの条件に当てはまる場合、$match ステージはパイプラインの結果からドキュメントをフィルタリングで除外します。

$match クエリ述語は、そのドキュメントの 0 、 null 、または false の値を返します。
$matchクエリ述語は、そのドキュメントには欠落しているフィールドを使用します。

制限事項

$matchステージでは$whereは使用できません。
$matchステージでは$nearまたは$nearSphereは使用できません。あるいは、次のいずれかを実行できます。
- $geoNearステージではなく$match ステージを使用します。
- $matchステージで$centerまたは$centerSphereとともに$geoWithinクエリ述語演算子を使用します。
$text$matchステージでを使用するには、$match ステージがパイプラインの最初のステージである必要があります。

ビューは$textをサポートしていません。

注意
$text は、自己管理型（Atlas 以外）配置に対するテキストクエリ機能を提供します。MongoDB Atlas でホストされているデータに対して、MongoDB は改良された全文クエリソリューションである Atlas Search を提供します。

Atlas Search を使用した Atlas のデータのフィルタリング

MongoDB Atlas に保存されているデータでは、Atlas Search 複合演算子filterオプションを使用して、$search クエリを実行中にドキュメントを一致させるか、フィルタリングできます。$matchを$search の後に実行するのは、$search を複合演算子filterオプションとともに実行する場合よりもパフォーマンスが低くなります。

filter オプションの詳細については、Atlas ドキュメントの「複合演算子」を参照してください。

例

このページの例では、sample_mflix データセットのデータを使用しています。自己管理型 MongoDB 配置にこのデータセットをロードする方法の詳細については、「サンプルデータセットのロード」を参照してください。サンプルデータベースに何らかの変更を加えた場合は、今ページの例を実行するには、データベースを削除して再作成する必要がある可能性があります。

等価一致

次の操作では、$match を使用して ratedフィールドで等価一致を実行します。runtime フィルターは、結果を小さく表現されたセットに制限します。

db.movies.aggregate(    [ { $match : { rated : "TV-PG", runtime : { $gt: 1000 } } } ])

The $match selects the documents where the ratedフィールドが"TV-PG" に等しく、かつ runtime が 1000 より大きいdocumentを選択します。

カウントの実行

次の例では、 $matchパイプライン演算子を使用して処理するドキュメントを選択し、その結果を$groupパイプライン演算子にパイプしてドキュメントの数を計算します。

db.movies.aggregate( [  { $match: { $or: [      { runtime: { $gt: 1000 } },      { year: { $lt: 1910 } }  ] } },  { $group: { _id: null, count: { $sum: 1 } } }] )

[ { _id: null, count: 6 } ]

集計パイプラインで、$match は、runtime が 1000 より大きいか、year が 1910 より前のdocumentを選択します。これらのドキュメントは、カウントを実行するために $group に送信されます。

配列要素の一致

配列フィールド内の要素に基づいてdocumentをフィルタリングするには、$match ステージのクエリ述語で $elemMatch 演算子を使用します。

db.aggregate( [   {      $documents: [         { student_id: 1, scores: [ 0.75, 0.65, 0.73 ] },         { student_id: 2, scores: [ 0.9, 0.88, 0.98 ] },         { student_id: 3, scores: [ 0.9, 0.84, 0.93 ] }      ]   }, {      $match: {         scores: { $elemMatch: { $gte: 0.9 } }      }   }] )

[  { student_id: 2, scores: [ 0.9, 0.88, 0.98 ] },  { student_id: 3, scores: [ 0.9, 0.84, 0.93 ] }]

このページのC#の例では、Atlasサンプルデータセットの sample_mflixデータベースを使用します。MongoDB Atlasクラスターを無料で作成して、サンプルデータセットをロードする方法については、 MongoDB .NET/ C#ドライバーのドキュメントの「開始」を参照してください。

次の Movie クラスは、sample_mflix.movies コレクション内のドキュメントをモデル化します。

[BsonIgnoreExtraElements]public class Movie{    [BsonId]    public ObjectId Id { get; set; }    [BsonElement("title")]    public string Title { get; set; } = null!;    [BsonElement("year")]    public int? Year { get; set; }    [BsonElement("runtime")]    public int? Runtime { get; set; }    [BsonElement("rated")]    public string? Rated { get; set; }    [BsonElement("metacritic")]    public int Metacritic { get; set; }    [BsonElement("plot")]    public string? Plot { get; set; }    [BsonElement("type")]    public string? Type { get; set; }    [BsonElement("cast")]    public string[]? Cast { get; set; }    [BsonElement("directors")]    public string[]? Directors { get; set; }    [BsonElement("writers")]    public string[]? Writers { get; set; }    [BsonElement("imdb")]    public ImdbData? Imdb { get; set; }}

MongoDB .NET/ C#ドライバーを使用して$match ステージを集計パイプラインに追加するには、 PipelineDefinitionオブジェクトで UnionWith() メソッドを呼び出します。

次の例では、Titleフィールドが "The Godfather" に等しいすべての Movie ドキュメントに一致するパイプラインステージを作成します。

var pipeline = new EmptyPipelineDefinition<Movie>()    .Match(m => m.Title == "The Godfather");

{ "_id" : "...", "title" : "The Godfather", "metacritic" : 100, "rated" : "R", "runtime" : 175, "imdb" : "..." }

このページのNode.js の例では、Atlasサンプルデータセットの sample_mflixデータベースを使用します。無料のMongoDB Atlas cluster を作成し、サンプルデータセットをロードする方法については、 MongoDB Node.jsドライバーのドキュメントの開始を参照してください。

MongoDB Node.jsドライバーを使用して $match ステージを集計パイプラインに追加するには、パイプラインオブジェクトで $match 演算子を使用します。

次の例では、title フィールドが "The Shawshank Redemption" に等しいすべての movie ドキュメントに一致するパイプラインステージを作成します。次に、この例は集計パイプラインを実行します。

const pipeline = [  {    $match: {      title: "The Shawshank Redemption"    }  }];
const cursor = collection.aggregate(pipeline);return cursor;

詳細

集計に関する詳細情報とユースケースについては、完全な集計パイプラインチュートリアルを参照してください。

戻る

$lookup

$merge