集計演算子

集計パイプライン演算子は、MongoDB Atlas およびオンプレミス環境と互換性があります。

注意

構文や例など、特定の演算子の詳細については、演算子のリファレンスページへのリンクをクリックしてください

互換性

以下の環境でホストされている配置メントには、集計パイプライン演算子を使用できます。

MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージドサービスです

MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

式演算子

式演算子は、引数を取る関数と似ています。一般的に、これらの演算子は引数の配列をとり、次のような形式になります。

{ <operator>: [ <argument1>, <argument2> ... ] }

演算子が引数を 1 つだけ受け入れる場合は、引数リストを指定する外側の配列を省略できます。

{ <operator>: <argument> }

引数がリテラル配列の場合の解析のあいまいさを避けるには、リテラル配列を $literal 式で囲むか、引数リストを指定する外側の配列を保持する必要があります。

このページでは、式を構築するために使用できる演算子を一覧にしています。式は、 MQLでは次のコンテキストで使用されます。

一部の集計パイプラインステージ（ $project 、 $addFields 、 $groupなど）
を使用する内部クエリ述語 $expr
クエリプロジェクションの検索

算術式演算子

算術式は、数値に対して数学演算を実行します。一部の算術式では、日付の算術演算もサポートできます。

名前	説明
`$abs`	数値の絶対値を返します。
`$add`	数値を加算して合計を返すか、数値と日付を加算して新しい日付を返します。数値と日付を加算する場合は、数値をミリ秒として扱います。任意の数の引数式を受け入れますが、日付に解決できる式は最大で 1 つだけです。
`$ceil`	指定した数値以上の最小の整数を返します。
`$divide`	最初の数値を 2 番目の数値で除算した結果を返します。2 つの引数式を受け入れます。
`$exp`	e を指定された指数に上げます。
`$floor`	指定した数値以下の最大の整数を返します。
`$ln`	数値の自然対数を計算します。
`$log`	指定した基数の数値のログを計算します。
`$log10`	数値の対数基数 10 を計算します。
`$mod`	最初の数値の余りを 2 番目の数値で割った値を返します。2 つの引数式を受け入れます。
`$multiply`	数値を乗算して積を返します。任意の数の引数式を受け入れます。
`$pow`	指定した指数まで数値を上げます。
`$round`	数値を整数または指定された小数点以下の桁に丸めます。
`$sqrt`	平方根を計算します。
`$subtract`	最初の値から 2 番目の値を減算した結果を返します。2 つの値が数値の場合は、差を返します。2 つの値が日付の場合は、ミリ秒単位で差を返します。2 つの値が日付とミリ秒単位の数値の場合、結果の日付を返します。2 つの引数式を受け入れます。2 つの値が日付と数値の場合、数値から日付を減算しても意味がないため、最初に日付引数を指定します。
`$trunc`	数値を整数または指定された小数点以下の桁に切り捨てます。

配列式演算子

名前	説明
`$arrayElemAt`	指定された配列インデックスの要素を返します。
`$arrayToObject`	キーと値のペアの配列をドキュメントに変換します。
`$concatArrays`	配列を連結して、連結された配列を返します。
`$filter`	配列のサブセットを選択して、フィルター条件に一致する要素のみを含む配列を返します。
`$firstN`	配列の先頭から指定した数の要素を返します。`$firstN` アキュムレータとは異なります。
`$in`	指定した値が配列内にあるかどうかをブール値で返します。
`$indexOfArray`	配列内で指定された値の出現を検索し、最初に出現した位置の配列インデックスを返します。配列インデックスは 0 から始まります。
`$isArray`	オペランドが配列であるかどうかを判断します。ブール値を返します。
`$lastN`	配列の末尾から指定した数の要素を返します。`$lastN` アキュムレータとは異なります。
`$map`	配列の各要素に部分式を適用し、結果の値の配列を順番に返します。名前付きパラメータを受け入れます。
`$maxN`	配列内の `n` 個の最大値を返します。`$maxN` アキュムレータとは異なります。
`$minN`	配列内の `n` 個の最小値を返します。`$minN` アキュムレータとは異なります。
`$objectToArray`	ドキュメントを、キーと値のペアを表すドキュメントの配列に変換します。
`$range`	ユーザー定義の入力に従って、整数のシーケンスを含む配列を出力します。
`$reduce`	配列内の各要素に式を適用し、それらを 1 つの値に結合します。
`$reverseArray`	要素を逆の順序の配列を返します。
`$size`	配列内の要素の数を返します。引数として 1 つの式を受け入れます。
`$slice`	配列のサブセットを返します。
`$sortArray`	配列の要素をソートします。
`$zip`	2 つの配列を結合します。

