$filter (agregação)

Esta versão da documentação foi arquivada e não é mais suportada. Para atualizar seu sistema do 5.0, consulte osprocedimentos de atualização do MongoDB 6.0 .

Definição

$filter: Novo na versão 3.2.
Seleciona um subconjunto de uma matriz para retornar com base na condição especificada. Retorna uma matriz com somente os elementos que correspondem à condição. Os elementos devolvidos estão na ordem original.

Compatibilidade

Você pode utilizar o $filter para implantações hospedadas nos seguintes ambientes:

MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Sintaxe

$filter tem a seguinte sintaxe:

{
    $filter:
      {
         input: <array>,
         cond: <expression>,
         as: <string>,
         limit: <number expression>
      }
}

Campo	Especificação
`input`	Uma expressão que se torna uma array. Se `input` resolver para `null` ou se referir a um campo ausente, `$filter` retornará `null`. Se `input` resolver para um valor que não seja da array e não seja nulo, o pipeline será executado.
`cond`	Uma expressão que se torna um valor booleano utilizado para determinar se um elemento deve ser incluído na array de saída. A expressão referencia cada elemento da array `input` individualmente com o nome da variável especificado em `as`.
`as`	Opcional. Um nome para a variável que representa cada elemento individual da array `input`. Se nenhum nome for especificado, o nome da variável padrão será `this`.
`limit`	Opcional. Uma expressão numérica que restringe o número de elementos de array correspondentes que `$filter` retorna. Não é possível especificar um limite inferior a `1`. Os elementos da array correspondentes são retornados na ordem em que aparecem na array de entrada. Se o especificado `limit` for maior que o número de elementos correspondentes da array, retornará todos os elementos correspondentes da`$filter` array. Se o limite `null` for, retornará todos os elementos da array`$filter` correspondentes.

Para mais informações sobre expressões, consulte Expressões.

Comportamento

Exemplo

Resultados

{
  $filter: {
     input: [ 1, "a", 2, null, 3.1, NumberLong(4), "5" ],
     as: "num",
     cond: { $and: [
        { $gte: [ "$$num", NumberLong("-9223372036854775807") ] },
        { $lte: [ "$$num", NumberLong("9223372036854775807") ] }
      ] }
  }
}

[ 1, 2, 3.1, NumberLong(4) ]

Exemplo

Uma coleção sales possui os seguintes documentos:

{
   _id: 0,
   items: [
     { item_id: 43, quantity: 2, price: 10 },
     { item_id: 2, quantity: 1, price: 240 }
   ]
}
{
   _id: 1,
   items: [
     { item_id: 23, quantity: 3, price: 110 },
     { item_id: 103, quantity: 4, price: 5 },
     { item_id: 38, quantity: 1, price: 300 }
   ]
}
{
    _id: 2,
    items: [
       { item_id: 4, quantity: 1, price: 23 }
    ]
}

O exemplo a seguir filtra a array items para incluir somente documentos que tenham um price maior ou igual a 100:

db.sales.aggregate([
   {
      $project: {
         items: {
            $filter: {
               input: "$items",
               as: "item",
               cond: { $gte: [ "$$item.price", 100 ] }
            }
         }
      }
   }
])

A operação produz os seguintes resultados:

{
   "_id" : 0,
   "items" : [
      { "item_id" : 2, "quantity" : 1, "price" : 240 }
   ]
}
{
   "_id" : 1,
   "items" : [
      { "item_id" : 23, "quantity" : 3, "price" : 110 },
      { "item_id" : 38, "quantity" : 1, "price" : 300 }
   ]
}
{ "_id" : 2, "items" : [ ] }

Voltar

$expMovingAvg

$first