集計ステージ

$addFields

ドキュメントに新しいフィールドを追加します。$projectと同様に、 $addFieldsストリーム内の各ドキュメントを再形成します。具体的には、入力ドキュメントの既存のフィールドと新しく追加されたフィールドの両方を含む出力ドキュメントに新しいフィールドを追加します。

$setは$addFieldsの別名です。

$bucket

受信ドキュメントを、指定された式とバケット境界に基づいて、バケットと呼ばれるグループに分類します。

$bucketAuto

指定された式に基づいて、受信したドキュメントをバケットと呼ばれる特定の数のグループに分類します。指定された数のバケットにドキュメントを均等に分散するために、バケット境界が自動的に決定されます。

$count

集計パイプラインのこの段階でのドキュメントの数を返します。

$count 集計アキュムレータとは異なります。

$densify

フィールド内の特定の値が欠落しているドキュメントのシーケンス内に新しいドキュメントを作成します。

$documents

入力式からリテラル ドキュメントを返します。

$facet

同じ入力ドキュメントセット上の単一ステージ内の複数の集計パイプラインを処理します。複数のディメンションまたはファセットにわたるデータを1つの段階で特徴付けることができる多面的な集計を作成できます。

$fill

ドキュメント内のnullと欠落しているフィールド値を入力します。

$geoNear

地理空間点への近接性に基づいて、順序が付けられたドキュメントのストリームを返します。地理空間データ用の $match、$sort、$limit 機能を組み込みます。出力ドキュメントには、追加の距離フィールドが含まれ、ロケーション識別子フィールドを含めることができます。

$graphLookup

コレクションに対して再帰的な検索を実行します。各出力ドキュメントに、そのドキュメントの再帰検索のトラバーサル結果を含む新しい配列フィールドを追加します。

$group

入力ドキュメントを指定された識別子式でグループ化し、アキュムレータ式（指定されている場合）を各グループに適用します。すべての入力ドキュメントを消費し、各グループごとに 1 つのドキュメントを出力します。出力ドキュメントには、ID フィールドと、指定されている場合は累積フィールドのみが含まれます。

$limit

変更されていない最初の n 個のドキュメントをパイプラインに渡します。n は指定された制限です。入力ドキュメントごとに、1 件のドキュメント（最初の n 個のドキュメント）または 0 件のドキュメント（最初の n 個のドキュメントの後）を出力します。

$lookup

同じデータベース内の別のコレクションまたはビューへの左外部結合を実行して 、"join"コレクションまたはビューのドキュメントをフィルタリングして処理します。

$match

ドキュメントストリームをフィルタリングして、一致するドキュメントのみが変更されずに次のパイプラインステージに渡されるようにします。$match標準の MongoDB クエリを使用します。入力ドキュメントごとに、1 件のドキュメント（一致）または 0 件のドキュメント（一致なし）を出力します。

$merge

集約パイプラインの結果ドキュメントをコレクションに書き込みます。ステージは（新しいドキュメントの挿入、ドキュメントのマージ、ドキュメントの置換、既存のドキュメントの保持、操作の失敗、カスタムアップデートパイプラインによるドキュメントの処理）の結果を出力コレクションに組み込むことができます。$mergeステージを使用するには、パイプラインの最後のステージである必要があります。

$out

集約パイプラインの結果ドキュメントをコレクションに書き込みます。$outステージを使用するには、パイプラインの最後のステージである必要があります。

$project

新しいフィールドを追加したり、既存のフィールドを削除したりして、ストリーム内の各ドキュメントを再構築します。入力ドキュメント 1 件ごとに、1つのドキュメントを出力します。

既存のフィールドを削除するには、 $unsetも参照してください。

$redact

ドキュメント自体に保存されている情報に基づいて各ドキュメントのコンテンツを制限することにより、ストリーム内の各ドキュメントを再構築します。$projectと$matchの機能を組み合わせます。フィールド レベルのリダクションを実装するために使用できます。入力ドキュメントごとに、1 件または 0 件のドキュメントを出力します。

$replaceRoot

指定された埋め込みドキュメントでドキュメントを置き換えます。この操作により、_id フィールドを含む入力ドキュメント内の既存のフィールドがすべて置き換えられます。入力ドキュメントに埋め込まれているドキュメントを指定して、埋め込まれたドキュメントをトップレベルにプロモートします。

$replaceWithは$replaceRootステージの別名です。

$replaceWith

指定された埋め込みドキュメントでドキュメントを置き換えます。この操作により、_id フィールドを含む入力ドキュメント内の既存のフィールドがすべて置き換えられます。入力ドキュメントに埋め込まれているドキュメントを指定して、埋め込まれたドキュメントをトップレベルにプロモートします。

$replaceWithは$replaceRootステージの別名です。

$sample

