$firstN (operador de expressão )

Valores nulos e ausentes

• $firstN não filtra valores nulos.

• $firstN converte valores ausentes em nulo.

Considere a seguinte aggregation que retorna os cinco primeiros documentos de um grupo:

db.aggregate( [
   {
      $documents: [
         { playerId: "PlayerA", gameId: "G1", score: 1 },
         { playerId: "PlayerB", gameId: "G1", score: 2 },
         { playerId: "PlayerC", gameId: "G1", score: 3 },
         { playerId: "PlayerD", gameId: "G1"},
         { playerId: "PlayerE", gameId: "G1", score: null }
      ]
   },
   {
      $group:
      {
         _id: "$gameId",
         firstFiveScores:
            {
               $firstN:
                  {
                     input: "$score",
                     n: 5
                  }
            }
      }
   }
] )

Neste exemplo:

• $documents cria os documentos literais que contêm as pontuações dos jogadores.

• $group agrupa os documentos por gameId. Este exemplo tem apenas um gameId, G1.

• PlayerD tem uma pontuação ausente e PlayerE tem um nulo score. Esses valores são considerados nulos.

• O campo firstFiveScores é especificado utilizando input : "$score" e retornado como uma array.

• Como não há critérios de classificação, os primeiros 5 campos score são retornados.

[
   {
      _id: 'G1',
      firstFiveScores: [ 1, 2, 3, null, null ]
   }
]

Comparação de $firstN $topN acumuladorese

Os acumuladores $firstN e $topN podem realizar resultados semelhantes.

Em geral:

• Se os documentos que chegam a $group já estiverem ordenados, você deverá usar $firstN.

• Se você estiver classificando e selecionando os n elementos principais, poderá usar $topN para realizar ambas as tarefas com um acumulador.

• $firstN pode ser utilizado como uma expressão de agregação, mas $topN não pode.

Suporte para função de janela e expressão de agregação

$firstN é suportada como uma expressão de agregação.

$firstN é suportado como um window operator.

Encontre as três primeiras pontuações dos jogadores em um único jogo

Você pode usar o acumulador $firstN para encontrar as três primeiras pontuações em um único jogo.

db.gamescores.aggregate( [
   {
      $match : { gameId : "G1" }
   },
   {
      $group:
         {
            _id: "$gameId",
            firstThreeScores:
               {
                  $firstN:
                  {
                     input: ["$playerId", "$score"],
                     n:3
                  }
               }
         }
   }
] )

O exemplo de pipeline:

• Utiliza $match para filtrar os resultados em um único gameId. Neste caso, G1.

• Utiliza $group para agrupar os resultados por gameId. Neste caso, G1.

• Especifica os campos que são entrada para $firstN com input : ["$playerId"," $score"].

• Usa $firstN para retornar os três primeiros documentos do jogo G1 com n : 3.

A operação retorna os seguintes resultados:

[
   {
      _id: 'G1',
      firstThreeScores: [ [ 'PlayerA', 31 ], [ 'PlayerB', 33 ], [ 'PlayerC', 99 ] ]
   }
]

Encontrar as três primeiras pontuações dos jogadores em vários jogos

Você pode usar o acumulador $firstN para encontrar os primeiros n campos de entrada em cada jogo.

db.gamescores.aggregate( [
   {
      $group:
      {
      _id: "$gameId", playerId:
         {
            $firstN:
               {
                  input: [ "$playerId","$score" ],
                  n: 3
               }
         }
      }
   }
] )

O exemplo de pipeline:

• Utiliza $group para agrupar os resultados por gameId.

• Usa $firstN para retornar os três primeiros documentos de cada jogo com n: 3.

• Especifica os campos que são entrada para $firstN com input : ["$playerId", "$score"].

A operação retorna os seguintes resultados:

[
   {
      _id: 'G1',
      playerId: [ [ 'PlayerA', 31 ], [ 'PlayerB', 33 ], [ 'PlayerC', 99 ] ]
   },
   {
      _id: 'G2',
      playerId: [ [ 'PlayerA', 10 ], [ 'PlayerB', 14 ], [ 'PlayerC', 66 ] ]
   }
]

Usando $sort com $firstN

O uso de um estágio $sort anteriormente no pipeline pode influenciar os resultados do acumulador $firstN .

Neste exemplo:

• {$sort : { score : -1 } } classifica as pontuações mais altas para trás de cada grupo.

• firstN retorna as três pontuações mais altas da frente de cada grupo.

db.gamescores.aggregate( [
      { $sort : { score : -1 } },
      {
         $group:
         { _id: "$gameId", playerId:
            {
               $firstN:
                  {
                     input: [ "$playerId","$score" ],
                     n: 3
                  }
            }
         }
      }
   ] )

A operação retorna os seguintes resultados:

[
   {
      _id: 'G2',
      playerId: [ [ 'PlayerD', 80 ], [ 'PlayerC', 66 ], [ 'PlayerB', 14 ] ]
   },
   {
      _id: 'G1',
      playerId: [ [ 'PlayerC', 99 ], [ 'PlayerB', 33 ], [ 'PlayerA', 31 ] ]
   }
]

Cálculo n de com base na chave de grupo para $group

Você também pode atribuir o valor de n dinamicamente. Neste exemplo, a expressão $cond é utilizada no campo gameId .

db.gamescores.aggregate([
   {
      $group:
      {
         _id: {"gameId": "$gameId"},
         gamescores:
            {
               $firstN:
                  {
                     input: "$score",
                     n: { $cond: { if: {$eq: ["$gameId","G2"] }, then: 1, else: 3 } }
                  }
            }
      }
   }
] )

O exemplo de pipeline:

• Utiliza $group para agrupar os resultados por gameId.

• Especifica os campos que entram para $firstN com input : "$score" .

• Se gameId for G2 então n é 1, caso contrário n é 3.

A operação retorna os seguintes resultados:

[
   { _id: { gameId: 'G1' }, gamescores: [ 31, 33, 99 ] },
   { _id: { gameId: 'G2' }, gamescores: [ 10 ] }
]

Utilizando $firstN como expressão de aggregation

Você também pode utilizar $firstN como uma expressão de agregação.

Neste exemplo:

• $documents cria o documento literal que contém uma array de valores.

• $project é usado para retornar a saída de $firstN.

• _id é omitido da saída com _id : 0.

• $firstN utiliza o array de entrada de [10, 20, 30, 40].

• Os três primeiros elementos do array são retornados para o documento de entrada.

db.aggregate( [
   {
      $documents: [
         { array: [10, 20, 30, 40] } ]
   },
   { $project: {
      firstThreeElements:{
                           $firstN:
                           {
                              input: "$array",
                              n: 3
                           }
                        }
               }
   }
] )

A operação retorna os seguintes resultados:

[
   { firstThreeElements: [ 10, 20, 30 ] }
]