В MongoDB, $filter
Операторът на конвейера за агрегиране връща подмножество от масив въз основа на определено условие.
$filter
операторът връща масив само с онези елементи, които отговарят на условието, в първоначалния им ред.
Синтаксис
Синтаксисът е така:
{ $filter: { input: <array>, as: <string>, cond: <expression> } }
Всяко поле е както е обяснено по-долу.
Поле | Спецификация |
---|---|
input | Израз, който се разрешава до масив. |
as | Това е незадължително поле. Той посочва име за променливата която представлява всеки отделен елемент от input масив. Ако не е посочено име (т.е. ако пропуснете това поле), името на променливата по подразбиране е this . |
cond | Израз, който се разрешава до булева стойност, използвана за определяне дали даден елемент трябва да бъде включен в изходния масив. Изразът препраща към всеки елемент от input масив поотделно с името на променливата, посочено в as . |
Пример
Да предположим, че имаме колекция, наречена players
със следните документи
{ "_id" : 1, "player" : "Homer", "scores" : [ 1, 5, 3 ] } { "_id" : 2, "player" : "Marge", "scores" : [ 8, 17, 18 ] } { "_id" : 3, "player" : "Bart", "scores" : [ 15, 11, 8 ] }
Ето пример за прилагане на $filter
оператор за филтриране на елементите на масива в scores
поле:
db.players.aggregate([
{
$match: { _id: { $in: [ 1, 2, 3 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
as: "score",
cond: { $gt: [ "$$score", 10 ] }
}
}
}
}
])
Резултат:
{ "_id" : 1, "highScores" : [ ] } { "_id" : 2, "highScores" : [ 17, 18 ] } { "_id" : 3, "highScores" : [ 15, 11 ] }
В този пример филтрирахме масивите само до онези елементи, които имат стойност по-голяма от 10. Само тези стойности се връщат.
Всички стойности, които са по-малки от 10, се пропускат от резултата. В случай на първия документ това води до празен масив.
Тук използвахме as
поле за име на връщащата променлива score
. След това се позовахме на тази променлива в cond
поле с помощта на $$score
. Както споменахме, можете да пропуснете as
поле и след това се обърнете към връщащата променлива, като използвате $$this
. Повече за това по-късно.
Празни масиви
Ако масивът е празен, тогава се връща празен масив.
Да предположим, че имаме следния документ в нашата колекция:
{ "_id" : 4, "player" : "Farnsworth", "scores" : [ ] }
Ето какво се случва, когато приложим $filter
към този масив:
db.players.aggregate([
{
$match: { _id: { $in: [ 4 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
as: "score",
cond: { $gt: [ "$$score", 10 ] }
}
}
}
}
])
Резултат:
{ "_id" : 4, "highScores" : [ ] }
Грешен тип
Прилагане на $filter
към поле, което не съдържа масив, връща грешка.
Пример:
db.players.aggregate([
{
$match: { _id: { $in: [ 4 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$player",
as: "player",
cond: { $gt: [ "$$player", 10 ] }
}
}
}
}
])
Резултат:
Error: command failed: { "ok" : 0, "errmsg" : "input to $filter must be an array not string", "code" : 28651, "codeName" : "Location28651" } : aggregate failed : [email protected]/mongo/shell/utils.js:25:13 [email protected]/mongo/shell/assert.js:18:14 [email protected]/mongo/shell/assert.js:618:17 [email protected]/mongo/shell/assert.js:708:16 [email protected]/mongo/shell/db.js:266:5 [email protected]/mongo/shell/collection.js:1046:12 @(shell):1:1
Нулеви стойности
Ако полето съдържа null
вместо масив, резултатът е null
.
Представете си, че имаме следния документ в колекцията:
{ "_id" : 5, "player" : "Meg", "scores" : null }
Ето какво се случва, когато приложим $filter
към scores
поле:
db.players.aggregate([
{
$match: { _id: { $in: [ 5 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
as: "score",
cond: { $gt: [ "$$score", 10 ] }
}
}
}
}
])
Резултат:
{ "_id" : 5, "highScores" : null }
Несъществуващо поле
Прилагане на $filter
към поле, което не съществува, води до null
се връща.
Пример:
db.players.aggregate([
{
$match: { _id: { $in: [ 5 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$name",
as: "name",
cond: { $gt: [ "$$name", 10 ] }
}
}
}
}
])
Резултат:
{ "_id" : 5, "highScores" : null }
Името на променливата е по избор
В предишните примери използвам as
поле за присвояване на име на променливата.
Както споменахме, as
полето е по избор. Ако пропуснете това поле, името на променливата по подразбиране е this
.
Ето един пример:
db.players.aggregate([
{
$match: { _id: { $in: [ 1, 2, 3 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
cond: { $gt: [ "$$this", 10 ] }
}
}
}
}
])
Резултат:
{ "_id" : 1, "highScores" : [ ] } { "_id" : 2, "highScores" : [ 17, 18 ] } { "_id" : 3, "highScores" : [ 15, 11 ] }
Това е същото като първия пример, освен че в този пример пропускаме as
поле и следователно се обърнете към променливата с помощта на $$this
.