定義
配列内の数値の合計を返します。
注意
$sum のその他の用途
このページでは、配列内の数値の合計を返す式として使用される場合の$sum について説明します。
次の他のコンテキストでは $sum を使用することもできます。
$sum (accumulator)は、ドキュメントのグループ全体の数値の合計を返します。$sum (window function)$setWindowFieldsは、ウィンドウ内の 値の累積合計を計算するために ステージで使用されます。
構文
式として使用する場合、$sum は次の 2 つの構文のいずれかをとります。
{ $sum: <expression> }
上記の構文では 、オペランドは配列として評価される単一の式です。 $sum は 配列をトラバースし、配列の数値の合計を返します。
{ $sum: [ <expression1>, <expression2>, ... ] }
上記の構文では、各式は単一の数値です。 $sum は、それらの値の合計を返します。
動作
結果の型
入力型が混在している場合、$sum は小さい入力型を 2 つのうち大きい方にプロモートします。型は、より幅広い値を表す場合、より大きな値と見なされます。数値型の最小値から最大値の順は、integer → long → double → decimal です。
演算がオーバーフローして、大きい方のデータ型で表される範囲を超えない限り、大きい方の入力型によって結果型も決まります。オーバーフローの場合、$sum は以下の順序に従って結果を昇格させます。
数値以外の値のフィールドまたは存在しないフィールド
数値と数値以外の値の両方を含むフィールドで使用される場合、$sum は数値以外の値を無視し、数値の合計を返します。
すべてのオペランドが数値以外の場合、$sum は 0 を返します。
例
このページの例では、 sample_mflix データセット のデータを使用します。このデータセットを自己管理型MongoDBデプロイにロードする 方法の詳細については、「 サンプル データセットをロードする 」を参照してください。サンプルデータベースに変更を加えた場合、このページの例を実行するには、データベースを削除して再作成する必要がある場合があります。
この例では、$sum $projectステージの を使用して、3 つの映画の賞の合計を計算し、その結果をtotalAwards という新しいフィールドに保存します。
db.movies.aggregate( [ { $match: { title: { $in: [ "The Godfather", "Inception", "The Dark Knight" ] } } }, { $project: { _id: 0, title: 1, totalAwards: { $sum: [ "$awards.wins", "$awards.nominations" ] } } }, { $sort: { totalAwards: -1 } } ] )
先行するパイプライン: