$first (agregação)

Nesta página

Definição

Sintaxe
Comportamentos
Exemplos

Definição

$first

Alterado na versão 5.0.

Retorna o resultado de uma expressão para o primeiro documento em um grupo de documentos. Só faz sentido quando os documentos estão em uma ordem definida.

$first está disponível nestes estágios:

$bucket
$bucketAuto
$group
$setWindowFields (Disponível a partir do MongoDB 5.0)

Sintaxe

$first sintaxe:

{ $first: <expression> }

Comportamentos

Definindo ordem do documento

Para definir a ordem do documento para $first em um $setWindowFields, defina o campo Classificar por.
Para definir a ordem do documento para $first em outros estágios do pipeline, adicione um estágio $sort anterior.

Operador de array

Se a expressão resolver para uma array:

Para um grupo de documentos, o $first retorna toda a array do primeiro documento. Não atravessa elementos da array. Este é o caso com estágios como $group e $setWindowFields.
Para um documento individual, o $first retorna o primeiro elemento da array. Esse é o caso de estágios como $addFields.

Valores em falta

Documentos em um grupo podem estar sem campos ou podem ter campos com valores ausentes.

Se não houver documentos do estágio anterior do pipeline, o estágio $group não retornará nada.
Se o campo que o acumulador do $first está em processamento estiver ausente, o $first retornará null.
Quando utilizado com $setWindowFields, o $first retorna null para janelas vazias. Por exemplo, quando você tem uma janela { documents:[ -1, -1] } documents no primeiro documento de uma partição.

Para obter mais informações, consulte o exemplo de dados ausentes mais adiante neste tópico.

Exemplos

Usar no estágio `$group`

Crie a coleção sales:

db.sales.insertMany( [
   { "_id" : 1, "item" : "abc", "price" : 10, "quantity" : 2, "date" : ISODate("2014-01-01T08:00:00Z") },
   { "_id" : 2, "item" : "jkl", "price" : 20, "quantity" : 1, "date" : ISODate("2014-02-03T09:00:00Z") },
   { "_id" : 3, "item" : "xyz", "price" : 5, "quantity" : 5, "date" : ISODate("2014-02-03T09:05:00Z") },
   { "_id" : 4, "item" : "abc", "price" : 10, "quantity" : 10, "date" : ISODate("2014-02-15T08:00:00Z") },
   { "_id" : 5, "item" : "xyz", "price" : 5, "quantity" : 10, "date" : ISODate("2014-02-15T09:05:00Z") },
   { "_id" : 6, "item" : "xyz", "price" : 5, "quantity" : 5, "date" : ISODate("2014-02-15T12:05:10Z") },
   { "_id" : 7, "item" : "xyz", "price" : 5, "quantity" : 10, "date" : ISODate("2014-02-15T14:12:12Z") }
] )

Agrupando os documentos pelo campo item, a operação a seguir usa o acumulador de $first para retornar a primeira data de venda para cada item:

db.sales.aggregate(
   [
     { $sort: { item: 1, date: 1 } },
     {
       $group:
         {
           _id: "$item",
           firstSale: { $first: "$date" }
         }
     }
   ]
)

A operação retorna os seguintes resultados:

[
   { _id: 'jkl', firstSale: ISODate("2014-02-03T09:00:00.000Z") },
   { _id: 'xyz', firstSale: ISODate("2014-02-03T09:05:00.000Z") },
   { _id: 'abc', firstSale: ISODate("2014-01-01T08:00:00.000Z") }
]

Dados em falta

Alguns documentos na coleção badData não têm campos, outros documentos não têm valores.

Crie a coleção badData:

db.badData.insertMany( [
   { "_id": 1, "price": 6, "quantity": 6 },
   { "_id": 2, "item": "album", "price": 5 , "quantity": 5  },
   { "_id": 7, "item": "tape", "price": 6, "quantity": 6 },
   { "_id": 8, "price": 5, "quantity": 5  },
   { "_id": 9, "item": "album", "price": 3, "quantity": '' },
   { "_id": 10, "item": "tape", "price": 3, "quantity":  4 },
   { "_id": 12, "item": "cd", "price": 7  }
] )

Consulte a coleção badData, agrupando a saída no campo item:

db.badData.aggregate( [
   { $sort: { item: 1, price: 1 } },
   { $group:
      {
         _id: "$item",
         inStock: { $first: "$quantity" }
      }
   }
] )

O estágio $sort ordena os documentos e os passa para o estágio $group.

[
  { _id: null, inStock: 5 },
  { _id: 'album', inStock: '' },
  { _id: 'cd', inStock: null },
  { _id: 'tape', inStock: 4 }
]

$first seleciona o primeiro documento de cada grupo de saída:

O grupo _id: null está incluído.
Quando o campo acumulador, $quantity neste exemplo, está ausente, $first retorna null.

Usar no estágio `$setWindowFields`

Novidades na versão 5.0.

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 usa $first no estágio $setWindowFields para gerar a primeira type de ordem de venda de bolo para cada state:

db.cakeSales.aggregate( [
   {
      $setWindowFields: {
         partitionBy: "$state",
         sortBy: { orderDate: 1 },
         output: {
            firstOrderTypeForState: {
               $first: "$type",
               window: {
                  documents: [ "unbounded", "current" ]
               }
            }
         }
      }
   }
] )

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 firstOrderTypeForState para o primeiro pedido type a partir da janela documents.
O window contém documentos entre um limite inferior unbounded e o documento current na saída. Isso significa que $first retorna o primeiro pedido type para os documentos entre o início da partição e o documento atual.

Nessa saída, o valor type da primeira ordem para CA e WA é mostrado no campo firstOrderTypeForState:

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

Voltar

$filter

$firstN