No MongoDB, o
$filter operador de pipeline de agregação retorna um subconjunto de uma matriz com base em uma condição especificada. O
$filter O operador retorna uma matriz com apenas os elementos que correspondem à condição, em sua ordem original. Sintaxe
A sintaxe fica assim:
{ $filter: { input: <array>, as: <string>, cond: <expression> } }Cada campo é como explicado abaixo.
| Campo | Especificação |
|---|---|
input | Uma expressão que resolve para uma matriz. |
as | Este é um campo opcional. Ele especifica um nome para a variável que representa cada elemento individual da input variedade. Se nenhum nome for especificado (ou seja, se você omitir este campo), o nome da variável será padronizado para this . |
cond | Uma expressão que resulta em um valor booleano usado para determinar se um elemento deve ser incluído na matriz de saída. A expressão faz referência a cada elemento da input array individualmente com o nome da variável especificado em as . |
Exemplo
Suponha que tenhamos uma coleção chamada
players com os seguintes documentos { "_id" : 1, "player" : "Homer", "scores" : [ 1, 5, 3 ] }
{ "_id" : 2, "player" : "Marge", "scores" : [ 8, 17, 18 ] }
{ "_id" : 3, "player" : "Bart", "scores" : [ 15, 11, 8 ] } Aqui está um exemplo de aplicação do
$filter operador para filtrar os elementos do array nas scores campo:db.players.aggregate([
{
$match: { _id: { $in: [ 1, 2, 3 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
as: "score",
cond: { $gt: [ "$$score", 10 ] }
}
}
}
}
])Resultado:
{ "_id" : 1, "highScores" : [ ] }
{ "_id" : 2, "highScores" : [ 17, 18 ] }
{ "_id" : 3, "highScores" : [ 15, 11 ] } Neste exemplo, filtramos os arrays apenas para os elementos que possuem um valor maior que 10. Somente esses valores são retornados.
Quaisquer valores inferiores a 10 são omitidos do resultado. No caso do primeiro documento, isso resulta em uma matriz vazia.
Aqui, usamos o
as campo para nomear a variável de retorno score . Em seguida, nos referimos a essa variável no cond campo usando $$score . Como mencionado, você pode omitir o as campo e, em seguida, consulte a variável de retorno usando $$this . Mais sobre isso mais tarde. Matrizes vazias
Se a matriz estiver vazia, uma matriz vazia será retornada.
Suponha que temos o seguinte documento em nossa coleção:
{ "_id" : 4, "player" : "Farnsworth", "scores" : [ ] } Veja o que acontece quando aplicamos
$filter para essa matriz:db.players.aggregate([
{
$match: { _id: { $in: [ 4 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
as: "score",
cond: { $gt: [ "$$score", 10 ] }
}
}
}
}
])Resultado:
{ "_id" : 4, "highScores" : [ ] } Tipo errado
Aplicando
$filter para um campo que não contém uma matriz retorna um erro. Exemplo:
db.players.aggregate([
{
$match: { _id: { $in: [ 4 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$player",
as: "player",
cond: { $gt: [ "$$player", 10 ] }
}
}
}
}
])Resultado:
Error: command failed: {
"ok" : 0,
"errmsg" : "input to $filter must be an array not string",
"code" : 28651,
"codeName" : "Location28651"
} : aggregate failed :
example@sqldat.com/mongo/shell/utils.js:25:13
example@sqldat.com/mongo/shell/assert.js:18:14
example@sqldat.com/mongo/shell/assert.js:618:17
example@sqldat.com/mongo/shell/assert.js:708:16
example@sqldat.com/mongo/shell/db.js:266:5
example@sqldat.com/mongo/shell/collection.js:1046:12
@(shell):1:1 Valores nulos
Se o campo contiver
null em vez de uma matriz, o resultado é null . Imagine que temos o seguinte documento na coleção:
{ "_id" : 5, "player" : "Meg", "scores" : null } Veja o que acontece quando aplicamos
$filter para as scores campo:db.players.aggregate([
{
$match: { _id: { $in: [ 5 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
as: "score",
cond: { $gt: [ "$$score", 10 ] }
}
}
}
}
])Resultado:
{ "_id" : 5, "highScores" : null } Campo inexistente
Aplicando
$filter para um campo que não existe resulta em null sendo devolvido. Exemplo:
db.players.aggregate([
{
$match: { _id: { $in: [ 5 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$name",
as: "name",
cond: { $gt: [ "$$name", 10 ] }
}
}
}
}
])Resultado:
{ "_id" : 5, "highScores" : null } O nome da variável é opcional
Nos exemplos anteriores, eu uso o
as campo para atribuir um nome à variável. Como mencionado, o
as campo é opcional. Se você omitir este campo, o nome da variável será padronizado para this . Aqui está um exemplo:
db.players.aggregate([
{
$match: { _id: { $in: [ 1, 2, 3 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
cond: { $gt: [ "$$this", 10 ] }
}
}
}
}
])
Resultado:
{ "_id" : 1, "highScores" : [ ] }
{ "_id" : 2, "highScores" : [ 17, 18 ] }
{ "_id" : 3, "highScores" : [ 15, 11 ] } Este é o mesmo que o primeiro exemplo, exceto que neste exemplo, omitimos o
as campo e, portanto, consulte a variável usando $$this . 
