V MongoDB, $filter operátor agregačního kanálu vrací podmnožinu pole na základě zadané podmínky.
$filter operátor vrátí pole pouze s těmi prvky, které odpovídají podmínce, v jejich původním pořadí.
Syntaxe
Syntaxe vypadá takto:
{ $filter: { input: <array>, as: <string>, cond: <expression> } } Každé pole je vysvětleno níže.
| Pole | Specifikace |
|---|---|
input | Výraz, který se překládá na pole. |
as | Toto je volitelné pole. Určuje název proměnné , která představuje každý jednotlivý prvek input pole. Pokud není zadán žádný název (tj. pokud toto pole vynecháte), výchozí název proměnné bude this . |
cond | Výraz, který se převádí na booleovskou hodnotu používanou k určení, zda má být prvek zahrnut do výstupního pole. Výraz odkazuje na každý prvek input pole jednotlivě s názvem proměnné zadaným v as . |
Příklad
Předpokládejme, že máme kolekci nazvanou players s následujícími dokumenty
{ "_id" : 1, "player" : "Homer", "scores" : [ 1, 5, 3 ] }
{ "_id" : 2, "player" : "Marge", "scores" : [ 8, 17, 18 ] }
{ "_id" : 3, "player" : "Bart", "scores" : [ 15, 11, 8 ] }
Zde je příklad použití $filter operátor pro filtrování prvků pole v scores pole:
db.players.aggregate([
{
$match: { _id: { $in: [ 1, 2, 3 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
as: "score",
cond: { $gt: [ "$$score", 10 ] }
}
}
}
}
]) Výsledek:
{ "_id" : 1, "highScores" : [ ] }
{ "_id" : 2, "highScores" : [ 17, 18 ] }
{ "_id" : 3, "highScores" : [ 15, 11 ] } V tomto příkladu jsme filtrovali pole pouze na ty prvky, které mají hodnotu větší než 10. Vrátí se pouze tyto hodnoty.
Jakékoli hodnoty, které jsou menší než 10, jsou z výsledku vynechány. V případě prvního dokumentu to má za následek prázdné pole.
Zde jsme použili as pole pro název návratové proměnné scores . Poté jsme na tuto proměnnou odkazovali v cond pole pomocí $$score . Jak již bylo zmíněno, můžete vynechat as a poté se podívejte na návratovou proměnnou pomocí $$this . Více o tom později.
Prázdná pole
Pokud je pole prázdné, vrátí se prázdné pole.
Předpokládejme, že máme ve sbírce následující dokument:
{ "_id" : 4, "player" : "Farnsworth", "scores" : [ ] }
Zde je to, co se stane, když použijeme $filter do tohoto pole:
db.players.aggregate([
{
$match: { _id: { $in: [ 4 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
as: "score",
cond: { $gt: [ "$$score", 10 ] }
}
}
}
}
]) Výsledek:
{ "_id" : 4, "highScores" : [ ] } Špatný typ
Používá se $filter do pole, které neobsahuje pole, vrátí chybu.
Příklad:
db.players.aggregate([
{
$match: { _id: { $in: [ 4 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$player",
as: "player",
cond: { $gt: [ "$$player", 10 ] }
}
}
}
}
]) Výsledek:
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 Nulové hodnoty
Pokud pole obsahuje null místo pole je výsledkem null .
Představte si, že máme ve sbírce následující dokument:
{ "_id" : 5, "player" : "Meg", "scores" : null }
Zde je to, co se stane, když použijeme $filter do scores pole:
db.players.aggregate([
{
$match: { _id: { $in: [ 5 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
as: "score",
cond: { $gt: [ "$$score", 10 ] }
}
}
}
}
]) Výsledek:
{ "_id" : 5, "highScores" : null } Neexistující pole
Používá se $filter do pole, které neexistuje, má za následek null se vrací.
Příklad:
db.players.aggregate([
{
$match: { _id: { $in: [ 5 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$name",
as: "name",
cond: { $gt: [ "$$name", 10 ] }
}
}
}
}
]) Výsledek:
{ "_id" : 5, "highScores" : null } Název proměnné je volitelný
V předchozích příkladech používám as pole pro přiřazení názvu proměnné.
Jak již bylo zmíněno, as pole je volitelné. Pokud toto pole vynecháte, výchozí název proměnné bude this .
Zde je příklad:
db.players.aggregate([
{
$match: { _id: { $in: [ 1, 2, 3 ] } }
},
{
$project: {
highScores: {
$filter: {
input: "$scores",
cond: { $gt: [ "$$this", 10 ] }
}
}
}
}
])
Výsledek:
{ "_id" : 1, "highScores" : [ ] }
{ "_id" : 2, "highScores" : [ 17, 18 ] }
{ "_id" : 3, "highScores" : [ 15, 11 ] }
To je stejné jako v prvním příkladu, s tím rozdílem, že v tomto příkladu vynecháme as pole, a proto odkazujte na proměnnou pomocí $$this .