$documentNumber (agregação)

Nesta página

Definição

Comportamento
Exemplos

Definição

Novidades na versão 5.0.

$documentNumber

Retorna a posição de um documento (conhecido como o número do documento) no estágio de $setWindowFields partição.

O campo sortBy do estágio $setWindowFields determina o número do documento. Para obter mais informações sobre como o MongoDB compara campos com tipos diferentes, consulte Ordem de comparação de BSON.

$documentNumber retorna um número exclusivo para cada documento em uma partição, mesmo que vários documentos tenham valores de campo SortBy idênticos na partição.

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

$documentNumber sintaxe:

{ $documentNumber: { } }

$documentNumber não aceita parâmetros.

Comportamento

$documentNumber inclui documentos que têm um campo sortBy null ou ausente.

$documentNumber, $rank e $denseRank retornam a posição dos documentos com base nos valores do campo sortBy.

$documentNumber difere de $rank e $denseRank na forma como são tratados os documentos com valores de campo sortBy idênticos em uma partição:

$rank e $denseRank retornam a mesma posição (conhecida como classificação) para esses documentos.
$documentNumber retorna uma posição exclusiva (conhecida como número do documento) para esses documentos.

Veja o exemplo em Número do documento para valores duplicados, nulos e ausentes.

Exemplos

Número do documento para cada estado

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

Este exemplo utiliza $documentNumber no estágio $setWindowFields para gerar o número do documento de vendas de bolo para cada state:

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

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 número do documento em um novo campo chamado documentNumberForState, mostrado nos resultados a seguir. documentNumberForState é exclusivo em cada partição state.

{ "_id" : 4, "type" : "strawberry", "orderDate" : ISODate("2019-05-18T16:09:01Z"),
  "state" : "CA", "price" : 41, "quantity" : 162, "documentNumberForState" : 1 }
{ "_id" : 2, "type" : "vanilla", "orderDate" : ISODate("2021-01-11T06:31:15Z"),
  "state" : "CA", "price" : 12, "quantity" : 145, "documentNumberForState" : 2 }
{ "_id" : 0, "type" : "chocolate", "orderDate" : ISODate("2020-05-18T14:10:30Z"),
  "state" : "CA", "price" : 13, "quantity" : 120, "documentNumberForState" : 3 }
{ "_id" : 1, "type" : "chocolate", "orderDate" : ISODate("2021-03-20T11:30:05Z"),
  "state" : "WA", "price" : 14, "quantity" : 140, "documentNumberForState" : 1 }
{ "_id" : 5, "type" : "strawberry", "orderDate" : ISODate("2019-01-08T06:12:03Z"),
  "state" : "WA", "price" : 43, "quantity" : 134, "documentNumberForState" : 2 }
{ "_id" : 3, "type" : "vanilla", "orderDate" : ISODate("2020-02-08T13:13:23Z"),
  "state" : "WA", "price" : 13, "quantity" : 104, "documentNumberForState" : 3 }

Número do documento para valores duplicados, nulos e 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 $documentNumber no estágio $setWindowFields para gerar o número do documento cakeSalesWithDuplicates para cada state:

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