AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

$group(集計ステージ)

$group

$group ステージは、グループ キーに従って、同じフィールドまたは式を持つ複数のドキュメントを単一のドキュメントに結合します。その結果、一意のグループ キーごとに 1 つのドキュメントが生成されます。

グループキーは、多くの場合、フィールドまたはフィールドのグループです。 グループキーは、 式 の結果にすることもできます。 グループキーを設定するには、 $groupパイプライン ステージの_idフィールドを使用します。 の使用例 については以下を参照してください。

$group ステージの出力では、 _id フィールドにそのドキュメントのグループ キーが設定されます。

出力ドキュメントには、アキュムレータ式 を使用して設定された追加のフィールドを含めることもできます。

注意

$groupは出力ドキュメントを順序付けしません。

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

  • MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです
  • MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

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

$groupステージのプロトタイプ形式は次のとおりです。

{ $group: { _id: <expression>, // Group key <field1>: { <accumulator1> : <expression1> }, ... } }
フィールド
説明

_id

必須。 _id式はグループキーを指定します。 null の_id値またはその他の定数値を指定すると、 $groupステージはすべての入力ドキュメントにわたる値を集計する単一のドキュメントを返します。 「null でグループ化」の例を参照してください。

field

_id演算子とアキュムレータ 演算子は、有効な任意のexpressionを受け入れることができます。 式の詳細については、「式 」を参照してください。

$group はブロッキング ステージであり、パイプラインはデータを処理する前にすべての入力データが検索されるまで待機します。ブロッキング ステージは、複数のステージを持つパイプラインの並列処理を減らすため、パフォーマンスを低下させる可能性があります。ブロッキング ステージでは、大規模なデータセットに対して大量のメモリが使用される場合もあります。

<accumulator> 演算子は、次のアキュムレータ 演算子のいずれかである必要があります。

名前
説明

ユーザー定義のアキュムレータ関数の結果を返します。

グループごとのユニークな式値の配列を返します。配列要素の順序は未定義です。

数値の平均を返します。

指定ソート順に従って、グループ内の最下位の要素を返します。

グループ内の下位 n フィールドの集計を、指定のソート順序に従って返します。

2 つ以上の配列の要素を組み合わせた 1 つの配列を返します。

バージョン8.1の新機能。

グループにあるドキュメントの数を返します。

$count パイプライン ステージとは異なります。

グループ内の最初のドキュメントの式の結果を返します。

グループ内の最初の n 個の要素の集計を返します。ドキュメントが定義どおりの順序になっている場合にのみ意味があります。$firstN 配列演算子とは異なります。

グループ内の最後のドキュメントの式の結果を返します。

グループ内の最後の n 個の要素に対して指定された式を評価した結果を返します。

グループごとの最大の式の値を返します。

グループ内の最大値を持つ n 要素の集計を返します。$maxN 配列演算子とは異なります。

グループ内のドキュメントの 中央値 (50 パーセンタイル) の近似値が返されます。

バージョン7.0の新機能。

各グループの入力ドキュメントを組み合わせて作成したドキュメントを返します。

グループごとの最小の式値を返します。

グループ内の n 個の最小値要素の集合を返します。$minN配列演算子とは異なります。

指定パーセンタイル値に対応するスカラー値の配列を返します。

バージョン7.0の新機能。

グループごとのドキュメントの式値の配列を返します。

2 つ以上の配列を受け取り、任意の入力配列に現れる要素を含む配列を返します。

バージョン8.1の新機能。

グループ内のドキュメントからの値の母集団標準偏差を返します。

グループ内のドキュメントからの値のサンプル標準偏差を返します。

数値の合計を返します。数値以外の値は無視されます。

指定ソート順に従って、グループ内の最上位の要素を返します。

グループ内の上位 n フィールドの集計を、指定のソート順序に従って返します。

$group ステージには、空のフィールド名を持つアキュムレータ式を含めることはできません。詳細については、「空のフィールド名 $group 制限」を参照してください。

$groupステージが100メガバイトの RAM を超える場合、MongoDB は一時ファイルにデータを書込みます。 ただし、 allowDiskUseオプションがfalseに設定されている場合、 $groupはエラーを返します。 詳細については、「集計パイプラインの制限 」を参照してください。

この動作は、$group ステージ自体の状態に適用されます。$push や $addToSet などの一部のアキュムレータでは、単一の累積オブジェクトがメモリのしきい値を超えて大きくなる可能性があります。これらのアキュムレータは、一時ファイルをディスクに書き込み (write) できません。累積されたオブジェクトがメモリ制限を超えると、allowDiskUse オプションが true の場合でも操作はエラーを返します。

このセクションでは、 $groupのパフォーマンスを向上させるための最適化について説明します。 手動で行うことができる最適化と、MongoDB が内部で行う最適化があります。

パイプラインsortsとgroupsが同じフィールドで実行され、 $groupステージで$firstまたは$lastアキュムレータ 演算子のみが使用される場合は、並べ替え順序に一致するグループ化されたフィールドにインデックスを追加することを検討してください。場合によっては、$group ステージでインデックスを使用して各グループの最初または最後のドキュメントをすばやく見つけることができます。

例

moviesコレクションにインデックス{ year: 1, title: 1 } が含まれている場合、次のパイプラインはそのインデックスを使用して各グループの最初のdocumentを検索できます。

db.movies.aggregate([ { $sort: { year: 1, title: 1 } }, { $group: { _id: { year: "$year" }, title: { $first: "$title" } } }])

バージョン 5.2 以降、MongoDB は、次のいずれかの場合にスロットベースの実行クエリ エンジンを使用して$groupステージを実行します。

  • $group はパイプラインの第一ステージです。

  • パイプラインの先行ステージもすべて、スロットベースの実行エンジンで実行できます。

詳細については、「$group 最適化」を参照してください。

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

次の集計操作では、 $groupステージを使用してmoviesコレクション内のドキュメントの数をカウントします。

db.movies.aggregate([ { $group: { _id: null, count: { $count: {} } } }])
[ { _id: null, count: 21349 }]

この集計操作は、次の SQL ステートメントと同等です。

SELECT COUNT(*) AS count FROM movies

次の集計操作では、$group ステージを使用して、moviesコレクションから個別の rated 値を取得します。

db.movies.aggregate( [ { $group : { _id : "$rated" } } ] )
[ { _id: 'TV-PG' }, { _id: 'PG' }, { _id: 'TV-14' }, { _id: 'OPEN' }, { _id: 'Not Rated' }, { _id: 'GP' }, { _id: 'TV-Y7' }, { _id: 'G' }, { _id: 'PG-13' }, { _id: null }, { _id: 'M' }, { _id: 'R' }, { _id: 'TV-MA' }, { _id: 'APPROVED' }, { _id: 'PASSED' }, { _id: 'Approved' }, { _id: 'AO' }, { _id: 'TV-G' }]

注意

例、次の形式の $group 操作の場合、DISTINCT_SCAN が返されます。

{ $group : { _id : "$<field>" } }

個別の値を取得するための動作の詳細については、個別の コマンドの動作を参照してください。

操作の結果がDISTINCT_SCAN になるかどうかを確認するには、操作の explain 結果 を確認します。

次の集計操作では、documentを ratedフィールドでグループ化し、評価ごとの合計実行時間を計算し、合計実行時間が 100000 以上の評価のみを返します。

db.movies.aggregate( [ // First Stage { $group: { _id: "$rated", totalRuntime: { $sum: "$runtime" } } }, // Second Stage { $match: { "totalRuntime": { $gte: 100000 } } } ])
[ { _id: 'PG-13', totalRuntime: 250843 }, { _id: 'R', totalRuntime: 582318 }, { _id: null, totalRuntime: 967127 }, { _id: 'PG', totalRuntime: 191204 }]
第 1 ステージ:
$group ステージでは、ドキュメントを rated でグループ化し、個別の評価値を取得します。このステージでは、各評価グループの totalRuntime が返されます。
第 2 ステージ:
$match ステージでは、結果の document をフィルタリングして、totalRuntime が 100000 以上の評価のみを返します。

この集計操作は、次の SQL ステートメントと同等です。

SELECT rated, Sum(runtime) AS totalRuntimeFROM moviesGROUP BY ratedHAVING totalRuntime >= 100000

次のパイプラインは、1910 以前の各年の合計実行時間、平均実行時間、映画の本数

db.movies.aggregate([ { $match: { "year": { $lt: 1910 } } }, { $group: { _id: "$year", totalRuntime: { $sum: "$runtime" }, averageRuntime: { $avg: "$runtime" }, count: { $sum: 1 } } }, { $sort: { totalRuntime: -1 } }])
[ { _id: 1909, totalRuntime: 14, averageRuntime: 14, count: 1 }, { _id: 1903, totalRuntime: 11, averageRuntime: 11, count: 1 }, { _id: 1896, totalRuntime: 2, averageRuntime: 1, count: 2 }]
第 1 ステージ:
$match ステージでは、documentをフィルタリングして、1910 より前にリリースされた映画のみを次のステージに渡します。
第 2 ステージ:
$group ステージでは、documentを年ごとにグループ化し、各グループの合計実行時間、平均実行時間、documentの合計数を計算します。
第 3 ステージ:
$sort ステージでは、各グループの合計実行時間の降順で結果がソートされます。

この集計操作は、次の SQL ステートメントと同等です。

SELECT year, Sum(runtime) AS totalRuntime, Avg(runtime) AS averageRuntime, Count(*) AS countFROM moviesWHERE year < 1910GROUP BY yearORDER BY totalRuntime DESC

Tip

次の集計操作では、null のグループ _id を指定し、コレクション内のすべてのdocumentの合計実行時間、平均実行時間、カウントを計算します。

db.movies.aggregate([ { $group: { _id: null, totalRuntime: { $sum: "$runtime" }, averageRuntime: { $avg: "$runtime" }, count: { $sum: 1 } } }])
[ { _id: null, totalRuntime: 2167458, averageRuntime: 103.65652797704448, count: 21349 }]

この集計操作は、次の SQL ステートメントと同等です。

SELECT Sum(runtime) AS totalRuntime, Avg(runtime) AS averageRuntime, Count(*) AS countFROM movies

Tip

次の集計操作では、moviesコレクションのデータをピボットして、タイトルを年ごとにグループ化します。

db.movies.aggregate([ { $match: { year: { $lt: 1910 } } }, { $group: { _id: "$year", titles: { $push: "$title" } } }, { $sort: { _id: 1 } }])
[ { _id: 1896, titles: [ 'The Kiss', 'The Kiss' ] }, { _id: 1903, titles: [ 'The Great Train Robbery' ] }, { _id: 1909, titles: [ 'A Corner in Wheat' ] }]

次の集計操作では、documentを年ごとにグループ化します。

db.movies.aggregate([ { $match: { year: { $lt: 1910 } } }, { $group: { _id: "$year", movies: { $push: "$$ROOT" } } }, { $addFields: { totalRuntime: { $sum: "$movies.runtime" } } }, { $sort: { _id: 1 } }])
[ { _id: 1896, movies: '...', totalRuntime: 2 }, { _id: 1903, movies: '...', totalRuntime: 11 }, { _id: 1909, movies: '...', totalRuntime: 14 }]
第 1 ステージ:
$match はdocumentをフィルタリングして、1910 より前にリリースされた映画のみを次のステージに渡します。
第 2 ステージ:
$group は $$ROOT システム変数を使用してdocument全体を年ごとにグループ化します。
第 3 ステージ:

$addFields 出力に各年の映画の合計実行時間を含むフィールドを追加します。

注意

結果のドキュメントは、BSON ドキュメント サイズの上限である 16 メビバイトを超えてはなりません。

第 4 ステージ
$sort は結果の document を _id で昇順にソートします。

「グループと合計データ」のチュートリアルでは、 一般的なユースケースにおける $group 演算子の幅広い例を紹介します。

関連するパイプラインステージの詳細については、$addFieldsガイドを参照してください。

ルール バッジを取得する

「データ変換の基礎」を無料でマスターしましょう!

詳細

このページを評価