定義
バージョン 5.0 で追加
 $setWindowFieldsステージパーティション内の他のドキュメントに対するドキュメントの位置(ランクと呼ばれる)を返します。
ステージの $setWindowFieldssortBy フィールドの値によってドキュメントのランクが決まります。$rank演算子とともに使用する場合、 sortByは値として 1 つのフィールドのみを取ることができます。 MongoDB がさまざまなタイプのフィールドを比較する方法の詳細については、「 BSON 比較順序 」を参照してください。
複数のドキュメントが同じランクを占有する場合、 $rankは後続の 値を持つドキュメントを差のあるランクに配置します(「動作」を参照)。
$rankは$setWindowFieldsステージでのみ使用可能です。
$rank 構文: 
{ $rank: { } } 
$rank は、パラメータを受け入れません。
Tip
動作
$rankと$denseRankは、重複するsortByフィールド値をランク付けする方法が異なります。 たとえば、 sortByフィールドの値が7 、 9 、 9 、 10の場合は次のようになります。
- $denseRankは、値を 1、2、2、および 3 としてランク付けします。 重複 9 値のランクは 2、10 のランクは 3 です。 ランクに差はありません。
- $rankは、値を 1、2、2、および 4 としてランク付けします。重複する 9 の値のランクは 2 で、10 のランクは 4 です。 3 のランクに差があります。
nullsortBy フィールドの 値を持つドキュメント、または sortBy フィールドが欠落しているドキュメントには、 BSON 比較順序に基づいてランクが割り当てられます。
例
カリフォルニア州(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 } ] ) 
整数フィールドでパーティションをランク付けする
この例では、$rank $setWindowFieldsステージのquantity を使用して、各 のケーキ売上の ランクを出力します。state
db.cakeSales.aggregate( [    {       $setWindowFields: {          partitionBy: "$state",          sortBy: { quantity: -1 },          output: {             rankQuantityForState: {                $rank: {}             }          }       }    } ] ) 
この例では、次のことが行われます。
- partitionBy: "$state"はコレクション内のドキュメントを- stateで分割します。- CAと- WAのパーティションがあります。
- sortBy: { quantity: -1 }は各パーティション内のドキュメントを- quantityで降順(- -1)にソートするため、最高の- quantityが先頭になります。
- output次の結果に示すように、- $rankを使用して- rankQuantityForStateフィールドを- quantityランクに設定します。
{ "_id" : 4, "type" : "strawberry", "orderDate" : ISODate("2019-05-18T16:09:01Z"),   "state" : "CA", "price" : 41, "quantity" : 162, "rankQuantityForState" : 1 } { "_id" : 2, "type" : "vanilla", "orderDate" : ISODate("2021-01-11T06:31:15Z"),   "state" : "CA", "price" : 12, "quantity" : 145, "rankQuantityForState" : 2 } { "_id" : 0, "type" : "chocolate", "orderDate" : ISODate("2020-05-18T14:10:30Z"),   "state" : "CA", "price" : 13, "quantity" : 120, "rankQuantityForState" : 3 } { "_id" : 1, "type" : "chocolate", "orderDate" : ISODate("2021-03-20T11:30:05Z"),   "state" : "WA", "price" : 14, "quantity" : 140, "rankQuantityForState" : 1 } { "_id" : 5, "type" : "strawberry", "orderDate" : ISODate("2019-01-08T06:12:03Z"),   "state" : "WA", "price" : 43, "quantity" : 134, "rankQuantityForState" : 2 } { "_id" : 3, "type" : "vanilla", "orderDate" : ISODate("2020-02-08T13:13:23Z"),   "state" : "WA", "price" : 13, "quantity" : 104, "rankQuantityForState" : 3 } 
日付フィールドでパーティションをランク付けする
この例では、$rank $setWindowFieldsステージでorderDate を含む日付を使用して、各 のケーキ売上の ランクを出力する方法を示します。state
db.cakeSales.aggregate( [    {       $setWindowFields: {          partitionBy: "$state",          sortBy: { orderDate: 1 },          output: {             rankOrderDateForState: {                $rank: {}             }          }       }    } ] ) 
この例では、次のことが行われます。
- partitionBy: "$state"はコレクション内のドキュメントを- stateで分割します。- CAと- WAのパーティションがあります。
- sortBy: { orderDate: 1 }は、各パーティション内のドキュメントを- orderDateで昇順(- 1)に並べ替えるので、最も古い- orderDateが最初になります。
- output次の結果に示すように、- $rankを使用して- rankOrderDateForStateフィールドを- orderDateランクに設定します。
{ "_id" : 4, "type" : "strawberry", "orderDate" : ISODate("2019-05-18T16:09:01Z"),   "state" : "CA", "price" : 41, "quantity" : 162, "rankOrderDateForState" : 1 } { "_id" : 0, "type" : "chocolate", "orderDate" : ISODate("2020-05-18T14:10:30Z"),   "state" : "CA", "price" : 13, "quantity" : 120, "rankOrderDateForState" : 2 } { "_id" : 2, "type" : "vanilla", "orderDate" : ISODate("2021-01-11T06:31:15Z"),   "state" : "CA", "price" : 12, "quantity" : 145, "rankOrderDateForState" : 3 } { "_id" : 5, "type" : "strawberry", "orderDate" : ISODate("2019-01-08T06:12:03Z"),   "state" : "WA", "price" : 43, "quantity" : 134, "rankOrderDateForState" : 1 } { "_id" : 3, "type" : "vanilla", "orderDate" : ISODate("2020-02-08T13:13:23Z"),   "state" : "WA", "price" : 13, "quantity" : 104, "rankOrderDateForState" : 2 } { "_id" : 1, "type" : "chocolate", "orderDate" : ISODate("2021-03-20T11:30:05Z"),   "state" : "WA", "price" : 14, "quantity" : 140, "rankOrderDateForState" : 3 } 
重複値、null、または欠損データを含むランク パーティション
以下の条件に一致するcakeSalesWithDuplicatesコレクションを作成します。
- ケーキ販売はカリフォルニア州( - CA)とワシントン州(- WA)に配置されます。
- ドキュメント 6 から 8 の - quantityと- stateはドキュメント 5 と同じです。
- ドキュメント 9 の - quantityと- stateはドキュメント 4 と同じです。
- ドキュメント 10 には - null- quantityがあります。
- ドキュメント 11 には - quantityがありません。
db.cakeSalesWithDuplicates.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 },    { _id: 6, type: "strawberry", orderDate: new Date("2020-01-08T06:12:03Z"),      state: "WA", price: 41, quantity: 134 },    { _id: 7, type: "strawberry", orderDate: new Date("2020-01-01T06:12:03Z"),      state: "WA", price: 34, quantity: 134 },    { _id: 8, type: "strawberry", orderDate: new Date("2020-01-02T06:12:03Z"),      state: "WA", price: 40, quantity: 134 },    { _id: 9, type: "strawberry", orderDate: new Date("2020-05-11T16:09:01Z"),      state: "CA", price: 39, quantity: 162 },    { _id: 10, type: "strawberry", orderDate: new Date("2020-05-11T16:09:01Z"),      state: "CA", price: 39, quantity: null },    { _id: 11, type: "strawberry", orderDate: new Date("2020-05-11T16:09:01Z"),      state: "CA", price: 39 } ] ) 
$rank$setWindowFieldsこの例では、quantity ステージのcakeSalesWithDuplicates を使用して、各 の コレクションから ランクを出力します。state
db.cakeSalesWithDuplicates.aggregate( [    {       $setWindowFields: {          partitionBy: "$state",          sortBy: { quantity: -1 },          output: {             rankQuantityForState: {                $rank: {}             }          }       }    } ] ) 
この例では、次のことが行われます。
- partitionBy: "$state"はコレクション内のドキュメントを- stateで分割します。- CAと- WAのパーティションがあります。
- sortBy: { quantity: -1 }は各パーティション内のドキュメントを- quantityで降順(- -1)にソートするため、最高の- quantityが先頭になります。
- output- $rankを使用して、- rankOrderDateForStateフィールドを- quantityランクに設定します。
次の出力例では、次のようになります。
- 同じ - quantityと- stateを持つドキュメントは同じランクになります。 ドキュメントのランクが同じ場合、そのランクと次のランクの間に差があります。
- null- quantityを持つドキュメントと、次に欠落している- quantityを持つドキュメントは、- CAパーティションの出力で最低と評価されます。 この並べ替えはBSON 比較順序の結果です。この例では、- nullと欠損値を数値の後にソートします。
{ "_id" : 4, "type" : "strawberry", "orderDate" : ISODate("2019-05-18T16:09:01Z"),   "state" : "CA", "price" : 41, "quantity" : 162, "rankQuantityForState" : 1 } { "_id" : 9, "type" : "strawberry", "orderDate" : ISODate("2020-05-11T16:09:01Z"),   "state" : "CA", "price" : 39, "quantity" : 162, "rankQuantityForState" : 1 } { "_id" : 2, "type" : "vanilla", "orderDate" : ISODate("2021-01-11T06:31:15Z"),   "state" : "CA", "price" : 12, "quantity" : 145, "rankQuantityForState" : 3 } { "_id" : 0, "type" : "chocolate", "orderDate" : ISODate("2020-05-18T14:10:30Z"),   "state" : "CA", "price" : 13, "quantity" : 120, "rankQuantityForState" : 4 } { "_id" : 10, "type" : "strawberry", "orderDate" : ISODate("2020-05-11T16:09:01Z"),   "state" : "CA", "price" : 39, "quantity" : null, "rankQuantityForState" : 5 } { "_id" : 11, "type" : "strawberry", "orderDate" : ISODate("2020-05-11T16:09:01Z"),   "state" : "CA", "price" : 39, "rankQuantityForState" : 6 } { "_id" : 1, "type" : "chocolate", "orderDate" : ISODate("2021-03-20T11:30:05Z"),   "state" : "WA", "price" : 14, "quantity" : 140, "rankQuantityForState" : 1 } { "_id" : 5, "type" : "strawberry", "orderDate" : ISODate("2019-01-08T06:12:03Z"),   "state" : "WA", "price" : 43, "quantity" : 134, "rankQuantityForState" : 2 } { "_id" : 6, "type" : "strawberry", "orderDate" : ISODate("2020-01-08T06:12:03Z"),   "state" : "WA", "price" : 41, "quantity" : 134, "rankQuantityForState" : 2 } { "_id" : 7, "type" : "strawberry", "orderDate" : ISODate("2020-01-01T06:12:03Z"),   "state" : "WA", "price" : 34, "quantity" : 134, "rankQuantityForState" : 2 } { "_id" : 8, "type" : "strawberry", "orderDate" : ISODate("2020-01-02T06:12:03Z"),   "state" : "WA", "price" : 40, "quantity" : 134, "rankQuantityForState" : 2 } { "_id" : 3, "type" : "vanilla", "orderDate" : ISODate("2020-02-08T13:13:23Z"),   "state" : "WA", "price" : 13, "quantity" : 104, "rankQuantityForState" : 6 }