入力から指定した数のドキュメントをランダムに選択します。

$set

ドキュメントに新しいフィールドを追加します。$projectと同様に、 $setストリーム内の各ドキュメントを再形成します。具体的には、入力ドキュメントの既存のフィールドと新しく追加されたフィールドの両方を含む出力ドキュメントに新しいフィールドを追加します。

$setは$addFieldsステージの別名です。

$setWindowFields

ドキュメントをウィンドウにグループ化し、各ウィンドウのドキュメントに 1 つまたは複数のオペレーターを適用します。

$skip

最初の n 個のドキュメント（ n は指定されたスキップ番号）をスキップし、残りのドキュメントは変更されずにパイプラインに渡されます。入力ドキュメントごとに、1 件のドキュメント（最初の n 個のドキュメント）または 0 件のドキュメント（最初の n 個のドキュメントの後）を出力します。

$sort

指定されたソートキーでドキュメント ストリームを並べ替えます。順序のみが変更されます。ドキュメントは変更されません。入力ドキュメント 1 件ごとに、1つのドキュメントを出力します。

$sortByCount

指定された式の値に基づいて受信ドキュメントをグループ化し、個別のグループごとにドキュメントの数を計算します。

$unionWith

2 つのコレクションの和集合を実行します。つまり、2 つのコレクションまたはビューからのパイプラインの結果を 1 つの結果セットに結合します。

$unset

ドキュメントからフィールドを削除または除外します。

$unsetは、フィールドを削除する$projectステージの別名です。

$unwind

入力ドキュメントから配列フィールドを分解して、各要素のドキュメントを出力します。各出力ドキュメントは、配列を要素の値で置き換えます。入力ドキュメントごとに n 個のドキュメントを出力します。n は配列要素の数で、空の配列の場合は 0 になる場合もあります。

$changeStream

コレクションの変更ストリームカーソルを返します。このステージは集計パイプラインで 1 回のみ発生し、第 1 ステージとして実行する必要があります。

$changeStreamSplitLargeEvent

16 MB を超える大きな変更ストリームイベントを、変更ストリーム カーソルで返される小さなフラグメントに分割します。

$changeStreamSplitLargeEvent内の $changeStreamパイプラインでのみ使用でき、パイプラインの最終ステージである必要があります。

$rankFusion

ドキュメントをランク付けする入力パイプラインの結果を組み合わせます。$rankFusion は入力パイプラインの結果の重複を除外し、Reciリスト ランク 統合アルゴリズムを使用して最終ドキュメントランキングを作成します。

$search

コレクション内のフィールドの全文検索を実行します。

To learn more, see MongoDB Search Aggregation Pipeline Stages.

$searchMeta

Returns different types of metadata result documents for the MongoDB Search query against an Atlas collection. To learn more, see MongoDB Search Aggregation Pipeline Stages.

$vectorSearch

Performs an ANN or ENN search on a vector in the specified field of an Atlas collection.

$vectorSearch は、MongoDB v 6.0.11以上を実行している MongoDB Atlas クラスターでのみ使用でき、自己管理型の配置では使用できません。

$collStats

コレクションまたはビューに関する統計情報を返します。

$currentOp

MongoDB 配置のアクティブな操作および休止中の操作に関する情報を返します。

db.aggregate()メソッドの代わりに、db.collection.aggregate() メソッドを使用します。

$indexStats

コレクションの各インデックスの使用に関する統計を返します。

$listClusterCatalog

名前や作成オプションなど、クラスター内のコレクションの情報を取得します。

$listLocalSessions

現在接続されているmongosまたはmongodインスタンスで最近使用されたすべてのアクティブ セッションを一覧表示します。これらのセッションはまだsystem.sessionsコレクションに伝播されていない可能性があります。

db.aggregate()メソッドの代わりに、db.collection.aggregate() メソッドを使用します。

$listSampledQueries

すべてのコレクションまたは特定のコレクションのサンプル クエリを一覧表示します。

$listSearchIndexes

Returns information about existing MongoDB Search indexes on a specified collection or view.

$listSessions

system.sessionsコレクションに伝達されるまで十分な長さにわたってアクティブであったすべてのセッションを一覧表示します。

$planCacheStats

コレクションのプラン キャッシュ情報を返します。

$querySettings

以前に setQuerySettings で追加されたクエリ設定を返します。

$queryStats

記録されたクエリの実行時間統計を返します。

警告： $queryStats 集計ステージはサポートされておらず、将来のリリースで安定することは保証されません。将来のリリースで出力が変更される可能性があるため、このステージの特定の出力形式に依存する機能を構築しないでください。

$shardedDataDistribution

シャーディングされたコレクション内のデータの分散に関する情報を返します。

db.aggregate()メソッドの代わりに、db.collection.aggregate() メソッドを使用します。