$rank (agregação)

Nesta página

Definição

Comportamento
Exemplos

Definição

Novidades na versão 5.0.

$rank

Retorna a posição do documento (conhecida como classificação) em relação a outros documentos na $setWindowFields partição de estágio.

O valor do campo sortBy no estágio $setWindowFields determina a classificação do documento. Quando usado com o operador $rank, sortBy só pode usar um campo como valor. Para obter mais informações sobre como o MongoDB compara campos com tipos diferentes, consulte Ordem de comparação BSON.

Se vários documentos ocuparem a mesma classificação, $rank colocará o documento com o valor subsequente em uma classificação com uma lacuna (consulte Comportamento).

$rank está disponível somente no estágio $setWindowFields.

$rank sintaxe:

{ $rank: { } }

$rank não aceita parâmetros.

Dica

Veja também:

$denseRank

Comportamento

$rank e $denseRank diferem na forma como classificam os valores duplicados do campo sortBy. Por exemplo, com valores de campo sortBy de 7, 9, 9 e 10:

$denseRank classifica os valores como 1, 2, 2 e 3. Os valores de 9 duplicados têm classificação de 2, e 10 tem classificação de 3. Não há lacuna nas classificações.
$rank classifica os valores como 1, 2, 2 e 4. Os valores de 9 duplicados têm classificação de 2 e 10 tem classificação de 4. Há uma lacuna nas classificações para 3.

Documentos com um valor de null para um campo sortBy ou documentos sem o campo sortBy são atribuídos a uma classificação baseada na ordem de comparação JSON.

Consulte o exemplo em Partições de Nível contendo Valores duplicados, Nulos ou Dados ausentes.

Exemplos

Crie uma collection cakeSales que contenha vendas de bolo nos estados da Califórnia (CA) e de Washington (WA):

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 }
] )

Classificar partições por um campo inteiro

Este exemplo utiliza $rank no estágio $setWindowFields para gerar a classificação quantity das vendas de bolo para cada state:

db.cakeSales.aggregate( [
   {
      $setWindowFields: {
         partitionBy: "$state",
         sortBy: { quantity: -1 },
         output: {
            rankQuantityForState: {
               $rank: {}
            }
         }
      }
   }
] )

No exemplo:

partitionBy: "$state" particiona os documentos na collection por state. Existem partições para CA e WA.
sortBy: { quantity: -1 } ordena os documentos em cada partição por quantity em ordem decrescente (-1), de modo que o quantity mais alto seja o primeiro.

output define o campo rankQuantityForState para a classificação quantity usando $rank, como mostrado nos resultados seguintes.

{ "_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 }

Partições de nível por um campo de data

Este exemplo mostra como utilizar datas com $rank no estágio $setWindowFields para gerar a classificação orderDate das vendas de bolo para cada state:

db.cakeSales.aggregate( [
   {
      $setWindowFields: {
         partitionBy: "$state",
         sortBy: { orderDate: 1 },
         output: {
            rankOrderDateForState: {
               $rank: {}
            }
         }
      }
   }
] )

No exemplo:

partitionBy: "$state" particiona os documentos na collection por state. Existem partições para CA e WA.
sortBy: { orderDate: 1 } classifica os documentos em cada partição por orderDate em ordem crescente (1), para que o orderDate mais antigo seja o primeiro.

output define o campo rankOrderDateForState para a classificação orderDate usando $rank, como mostrado nos resultados seguintes.

{ "_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 }

Classificar partições contendo valores duplicados, nulos ou dados ausentes

Crie uma collection cakeSalesWithDuplicates onde:

As vendas de bolos são realizadas no estado da Califórnia (CA) e Washington (WA).
Os documentos 6 a 8 têm o mesmo quantity e state que o documento 5.
O documento 9 tem o mesmo quantity e state que o documento 4.
O documento 10 tem um null quantity.
O documento 11 não tem 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 }
] )

Este exemplo utiliza $rank no estágio $setWindowFields para gerar a classificação quantity da coleção cakeSalesWithDuplicates para cada state:

db.cakeSalesWithDuplicates.aggregate( [
   {
      $setWindowFields: {
         partitionBy: "$state",
         sortBy: { quantity: -1 },
         output: {
            rankQuantityForState: {
               $rank: {}
            }
         }
      }
   }
] )

No exemplo:

partitionBy: "$state" particiona os documentos na collection por state. Existem partições para CA e WA.
sortBy: { quantity: -1 } ordena os documentos em cada partição por quantity em ordem decrescente (-1), de modo que o quantity mais alto seja o primeiro.

output define o campo rankOrderDateForState para a classificação quantity usando $rank.

No exemplo de saída a seguir:

Documentos com o mesmo quantity e state têm a mesma classificação. Se os documentos tiverem a mesma classificação, haverá uma lacuna entre essa classificação e a próxima classificação.
O documento com null quantity e, em seguida, o documento com quantity ausente são classificados como o mais baixo na saída para a partição CA. Essa classificação é o resultado da ordem de comparação BSON, que classifica os valores null e ausentes após os valores numéricos neste exemplo.

{ "_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 }

← $range (agregação)

$reduzir (agregação) →

$rank (agregação).leafygreen-ui-m0pgrr{-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;padding:0 10px;visibility:hidden;}.leafygreen-ui-a30zj9{color:#889397;vertical-align:middle;margin-top:-2px;}.css-1l4s55v{margin-top:-175px;position:absolute;padding-bottom:2px;}

Definição

Dica

Veja também:

Comportamento

Exemplos

Classificar partições por um campo inteiro

Partições de nível por um campo de data

Classificar partições contendo valores duplicados, nulos ou dados ausentes

$rank (agregação)