$avg(集計)
定義
バージョン 5.0 での変更。
数値の平均値を返します。$avg
は数値以外の値を無視します。
$avg
は、次のステージで使用できます。
$setWindowFields
(MongoDB 5.0 以降で使用可能)
構文
$bucket
、 $bucketAuto
、 $group
、 $setWindowFields
ステージで使用する場合、 $avg
は次の構文をとります。
{ $avg: <expression> }
サポートされている他のステージで使用する場合、 $avg
は次の 2 つの構文のいずれかをとります。
$avg
にはオペランドとして指定された式が 1 つあります。{ $avg: <expression> } $avg
にはオペランドとして指定された式のリストがあります。{ $avg: [ <expression1>, <expression2> ... ] }
式の詳細については、「式演算子」を参照してください。
動作
結果の型
デフォルトの戻り値の型は double
です。少なくとも1つのオペランドが decimal
の場合、戻り値の型は10進数です。
数値以外の値または欠損値
$avg
は欠落値を含む数値以外の値を無視します。平均のオペランドがすべて数値以外の場合、ゼロ値の平均は未定義であるため、$avg
は null
を返します。
配列オペランド
$group
ステージでは、式の結果が配列となる場合、 $avg
はオペランドを数値以外の値として扱います。
サポートされている他のステージでは、次のようになります。
例
$group
ステージで使用
以下のドキュメントを持つsales
コレクションを考えてみましょう。
{ "_id" : 1, "item" : "abc", "price" : 10, "quantity" : 2, "date" : ISODate("2014-01-01T08:00:00Z") } { "_id" : 2, "item" : "jkl", "price" : 20, "quantity" : 1, "date" : ISODate("2014-02-03T09:00:00Z") } { "_id" : 3, "item" : "xyz", "price" : 5, "quantity" : 5, "date" : ISODate("2014-02-03T09:05:00Z") } { "_id" : 4, "item" : "abc", "price" : 10, "quantity" : 10, "date" : ISODate("2014-02-15T08:00:00Z") } { "_id" : 5, "item" : "xyz", "price" : 5, "quantity" : 10, "date" : ISODate("2014-02-15T09:12:00Z") }
次の操作では、ドキュメントを item
フィールドでグループ化し、$avg
アキュムレータを使用して各グループの平均金額と平均数量を計算します。
db.sales.aggregate( [ { $group: { _id: "$item", avgAmount: { $avg: { $multiply: [ "$price", "$quantity" ] } }, avgQuantity: { $avg: "$quantity" } } } ] )
この操作は次の結果を返します。
{ "_id" : "xyz", "avgAmount" : 37.5, "avgQuantity" : 7.5 } { "_id" : "jkl", "avgAmount" : 20, "avgQuantity" : 1 } { "_id" : "abc", "avgAmount" : 60, "avgQuantity" : 6 }
$project
ステージで使用
コレクション students
には次のドキュメントが含まれています。
{ "_id": 1, "quizzes": [ 10, 6, 7 ], "labs": [ 5, 8 ], "final": 80, "midterm": 75 } { "_id": 2, "quizzes": [ 9, 10 ], "labs": [ 8, 8 ], "final": 95, "midterm": 80 } { "_id": 3, "quizzes": [ 4, 5, 5 ], "labs": [ 6, 5 ], "final": 78, "midterm": 70 }
次の例では、$project
ステージの $avg
を使用して、クイズの平均スコア、ラボの平均スコア、および最終と中間の平均を計算します。
db.students.aggregate([ { $project: { quizAvg: { $avg: "$quizzes"}, labAvg: { $avg: "$labs" }, examAvg: { $avg: [ "$final", "$midterm" ] } } } ])
この操作の結果、次のドキュメントが作成されます。
{ "_id" : 1, "quizAvg" : 7.666666666666667, "labAvg" : 6.5, "examAvg" : 77.5 } { "_id" : 2, "quizAvg" : 9.5, "labAvg" : 8, "examAvg" : 87.5 } { "_id" : 3, "quizAvg" : 4.666666666666667, "labAvg" : 5.5, "examAvg" : 74 }
$setWindowFields
ステージで使用
バージョン 5.0 で追加
カリフォルニア州(CA
)とワシントン州(WA
)のケーキ販売を含む cakeSales
コレクションを作成します。
db.cakeSales.insertMany( [ { _id: 0, type: "chocolate", orderDate: new Date("2020-05-18T14:10:30Z"), state: "CA", price: 13, quantity: 120 }, { _id: 1, type: "chocolate", orderDate: new Date("2021-03-20T11:30:05Z"), state: "WA", price: 14, quantity: 140 }, { _id: 2, type: "vanilla", orderDate: new Date("2021-01-11T06:31:15Z"), state: "CA", price: 12, quantity: 145 }, { _id: 3, type: "vanilla", orderDate: new Date("2020-02-08T13:13:23Z"), state: "WA", price: 13, quantity: 104 }, { _id: 4, type: "strawberry", orderDate: new Date("2019-05-18T16:09:01Z"), state: "CA", price: 41, quantity: 162 }, { _id: 5, type: "strawberry", orderDate: new Date("2019-01-08T06:12:03Z"), state: "WA", price: 43, quantity: 134 } ] )
この例では、$setWindowFields
ステージで $avg
を使用して、各 state
のケーキの売上 quantity
の移動平均を出力します:
db.cakeSales.aggregate( [ { $setWindowFields: { partitionBy: "$state", sortBy: { orderDate: 1 }, output: { averageQuantityForState: { $avg: "$quantity", window: { documents: [ "unbounded", "current" ] } } } } } ] )
この例では、次のことが行われます。
partitionBy: "$state"
はコレクション内のドキュメントをstate
で分割します。CA
とWA
のパーティションがあります。sortBy: { orderDate: 1 }
は、各パーティション内のドキュメントをorderDate
で昇順(1
)に並べ替えるので、最も古いorderDate
が最初になります。
output
ドキュメント ウィンドウ内のドキュメントに対して、$avg
を使用してaverageQuantityForState
フィールドを移動平均quantity
に設定します。ウィンドウには、
unbounded
下限とcurrent
ドキュメントの間にあるドキュメントが出力されます。 つまり、$avg
は、パーティションの先頭から現在のドキュメントまでのドキュメントの移動平均quantity
を返します。
この出力では、CA
と WA
の移動平均 quantity
が averageQuantityForState
フィールドに表示されます。
{ "_id" : 4, "type" : "strawberry", "orderDate" : ISODate("2019-05-18T16:09:01Z"), "state" : "CA", "price" : 41, "quantity" : 162, "averageQuantityForState" : 162 } { "_id" : 0, "type" : "chocolate", "orderDate" : ISODate("2020-05-18T14:10:30Z"), "state" : "CA", "price" : 13, "quantity" : 120, "averageQuantityForState" : 141 } { "_id" : 2, "type" : "vanilla", "orderDate" : ISODate("2021-01-11T06:31:15Z"), "state" : "CA", "price" : 12, "quantity" : 145, "averageQuantityForState" : 142.33333333333334 } { "_id" : 5, "type" : "strawberry", "orderDate" : ISODate("2019-01-08T06:12:03Z"), "state" : "WA", "price" : 43, "quantity" : 134, "averageQuantityForState" : 134 } { "_id" : 3, "type" : "vanilla", "orderDate" : ISODate("2020-02-08T13:13:23Z"), "state" : "WA", "price" : 13, "quantity" : 104, "averageQuantityForState" : 119 } { "_id" : 1, "type" : "chocolate", "orderDate" : ISODate("2021-03-20T11:30:05Z"), "state" : "WA", "price" : 14, "quantity" : 140, "averageQuantityForState" : 126 }