$out（集計）

との比較 $merge

MongoDB には、集計パイプラインの結果をコレクションに書き込むために、$merge と $out の 2 つのステージが備わっています。次に、2 つのステージの機能をまとめます。

セカンダリ レプリカセットのノードで実行される $out 読み取り操作

MongoDB 5.0 以降では、クラスター内のすべてのノードの featureCompatibilityVersion が 5.0 以上に設定され、かつ読み込み設定 (read preference) がセカンダリに設定されている場合に、レプリカセットのセカンダリ ノードで $out を実行できます。

$out ステートメントの読み取り操作はセカンダリ ノードで、書き込み操作はプライマリノードでのみ行われます。

すべてのドライバー バージョンが、レプリカセットのセカンダリノードへの $out 操作のターゲットをサポートしているわけではありません。ドライバーのドキュメントをチェックして、ドライバーがセカンダリ上で実行される $out のサポートをいつ追加したかを確認してください。

新しいコレクションの作成

$out 操作では、コレクションがまだ存在しない場合に新しいコレクションが作成されます。

コレクションは、集計が完了するまで表示されません。集約が失敗した場合、MongoDB ではコレクションが作成されません。

既存のコレクションの置き換え

$out 操作で指定されたコレクションがすでに存在する場合、集計の完了時に、$out ステージは既存のコレクションを新しい結果のコレクションにアトミックに置き換えます。具体的に言うと、$out 操作では

1. 一時コレクションを作成します。

2. 既存のコレクションから一時コレクションにインデックスをコピーします。

3. ドキュメントを一時コレクションに挿入します。

4. dropTarget: true で renameCollection コマンドを呼び出し、一時コレクションの名前を宛先コレクションに変更します。

指定されたコレクションが存在し、$out 操作で timeseries オプションが指定されている場合は、次の制限が適用されます。

1. 既存のコレクションは時系列コレクションでなければならない。

2. 既存のコレクションはビューであってはならない。

3. $out ステージに含まれる timeseries オプションは、既存のコレクションのオプションと完全に一致する必要があります。

$out 操作では、前のコレクションに存在していたインデックスは変更されません。集計が失敗した場合、$out 操作では既存のコレクションは変更されません。

インデックスの制約

パイプラインによって生成されたドキュメントが、元の出力コレクションの _id フィールドのインデックスを含め、一意のインデックスに違反する場合、パイプラインは完了しません。

$out 操作によって Atlas Search インデックスを含むコレクションが変更される場合は、検索インデックスを削除して再作成する必要があります。代わりに、$merge の使用を検討してください。

majority 読み取り保証（read concern）

$out ステージを含む集計に対して、読み取り保証 (read concern) レベル "majority" を指定できます。

相互作用: mongodump

--oplog で開始された mongodump は、ダンプ プロセス中にクライアントが $out を含む集計パイプラインを発行すると失敗します。詳細については、mongodump --oplog を参照してください。

制限事項

同じデータベースへの出力

次の集計操作では、test データベース内の books コレクションのデータをピボットして、著者ごとにタイトルをグループ化し、その結果を authors コレクション（同じ test データベース内）に書き込みます。

db.getSiblingDB("test").books.aggregate( [
    { $group : { _id : "$author", books: { $push: "$title" } } },
    { $out : "authors" }
] )

第 1 ステージ（$group）：

$group ステージでは authors でグループ化を行い、$push を使用して books 配列フィールドにタイトルを追加します。

{ "_id" : "Dante", "books" : [ "The Banquet", "Divine Comedy", "Eclogues" ] }
{ "_id" : "Homer", "books" : [ "The Odyssey", "Iliad" ] }

第 2 ステージ（$out）：

$outステージでは、ドキュメントが test データベースの authors コレクションに出力されます。

出力コレクション内のドキュメントを表示するには、次の操作を実行します。

db.getSiblingDB("test").authors.find()

コレクションには、次のドキュメントが含まれます。

{ "_id" : "Homer", "books" : [ "The Odyssey", "Iliad" ] }
{ "_id" : "Dante", "books" : [ "The Banquet", "Divine Comedy", "Eclogues" ] }

別のデータベースへの出力

$out 集計が実行される場所とは異なるデータベース内のコレクションに出力できます。

次の集計操作では、books コレクションのデータをピボットして、著者ごとにタイトルをグループ化し、その結果を reporting データベース内の authors コレクションに書き込みます。

db.getSiblingDB("test").books.aggregate( [
    { $group : { _id : "$author", books: { $push: "$title" } } },
    { $out : { db: "reporting", coll: "authors" } }
] )

第 1 ステージ（$group）：

$group ステージでは authors でグループ化を行い、$push を使用して books 配列フィールドにタイトルを追加します。

{ "_id" : "Dante", "books" : [ "The Banquet", "Divine Comedy", "Eclogues" ] }
{ "_id" : "Homer", "books" : [ "The Odyssey", "Iliad" ] }

第 2 ステージ（$out）：

$outステージでは、ドキュメントが reporting データベースの authors コレクションに出力されます。

出力コレクション内のドキュメントを表示するには、次の操作を実行します。

db.getSiblingDB("reporting").authors.find()

コレクションには、次のドキュメントが含まれます。

{ "_id" : "Homer", "books" : [ "The Odyssey", "Iliad" ] }
{ "_id" : "Dante", "books" : [ "The Banquet", "Divine Comedy", "Eclogues" ] }