ビット演算子

名前	説明
`$bitAnd`	`int`または`long`値の配列に対するビット単位の`and`演算の結果を返します。バージョン 6.3 で追加。
`$bitNot`	単一の引数または単一の `int` または `long` 値を含む配列に対するビット単位の `not` 演算の結果を返します。バージョン 6.3 で追加。
`$bitOr`	`int`または`long`値の配列に対するビット単位の`or`演算の結果を返します。バージョン 6.3 で追加。
`$bitXor`	`int` と `long` の値の配列に対するビット単位の `xor` （排他的論理和）演算の結果を返します。バージョン 6.3 で追加。

ブール式演算子

ブール式は引数式をブール値として評価し、結果としてブール値を返します。

ブール式は、 falseブール値に加えて、次のnull 、 0 、およびundefined値をfalseとして評価します。ブール式は、ゼロ以外の数値と配列を含む他のすべての値をtrueとして評価します。

名前	説明
`$and`	すべての式が `true` と評価された場合にのみ `true` を返します。任意の数の引数式を受け入れます。
`$not`	ブール値関数は、引数で指定した式と反対の真偽値を返します。単一の引数式を受け入れます。
`$or`	いずれかの式が`true`と評価された場合は`true`を返します。任意の数の引数式を受け入れます。

比較式演算子

比較式はブール値を返しますが、$cmp は数値を返します。

比較式は 2 つの引数式を取り、異なる型の値に対して指定された BSON 比較順序を使用して、値と型の両方を比較します。

名前	説明
`$cmp`	2 つの値が等しい場合は`0`を返し、最初の値が 2 番目の値より大きい場合は`1`を返し、最初の値が 2 番目の値より小さい場合は`-1`を返します。
`$eq`	値が等しい場合は`true`を返します。
`$gt`	最初の値が 2 番目の値より大きい場合は`true`を返します。
`$gte`	1 番目の値が 2 番目の値以上であれば `true` を返します。
`$lt`	最初の値が 2 番目の値より小さい場合は`true`を返します。
`$lte`	最初の値が 2 番目の値以下の場合に `true` を返します。
`$ne`	値が等価でない場合は `true` を返します。

条件式演算子

名前	説明
`$cond`	1 つの式を評価し、その結果に応じて他の 2 つの式のいずれかの値を返す三項演算子。順序付けられたリスト内の 3 つの式または 3 つの名前付きパラメータのいずれかを受け入れます。
`$ifNull`	最初の式の null 以外の結果を返すか、最初の式の結果が null の場合は 2 番目の式の結果を返します。null 結果には、未定義の値または欠落したフィールドのインスタンスが含まれます。引数として 2 つの式を受け入れます。2 番目の式の結果は null にすることができます。
`$switch`	一連のケース式を評価します。`true`に評価される式が見つかると、 `$switch`指定された式を実行し、制御フローを抜け出します。

カスタム集計式演算子

名前	説明
`$accumulator`	カスタム累算器関数を定義します。
`$function`	カスタム関数を定義します。

データサイズ演算子

次の演算子は、データ要素のサイズを返します。

名前	説明
`$binarySize`	指定された文字列またはバイナリデータ値の内容のサイズをバイト単位で返します。
`$bsonSize`	指定されたドキュメントのサイズをバイト単位で返します（つまりbsontype `Object` ）。（BSON としてエンコードされた場合）

日付式演算子

以下の演算子は、日付オブジェクトまたは日付オブジェクトの構成要素を返します。

