$firstN
Nesta página
Definição
Novidades na versão 5.2.
$firstN
pode ser usado como acumulador de agregação ou operador de array. Como acumulador de agregação, ele retorna uma agregação dos primeiros n
elementos dentro de um grupo. Como operador de array, ele retorna o número especificado de elementos desde o início de uma array.
Acumulador de agregação
Quando $firstN
é utilizado como acumulador de agregação, os elementos retornados serão significativos somente se estiverem em uma ordem de classificação especificada. Se o grupo tiver menos de n
elementos, $firstN
retornará todos os elementos no grupo.
Sintaxe
Quando usado como acumulador de agregação, $firstN
tem a seguinte sintaxe:
{ $firstN: { input: <expression>, n: <expression> } }
input
especifica o(s) campo(s) do documento para obter os primeirosn
. A entrada pode ser qualquer expressão.n
deve ser uma expressão integral positiva que seja constante ou dependa do valor_id
para$group
. Para obter detalhes, consulte exemplo de chave de grupo.
Comportamento
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 porgameId
. Este exemplo tem apenas umgameId
,G1
.PlayerD
tem uma pontuação ausente ePlayerE
tem um nuloscore
. Esses valores são considerados nulos.O campo
firstFiveScores
é especificado utilizandoinput : "$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.
Restrições
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
.
Exemplos
Considere uma collection gamescores
com os seguintes documentos:
db.gamescores.insertMany([ { playerId: "PlayerA", gameId: "G1", score: 31 }, { playerId: "PlayerB", gameId: "G1", score: 33 }, { playerId: "PlayerC", gameId: "G1", score: 99 }, { playerId: "PlayerD", gameId: "G1", score: 1 }, { playerId: "PlayerA", gameId: "G2", score: 10 }, { playerId: "PlayerB", gameId: "G2", score: 14 }, { playerId: "PlayerC", gameId: "G2", score: 66 }, { playerId: "PlayerD", gameId: "G2", score: 80 } ])
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 únicogameId
. Neste caso,G1
.Utiliza
$group
para agrupar os resultados porgameId
. Neste caso,G1
.Especifica os campos que são entrada para
$firstN
cominput : ["$playerId"," $score"]
.Usa
$firstN
para retornar os três primeiros documentos do jogoG1
comn : 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 porgameId
.Usa
$firstN
para retornar os três primeiros documentos de cada jogo comn: 3
.Especifica os campos que são entrada para
$firstN
cominput : ["$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 porgameId
.Especifica os campos que entram para
$firstN
cominput : "$score"
.Se
gameId
forG2
entãon
é 1, caso contrárion
é 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 ] } ]
Operador de array
Sintaxe
Se utilizado como operador de array, $firstN
tem a seguinte sintaxe:
{ $firstN: { n: <expression>, input: <expression> } }
Comportamento
$firstN
retorna elementos na mesma ordem em que aparecem na array de entrada.$firstN
não filtra valoresnull
na array de entrada.Você não pode especificar um valor de
n
menor que1
.Se o
n
especificado for maior ou igual ao número de elementos na arrayinput
,$firstN
retornará a arrayinput
.Se
input
resolver para um valor que não seja da array, a operação de agregação será executada.
Exemplo
A coleção games
possui os seguintes documentos:
db.games.insertMany([ { "playerId" : 1, "score" : [ 1, 2, 3 ] }, { "playerId" : 2, "score" : [ 12, 90, 7, 89, 8 ] }, { "playerId" : 3, "score" : [ null ] }, { "playerId" : 4, "score" : [ ] }, { "playerId" : 5, "score" : [ 1293, null, 3489, 9 ]}, { "playerId" : 6, "score" : [ "12.1", 2, NumberLong("2090845886852"), 23 ]} ])
O exemplo abaixo utiliza o operador $firstN
para recuperar as três primeiras pontuações de cada jogador. As pontuações são retornadas no novo campo firstScores
criado por $addFields
.
db.games.aggregate([ { $addFields: { firstScores: { $firstN: { n: 3, input: "$score" } } } } ])
A operação retorna os seguintes resultados:
[{ "playerId": 1, "score": [ 1, 2, 3 ], "firstScores": [ 1, 2, 3 ] }, { "playerId": 2, "score": [ 12, 90, 7, 89, 8 ], "firstScores": [ 12, 90, 7 ] }, { "playerId": 3, "score": [ null ], "firstScores": [ null ] }, { "playerId": 4, "score": [ ], "firstScores": [ ] }, { "playerId": 5, "score": [ 1293, null, 3489, 9 ], "firstScores": [ 1293, null, 3489 ] }, { "playerId": 6, "score": [ "12.1", 2, NumberLong("2090845886852"), 23 ], "firstScores": [ "12.1", 2, NumberLong("2090845886852") ] }]