$slice (agregação)

Definição

$slice

Retorna um subconjunto de uma array.

$slice tem um dos dois formatos de sintaxe:

A seguinte sintaxe retorna elementos a partir do início ou final da array:

{ $slice: [ <array>, <n> ] }

A seguinte sintaxe retorna elementos da posição especificada na array:

{ $slice: [ <array>, <position>, <n> ] }

Operando	Descrição
<array>	Qualquer expressão válida, desde que atrelada a uma array.
<position>	Opcional. Qualquer expressão válida, desde que resolva para um número inteiro. Se positivo, $slice determina a posição inicial desde o início da array. Se <position> for maior que o número de elementos, $slice retornará uma array vazia. Se negativo, $slice determina a posição inicial a partir do final da array. Se o valor absoluto do <position> for maior que o número de elementos, a posição inicial é o início da array.
<n>	Qualquer expressão válida, desde que resolva para um número inteiro. Se <position> for especificado, <n> deverá ser resolvido para um número inteiro positivo. Se positivo, $slice retorna até os primeiros n elementos da array. Se <position> for especificado, $slice retorna os primeiros n elementos a partir da posição. Se negativo, $slice retorna até os últimos n elementos na array. n não pode resolver para um número negativo se <position> for especificado.

Para mais informações sobre expressões, consulte Operadores de Expressão.

Comportamento

{ $slice: [ [ 1, 2, 3 ], 1, 1 ] }

[ 2 ]

{ $slice: [ [ 1, 2, 3 ], -2 ] }

[ 2, 3 ]

{ $slice: [ [ 1, 2, 3 ], 15, 2 ] }

[  ]

{ $slice: [ [ 1, 2, 3 ], -15, 2 ] }

[ 1, 2 ]

Exemplo

Uma coleção chamada users contém os seguintes documentos:

{ "_id" : 1, "name" : "dave123", favorites: [ "chocolate", "cake", "butter", "apples" ] }
{ "_id" : 2, "name" : "li", favorites: [ "apples", "pudding", "pie" ] }
{ "_id" : 3, "name" : "ahn", favorites: [ "pears", "pecans", "chocolate", "cherries" ] }
{ "_id" : 4, "name" : "ty", favorites: [ "ice cream" ] }

O exemplo seguinte retorna, no máximo, os três primeiros elementos na array favorites para cada usuário:

db.users.aggregate([
   { $project: { name: 1, threeFavorites: { $slice: [ "$favorites", 3 ] } } }
])

A operação retorna os seguintes resultados:

{ "_id" : 1, "name" : "dave123", "threeFavorites" : [ "chocolate", "cake", "butter" ] }
{ "_id" : 2, "name" : "li", "threeFavorites" : [ "apples", "pudding", "pie" ] }
{ "_id" : 3, "name" : "ahn", "threeFavorites" : [ "pears", "pecans", "chocolate" ] }
{ "_id" : 4, "name" : "ty", "threeFavorites" : [ "ice cream" ] }