名前	説明
`$dateAdd`	日付オブジェクトにいくつかの時間単位を追加します。
`$dateDiff`	2 つの日付の差を返します。
`$dateFromParts`	日付の構成要素を指定して BSON Date オブジェクトを構築します。
`$dateFromString`	日付/時刻文字列をオブジェクトに変換します。
`$dateSubtract`	日付オブジェクトからいくつかの時間単位を減算します。
`$dateToParts`	日付の構成部分を含むドキュメントを返します。
`$dateToString`	日付を書式設定された文字列として返します。
`$dateTrunc`	日付を切り捨てます。
`$dayOfMonth`	日付の日付を 1 から 31 までの数値で返します。
`$dayOfWeek`	日付の曜日を 1（日曜日）から7（土曜日）までの数値として返します。
`$dayOfYear`	日付の年間通算日を 1 ～ 366（閏年）の数値として返します。
`$hour`	日付の時間を 0 から 23 までの数値で返します。
`$isoDayOfWeek`	曜日番号を ISO 8601 形式で返します。範囲は`1`（月曜日）から`7`（日曜日）までです。
`$isoWeek`	`1`から`53`までの範囲の ISO 8601 形式の週番号を返します。週番号は、その年の最初の木曜日を含む週（月曜日から日曜日）の`1`から始まります。
`$isoWeekYear`	ISO 8601 形式の年番号を返します。年は第 1 週の月曜日（ISO 8601）から始まり、最終週の日曜日（ISO 8601）に終わります。
`$millisecond`	日付のミリ秒を 0 から 999 までの数値で返します。
`$minute`	日付の分を 0 から 59 までの数値で返します。
`$month`	日付の月を 1（1 月）から 12（12 月）までの数値として返します。
`$second`	日付の秒数を 0 から 60（うるう秒）までの数値として返します。
`$toDate`	値を日付に変換します。
`$week`	日付の週番号を 0（年の最初の日曜日に先行する部分的な週）から 53（うるう年）までの数値で返します。
`$year`	日付の年を数値で返します（例：2014）。

以下の算術演算子は日付オペランドを取ることができます。

名前

説明

$add

数値と日付を加算して、新しい日付を返します。数値と日付を加算する場合は、数値をミリ秒として扱います。任意の数の引数式を受け入れますが、日付に解決できる式は最大で 1 つだけです。

$subtract

最初の値から 2 番目の値を減算した結果を返します。2 つの値が日付の場合は、ミリ秒単位で差を返します。2 つの値が日付とミリ秒単位の数値の場合、結果の日付を返します。2 つの引数式を受け入れます。2 つの値が日付と数値の場合、数値から日付を減算しても意味がないため、最初に日付引数を指定します。

リテラル式演算子

名前	説明
`$literal`	解析せずに値を返します。集計パイプラインが式として解釈できる値に使用します。例えば、フィールドパスとして解析されないようにするには、ドル記号（ `$` ）で始まる文字列に`$literal`式を使用します。

その他の演算子

名前	説明
`$getField`	ドキュメントから指定したフィールドの値を返します。`$getField`を使用すると、名前にピリオド（ `.` ）が含まれるフィールドやドル記号（ `$` ）で始まるフィールドの値を取得できます。バージョン 5.0 で追加
`$rand`	0 から 1 の間のランダムな浮動小数点数を返します。
`$sampleRate`	指定されたレートでドキュメントをランダムに選択します。選択されるドキュメントの正確な数は実行ごとに異なりますが、選択される数量は、ドキュメントの総数に対するパーセンテージで表されるサンプルレートに近似します。
`$toHashedIndexKey`	MongoDB がハッシュインデックスを作成するのと同じハッシュ関数を使用して、入力式のハッシュを計算して返します。

オブジェクト式演算子

名前	説明
`$mergeObjects`	複数のドキュメントを 1 つのドキュメントに結合します。
`$objectToArray`	ドキュメントを、キーと値のペアを表すドキュメントの配列に変換します。
`$setField`	ドキュメント内の指定したフィールドを追加、更新、または削除します。`$setField`を使用すると、名前にピリオド（ `.` ）が含まれるフィールドやドル記号（ `$` ）で始まるフィールドを追加、更新、または削除できます。バージョン 5.0 で追加

