MongoDBでは、$avg
集計パイプライン演算子は、指定された数値の平均値を計算して返します。
構文
$avg
演算子は2つの構文をサポートします。
構文1:
{ $avg: <expression> }
構文2:
{ $avg: [ <expression1>, <expression2> ... ] }
最初の構文は1つの引数を受け入れ、2番目の構文は複数の引数を受け入れます。
$group
で使用する場合 ステージでは、最初の構文のみを使用できます。この場合、$avg
同じgroupbyキーを共有するドキュメントのグループ内の各ドキュメントに指定された式を適用した結果のすべての数値の合計を返します。
構文1の例(単一引数)
構文1を使用する例をいくつか示します。
グループ化されたドキュメント
この例では、$avg
を使用しています $group
と組み合わせて キーでグループ化されたドキュメントのグループ全体の平均を返します。
pets
というコレクションがあるとします。 次のドキュメントを使用:
{ "_id" : 1, "name" : "Wag", "type" : "Dog", "weight" : 20 } { "_id" : 2, "name" : "Bark", "type" : "Dog", "weight" : 10 } { "_id" : 3, "name" : "Meow", "type" : "Cat", "weight" : 7 } { "_id" : 4, "name" : "Scratch", "type" : "Cat", "weight" : 8 } { "_id" : 5, "name" : "Bruce", "type" : "Kangaroo", "weight" : 100 } { "_id" : 6, "name" : "Hop", "type" : "Kangaroo", "weight" : 130 } { "_id" : 7, "name" : "Punch", "type" : "Kangaroo", "weight" : 200 } { "_id" : 8, "name" : "Snap", "type" : "Cat", "weight" : 12 } { "_id" : 9, "name" : "Ruff", "type" : "Dog", "weight" : 30 }
これらのドキュメントをtype
でグループ化できます フィールドをクリックし、$avg
を使用します 各グループの平均重みを返すには:
db.pets.aggregate(
[
{
$group:
{
_id: "$type",
average_weight: { $avg: "$weight" }
}
}
]
)
結果:
{ "_id" : "Dog", "average_weight" : 20 } { "_id" : "Cat", "average_weight" : 9 } { "_id" : "Kangaroo", "average_weight" : 143.33333333333334 }
配列
この例では、$avg
を適用します 値の配列を持つフィールドを含む単一のドキュメントに。
このオプションは、単一引数構文を使用する場合にのみ使用できます。マルチ引数構文を使用する場合、配列は無視されます(これについては以下で詳しく説明します)。
players
というコレクションがあるとします。 次のドキュメントを使用:
{ "_id" : 1, "player" : "Homer", "scores" : [ 1, 7, 2, 3, 8, 7, 1 ] } { "_id" : 2, "player" : "Marge", "scores" : [ 0, 1, 8, 17, 18, 8 ] } { "_id" : 3, "player" : "Bart", "scores" : [ 15, 11, 8, 0, 1, 3 ] } { "_id" : 4, "player" : "Brian", "scores" : [ 7 ] } { "_id" : 5, "player" : "Farnsworth", "scores" : [ ] } { "_id" : 6, "player" : "Meg", "scores" : null } { "_id" : 7, "player" : "Ron" }
$avg
を適用できます scores
に 各ドキュメントのフィールド:
db.players.aggregate(
[
{
$project:
{
player: 1,
averageScore: { $avg: "$scores" }
}
}
]
)
結果:
{ "_id" : 1, "player" : "Homer", "averageScore" : 4.142857142857143 } { "_id" : 2, "player" : "Marge", "averageScore" : 8.666666666666666 } { "_id" : 3, "player" : "Bart", "averageScore" : 6.333333333333333 } { "_id" : 4, "player" : "Brian", "averageScore" : 7 } { "_id" : 5, "player" : "Farnsworth", "averageScore" : null } { "_id" : 6, "player" : "Meg", "averageScore" : null } { "_id" : 7, "player" : "Ron", "averageScore" : null }
この場合、最初の4つのドキュメントは、それぞれの配列にあるさまざまな数の平均を返しました。
ドキュメント4の場合、配列には1つの番号しかなかったため、これは番号と同じでした。
ドキュメント5がnull
を返しました 空の配列を提供したためです。
ドキュメント6がnull
を返しました null
を提供したため 引数として。
ドキュメント7がnull
を返しました フィールドさえ存在しなかったからです。
構文2の例(複数の引数)
2番目の構文には、$avg
の提供が含まれます。 複数の引数があります。 $avg
次に、提供されたすべての引数に基づいて平均を計算します。
data
というコレクションがあるとします。 次のドキュメントを使用:
{ "_id" : 1, "a" : 1, "b" : 2, "c" : 3, "d" : 4 } { "_id" : 2, "a" : 1, "b" : 2, "c" : 3, "d" : [ 4 ] } { "_id" : 3, "a" : 1, "b" : 2, "c" : 3, "d" : "Hey" } { "_id" : 4, "a" : "One", "b" : "Two", "c" : "Three", "d" : "Four" }
$avg
を使用できます a
の平均を返す 、b
、c
、およびd
各ドキュメントのフィールド:
db.data.aggregate(
[
{
$project:
{
avg: { $avg: [ "$a", "$b", "$c", "$d" ] }
}
}
]
)
結果:
{ "_id" : 1, "avg" : 2.5 } { "_id" : 2, "avg" : 2 } { "_id" : 3, "avg" : 2 } { "_id" : 4, "avg" : null }
ドキュメント1は、1
の入力値の平均を返します 、2
、3
、および4
。
ただし、次の2つのドキュメントは、1
の入力値の平均のみを返しました。 、2
、および3
。 $avg
オペレーターはd
を無視しました 田畑。
これは、$avg
が原因です。 数値以外の値を無視します。したがって、この場合は"Hey"
を無視しました ドキュメント3で、残りの(数値)フィールドから平均を計算しました。
ドキュメント2については、そのd
フィールドに配列が含まれています。前述のように、$avg
マルチ引数構文を使用する場合、演算子は配列を無視します。より正確には、このコンテキストで使用される場合、配列を非数値として扱い、$avg
数値以外の値を無視します。
すべての値が数値以外の場合、$avg
null
を返します 。これはドキュメント4で確認できます。
欠落しているフィールド
複数引数の構文を使用する場合は、$avg
欠落しているフィールドはすべて無視されます。つまり、存在しないフィールドを指定すると、それは無視されます。フィールドが存在しない場合は、null
を返します。 。
例:
db.data.aggregate(
[
{
$project:
{
avg: { $avg: [ "$a", "$b", "$c", "$d", "$e" ] }
}
}
]
)
結果:
{ "_id" : 1, "avg" : 2.5 } { "_id" : 2, "avg" : 2 } { "_id" : 3, "avg" : 2 } { "_id" : 4, "avg" : null }
この場合、追加のフィールド($e
)を提供しました )ドキュメントには存在しません。 $avg
実行する残りのフィールドに基づいて平均を計算しました 存在します。
ただし、なしの場合は次のようになります 存在するフィールドの数:
db.data.aggregate(
[
{
$project:
{
result: { $avg: [ "$x", "$y", "$z" ] }
}
}
]
)
結果:
{ "_id" : 1, "result" : null } { "_id" : 2, "result" : null } { "_id" : 3, "result" : null } { "_id" : 4, "result" : null }
結果はnull
です すべてのドキュメントに対して。
前に見たように、単一引数の構文を使用する場合、フィールドが欠落していると、null
になります。 。
例:
db.pets.aggregate(
[
{
$group:
{
_id: "$type",
avg: { $avg: "$oops!" }
}
}
]
)
結果:
{ "_id" : "Kangaroo", "avg" : null } { "_id" : "Cat", "avg" : null } { "_id" : "Dog", "avg" : null }
利用可能なステージ
$avg
次の段階で利用できます:
-
$group
-
$project
-
$addFields
-
$set
-
$replaceRoot
-
$replaceWith
-
$match
$expr
を含むステージ 表現