集合式演算子

セット式は、配列をセットとして扱い、配列に対してセット演算を実行します。セット式は、各入力配列内の重複するエントリと要素の順序を無視します。

セット操作がセットを返す場合、操作は結果内の重複を除外して、ユニークなエントリのみを含む配列を出力します。出力配列内の要素の順序は指定されていません。

セットにネストされた配列要素が含まれている場合、セット式はネストされた配列に下降せず、最上位の配列を評価します。

名前	説明
`$allElementsTrue`	セットのどの要素も`false`と評価されない場合は`true`を返し、そうでない場合は`false`を返します。単一の引数式を受け入れます。
`$anyElementTrue`	セットのいずれかの要素が`true`と評価された場合は`true`を返します。それ以外の場合は`false`を返します。単一の引数式を受け入れます。
`$setDifference`	最初のセットには表示されるが 2 番目のセットには表示されない要素を含むセットを返します。相対値を実行します最初のセットに対する 2 番目のセットの。厳密に 2 つの引数式を受け入れます。
`$setEquals`	入力セットが同じ明確な要素を持つ場合は `true` を返します。2 つ以上の引数式を受け入れます。
`$setIntersection`	すべての入力セットに現れる要素を含むセットをします。任意の数の引数式を受け入れます。
`$setIsSubset`	Returns `true` if all elements of the first set appear in the second set, including when the first set equals the second set; i.e. not a strict subset. 厳密に 2 つの引数式を受け入れます。
`$setUnion`	入力セットのいずれかに現れる要素を含むセットを返します。

文字列式演算子

文字列式は、$concatを除き、ASCII 文字の文字列に対してのみ明確に定義された動作を持ちます。

$concat 動作は、使用される文字に関係なく明確に定義されています。

名前	説明
`$concat`	任意の数の文字列を連結します。
`$dateFromString`	日付/時刻文字列をオブジェクトに変換します。
`$dateToString`	日付を書式設定された文字列として返します。
`$indexOfBytes`	文字列から部分文字列を検索し、最初に出現した文字列の UTF-8 バイトインデックスを返します。部分文字列が見つからない場合は、 `-1`を返します。
`$indexOfCP`	文字列から部分文字列を検索し、最初に出現した文字列の UTF-8 コードポイントのインデックスを返します。部分文字列が見つからない場合は、 `-1`
`$ltrim`	文字列の先頭から空白または指定した文字を削除します。
`$regexFind`	正規表現（regex）を文字列に適用し、最初に一致したサブストリングに関する情報を返します。
`$regexFindAll`	正規表現（regex）を文字列に適用し、一致したすべての部分文字列に関する情報を返します。
`$regexMatch`	正規表現（regex）を文字列に適用し、一致するものが見つかったかどうかを示すブール値を返します。
`$replaceOne`	指定された入力内の一致した文字列の最初のインスタンスを置き換えます。
`$replaceAll`	指定された入力内の一致した文字列のすべてのインスタンスを置き換えます。
`$rtrim`	文字列の末尾から空白または指定した文字を削除します。
`$split`	文字列を区切り文字に基づいて部分文字列に分割します。部分文字列の配列を返します。区切り文字が文字列内に見つからない場合は、元の文字列を含む配列を返します。
`$strLenBytes`	文字列内の UTF-8 でエンコードされたバイト数を返します。
`$strLenCP`	UTF-8コードポイントの数を文字列で返します。
`$strcasecmp`	大文字と小文字を区別しない文字列比較を行い、2 つの文字列が等しい場合は `0`、最初の文字列が 2 番目の文字列より大きい場合は `1`、最初の文字列が 2 番目の文字列より小さい場合は `-1` を返します。
`$substr`	非推奨。`$substrBytes`または`$substrCP`を使用してください。
`$substrBytes`	文字列の部分文字列を返します。文字列内の指定された UTF-8 バイトインデックス（ゼロベース）の文字から始まり、指定されたバイト数だけ継続します。
`$substrCP`	string の部分文字列を返します。指定された UTF-8 コードポイント（CP）の文字で始まるインデックス（ゼロベース）の string 内のを、指定されたコードポイントの数だけ継続します。
`$toLower`	文字列を小文字に変換します。単一の引数式を受け入れます。
`$toString`	値を文字列に変換します。
`$trim`	文字列の先頭と末尾から空白または指定された文字を削除します。
`$toUpper`	文字列を大文字に変換します。単一の引数式を受け入れます。

テキスト式演算子

名前	説明
`$meta`	集計操作に関連するドキュメントごとの利用可能なメタデータにアクセスします。

タイムスタンプ式演算子

タイムスタンプ式演算子は、タイムスタンプから値を返します。

名前	説明
`$tsIncrement`	タイムスタンプからの増分序数を `long` 型で返します。バージョン 5.1 で追加。
`$tsSecond`	タイムスタンプからの秒数を `long` として返します。バージョン 5.1 で追加。

三角法の式演算子

三角関数の式は、数値に対して三角関数の操作を行います。角度を表す値は、常にラジアンで入力または出力されます。度とラジアンの測定値を変換するには、$degreesToRadians と $radiansToDegrees を使用します。

名前	説明
`$sin`	ラジアンで測定された値のサインを返します。
`$cos`	ラジアンで測定された値のコサインを返します。
`$tan`	ラジアンで測定された値のタンジェントを返します。
`$asin`	値の逆サイン（アークサイン）をラジアンで返します。
`$acos`	値の逆コサイン（アークコサイン）をラジアンで返します。
`$atan`	値の逆タンジェント（アークタンジェント）をラジアンで返します。
`$atan2`	`y / x` の逆タンジェント (アークタンジェント) をラジアンで返します。ここでは、`y` と `x` はそれぞれ式に渡される最初の値と 2 番目の値です。
`$asinh`	値の逆双曲線サイン（双曲線アークサイン）をラジアンで返します。
`$acosh`	値の逆双曲線コサイン（双曲線アークコサイン）をラジアンで返します。
`$atanh`	値の逆双曲線タンジェント（双曲線アークタンジェント）をラジアンで返します。
`$sinh`	ラジアンで測定された値の双曲線サインを返します。
`$cosh`	ラジアンで測定された値の双曲線コサインを返します。
`$tanh`	ラジアンで測定された値の双曲線タンジェントを返します。
`$degreesToRadians`	値を度からラジアンに変換します。
`$radiansToDegrees`	値をラジアンから度に変換します。

型式演算子

名前	説明
`$convert`	値を指定した型に変換します。
`$isNumber`	指定された式が`integer` 、 `decimal` 、 `double` 、または`long`に解決される場合はブール値`true`を返します。式が他のBSON 型、 `null` 、または欠落したフィールドに解決される場合はブール値`false`を返します。
`$toBool`	値をブール値に変換します。
`$toDate`	値を日付に変換します。
`$toDecimal`	値を Decimal128 に変換します。
`$toDouble`	値を double に変換します。
`$toInt`	値を整数に変換します。
`$toLong`	値を long に変換します。
`$toObjectId`	値を ObjectId に変換します。
`$toString`	値を文字列に変換します。
`$type`	フィールドの BSON データ型を返します。
`$toUUID`	文字列を UUID に変換します。

アキュムレータ（`$group, $bucket, $bucketAuto, $setWindowFields` ）

集計アキュムレータ演算子：

ドキュメントが集約パイプラインを通過するときにその状態を維持します。
合計、最大値、最小値、およびその他の値を返します。
次の集約パイプラインステージで使用できます。
- $bucket
- $bucketAuto
- $group
- $setWindowFields MongoDB 5.0 以降で使用可能です（ただし、 $accumulatorまたは$mergeObjects演算子を使用している場合は除きます。これらは$setWindowFieldsでは使用できません）

バージョン 5.0 での変更。

名前	説明
`$accumulator`	ユーザー定義のアキュムレータ関数の結果を返します。
`$addToSet`	グループごとのユニークな式値の配列を返します。配列要素の順序は未定義です。バージョン 5.0 で変更、`$setWindowFields`ステージで使用可能です。
`$avg`	数値の平均を返します。数値以外の値は無視されます。バージョン 5.0 で変更、`$setWindowFields`ステージで使用可能です。
`$bottom`	指定ソート順に従って、グループ内の最下位の要素を返します。バージョン 5.2 で追加。 `$group`および`$setWindowFields`ステージで利用可能です。
`$bottomN`	グループ内の下位 `n` フィールドの集計を、指定のソート順序に従って返します。バージョン 5.2 で追加。 `$group`および`$setWindowFields`ステージで利用可能です。
`$count`	グループにあるドキュメントの数を返します。 `$count` パイプラインステージとは異なります。バージョン 5.0 で追加され、`$group`および`$setWindowFields`ステージで利用できます。
`$first`	グループ内の最初のドキュメントの式の結果を返します。バージョン 5.0 で変更、`$setWindowFields`ステージで使用可能です。
`$firstN`	グループ内の最初の `n` 個の要素の集計を返します。ドキュメントが定義どおりの順序になっている場合にのみ意味があります。`$firstN` 配列演算子とは異なります。バージョン 5.2 で追加され、`$group` 、式、 `$setWindowFields`ステージで使用できます。
`$last`	グループ内の最後のドキュメントの式の結果を返します。バージョン 5.0 で変更、`$setWindowFields`ステージで使用可能です。
`$lastN`	グループ内の最後の `n` 要素の集計を返します。ドキュメントが定義どおりの順序になっている場合にのみ意味があります。`$lastN` 配列演算子とは異なります。バージョン 5.2 で追加され、`$group` 、式、 `$setWindowFields`ステージで使用できます。
`$max`	グループごとの最大の式の値を返します。バージョン 5.0 で変更、`$setWindowFields`ステージで使用可能です。
`$maxN`	グループ内の最大値を持つ `n` 要素の集計を返します。`$maxN` 配列演算子とは異なります。バージョン 5.2 で追加。 `$group` 、 `$setWindowFields` 、および式として使用できます。
`$median`	中央値、つまり 50 パーセンタイルの近似値がスカラー値として返されます。バージョン 7.0 で追加。この演算子は、次に示すステージでアキュムレータとして使用できます。 `$group` `$setWindowFields` 集計式としても使用できます。
`$mergeObjects`	各グループの入力ドキュメントを組み合わせて作成したドキュメントを返します。
`$min`	グループごとの最小の式値を返します。バージョン 5.0 で変更、`$setWindowFields`ステージで使用可能です。
`$minN`	グループ内の `n` 個の最小値要素の集合を返します。`$minN`配列演算子とは異なります。バージョン 5.2 で追加。 `$group` 、 `$setWindowFields` 、および式として使用できます。
`$percentile`	指定パーセンタイル値に対応するスカラー値の配列を返します。バージョン 7.0 で追加。この演算子は、次に示すステージでアキュムレータとして使用できます。 `$group` `$setWindowFields` 集計式としても使用できます。
`$push`	グループごとのドキュメントの式値の配列を返します。バージョン 5.0 で変更、`$setWindowFields`ステージで使用可能です。
`$stdDevPop`	入力値の母集団標準偏差を返します。バージョン 5.0 で変更、`$setWindowFields`ステージで使用可能です。
`$stdDevSamp`	入力値のサンプル標準偏差を返します。バージョン 5.0 で変更、`$setWindowFields`ステージで使用可能です。
`$sum`	数値の合計を返します。数値以外の値は無視されます。バージョン 5.0 で変更、`$setWindowFields`ステージで使用可能です。
`$top`	指定ソート順に従って、グループ内の最上位の要素を返します。バージョン 5.2 で追加。 `$group`および`$setWindowFields`ステージで利用可能です。
`$topN`	グループ内の上位 `n` フィールドの集計を、指定のソート順序に従って返します。バージョン 5.2 で追加。 `$group`および`$setWindowFields`ステージで利用可能です。

アキュムレーター（他のステージ）

$group ステージのアキュムレータとして使用できる演算子の中には、他のステージでは使用できてもアキュムレータとしては使用できないものもあります。これらの他の段階で使用した場合、これらの演算子は状態を維持せず、単一の引数または複数の引数のいずれかを入力として取ることができます。詳細については、各演算子のページを参照してください。