MongoDB $indexOfArray

In MongoDB is de $indexOfArray aggregatiepijplijnoperator zoekt in een array naar een exemplaar van een opgegeven waarde en retourneert de array-index van het eerste exemplaar.

Syntaxis

De syntaxis gaat als volgt:

{ $indexOfArray: [ <array expression>, <search expression>, <start>, <end> ] }

Waar:

• <array expression> is de array om te zoeken.
• <search expression> is de waarde die u in de array wilt vinden.
• <start> is een optioneel argument dat een startpunt specificeert waarnaar in de array moet worden gezocht. Kan elke geldige uitdrukking zijn die oplost in een niet-negatief geheel getal.
• <end> is een optioneel argument dat een eindindexpositie voor de zoekopdracht specificeert. Kan elke geldige uitdrukking zijn die oplost in een niet-negatief geheel getal.

In MongoDB zijn arrays op nul gebaseerd, dus de indextelling begint bij nul (0 ).

Als de opgegeven waarde niet wordt gevonden, $indexOfArray retourneert -1 .

Als er meerdere exemplaren van de opgegeven waarde zijn, wordt alleen de eerste geretourneerd.

Voorbeeld

Stel dat we een verzameling hebben met de naam products met de volgende documenten:

{ "_id" : 1, "prod" : "Bat", "sizes" : [ "XS", "M", "L" ] }
{ "_id" : 2, "prod" : "Hat", "sizes" : [ "XS", "S", "L", "XL" ] }
{ "_id" : 3, "prod" : "Cap", "sizes" : [ "XXS", "XS", "M", "XL" ] }
{ "_id" : 4, "prod" : "Zap", "sizes" : [ 10, 12, 15 ] }
{ "_id" : 5, "prod" : "Tap", "sizes" : [ 15, 16, 20 ] }

Hier is een voorbeeld van het toepassen van $indexOfArray naar die documenten:

db.products.aggregate(
   [
     { $match: { _id: { $in: [ 1, 2, 3, 4, 5 ] } } },
     {
       $project:
          {
            _id: 0,
            sizes: 1,
            result: { $indexOfArray: [ "$sizes", "XS" ] }
          }
     }
   ]
)

Resultaat:

{ "sizes" : [ "XS", "M", "L" ], "result" : 0 }
{ "sizes" : [ "XS", "S", "L", "XL" ], "result" : 0 }
{ "sizes" : [ "XXS", "XS", "M", "XL" ], "result" : 1 }
{ "sizes" : [ 10, 12, 15 ], "result" : -1 }
{ "sizes" : [ 15, 16, 20 ], "result" : -1 }

In de eerste twee documenten werd de zoekwaarde gevonden op positie 0 (arrays zijn gebaseerd op nul).

In het derde document werd het gevonden op positie 1 . Merk op dat de zoekopdracht was voor een exacte overeenkomst. Het keerde niet terug naar positie 0 , ook al is de waarde op positie 0 bevat de zoekwaarde (d.w.z. XXS bevat XS ).

De zoekwaarde werd niet gevonden in de laatste twee documenten, en dus -1 is teruggestuurd.

Hier is nog een voorbeeld, maar deze keer zoeken we naar een numerieke waarde:

db.products.aggregate(
   [
     { $match: { _id: { $in: [ 1, 2, 3, 4, 5 ] } } },
     {
       $project:
          {
            _id: 0,
            sizes: 1,
            result: { $indexOfArray: [ "$sizes", 15 ] }
          }
     }
   ]
)

Resultaat:

{ "sizes" : [ "XS", "M", "L" ], "result" : -1 }
{ "sizes" : [ "XS", "S", "L", "XL" ], "result" : -1 }
{ "sizes" : [ "XXS", "XS", "M", "XL" ], "result" : -1 }
{ "sizes" : [ 10, 12, 15 ], "result" : 2 }
{ "sizes" : [ 15, 16, 20 ], "result" : 0 }

Geef een startpositie op

U kunt een derde argument opgeven om een ​​startindexpositie voor de zoekopdracht op te geven.

Voorbeeld:

db.products.aggregate(
   [
     { $match: { _id: { $in: [ 4, 5 ] } } },
     {
       $project:
          {
            _id: 0,
            sizes: 1,
            result: { $indexOfArray: [ "$sizes", 15, 1 ] }
          }
     }
   ]
)

Resultaat:

{ "sizes" : [ 10, 12, 15 ], "result" : 2 }
{ "sizes" : [ 15, 16, 20 ], "result" : -1 }

In dit geval is de zoekexpressie niet gevonden in het tweede document (document 5). Dit komt omdat we de zoekopdracht zijn begonnen op positie 1 , en hoewel dat document de zoekexpressie bevat, staat het op positie 0 (vóór de startpositie voor de zoekopdracht).

Geef een eindpositie op

U kunt ook een vierde argument opgeven om de eindindexpositie voor de zoekopdracht te specificeren.

Als u dit argument geeft, moet u ook een startpositie opgeven. Als u dit niet doet, wordt dit argument als het startpunt geïnterpreteerd.

Voorbeeld:

db.products.aggregate(
   [
     { $match: { _id: { $in: [ 1, 2, 3 ] } } },
     {
       $project:
          {
            _id: 0,
            sizes: 1,
            result: { $indexOfArray: [ "$sizes", "XS", 0, 1 ] }
          }
     }
   ]
)

Resultaat:

{ "sizes" : [ "XS", "M", "L" ], "result" : 0 }
{ "sizes" : [ "XS", "S", "L", "XL" ], "result" : 0 }
{ "sizes" : [ "XXS", "XS", "M", "XL" ], "result" : -1 }

Het derde document retourneerde -1 wat betekent dat de zoekexpressie niet is gevonden.

Dit is wat er gebeurt als we de eindindexpositie met 1 verhogen:

db.products.aggregate(
   [
     { $match: { _id: { $in: [ 1, 2, 3 ] } } },
     {
       $project:
          {
            _id: 0,
            sizes: 1,
            result: { $indexOfArray: [ "$sizes", "XS", 0, 2 ] }
          }
     }
   ]
)

Resultaat:

{ "sizes" : [ "XS", "M", "L" ], "result" : 0 }
{ "sizes" : [ "XS", "S", "L", "XL" ], "result" : 0 }
{ "sizes" : [ "XXS", "XS", "M", "XL" ], "result" : 1 }

Deze keer werd de waarde opgenomen en keerde de indexpositie terug.

Lege arrays

Zoeken in een lege array geeft -1 .

db.products.aggregate(
   [
     { $match: { _id: { $in: [ 6 ] } } },
     {
       $project:
          {
            _id: 0,
            sizes: 1,
            result: { $indexOfArray: [ "$sizes", "XS" ] }
          }
     }
   ]
)

Resultaat:

{ "sizes" : [ ], "result" : -1 }

Ontbrekende velden

Als het veld niet in het document staat, $indexOfArray retourneert null .

Stel dat we het volgende document hebben:

{ "_id" : 8, "prod" : "Map" }

Dit is wat er gebeurt als we $indexOfArray toepassen :

db.products.aggregate(
   [
     { $match: { _id: { $in: [ 8 ] } } },
     {
       $project:
          {
            _id: 0,
            sizes: 1,
            result: { $indexOfArray: [ "$sizes", "XS" ] }
          }
     }
   ]
)

Resultaat:

{ "result" : null }

Null-waarden

Als de array-expressie null is (in plaats van een array), $indexOfArray retourneert null .

Stel dat we het volgende document hebben:

{ "_id" : 7, "prod" : "Lap", "sizes" : null }

Dit is wat er gebeurt als we $indexOfArray toepassen :

db.products.aggregate(
   [
     { $match: { _id: { $in: [ 7 ] } } },
     {
       $project:
          {
            _id: 0,
            sizes: 1,
            result: { $indexOfArray: [ "$sizes", "XS" ] }
          }
     }
   ]
)

Resultaat:

{ "sizes" : null, "result" : null }

Wanneer de zoekexpressie echter null . is , het resultaat is -1 , tenzij de array-expressie ook null . is of het veld ontbreekt:

db.products.aggregate(
   [
     { $match: { _id: { $in: [ 1, 2, 3, 4, 5, 6, 7, 8 ] } } },
     {
       $project:
          {
            _id: 0,
            sizes: 1,
            result: { $indexOfArray: [ "$sizes", null ] }
          }
     }
   ]
)

Resultaat:

{ "sizes" : [ "XS", "M", "L" ], "result" : -1 }
{ "sizes" : [ "XS", "S", "L", "XL" ], "result" : -1 }
{ "sizes" : [ "XXS", "XS", "M", "XL" ], "result" : -1 }
{ "sizes" : [ 10, 12, 15 ], "result" : -1 }
{ "sizes" : [ 15, 16, 20 ], "result" : -1 }
{ "sizes" : [ ], "result" : -1 }
{ "sizes" : null, "result" : null }
{ "result" : null }

Onjuist gegevenstype

Als de array-expressie het verkeerde gegevenstype is, $indexOfArray geeft een fout terug.

Stel dat we het volgende document hebben:

{ "_id" : 9, "prod" : "Box", "sizes" : "XXL" }

Dit is wat er gebeurt als we $indexOfArray toepassen naar dat document:

db.products.aggregate(
   [
     { $match: { _id: { $in: [ 9 ] } } },
     {
       $project:
          {
            _id: 0,
            sizes: 1,
            result: { $indexOfArray: [ "$sizes", "XXL" ] }
          }
     }
   ]
)

Resultaat:

uncaught exception: Error: command failed: {
	"ok" : 0,
	"errmsg" : "$indexOfArray requires an array as a first argument, found: string",
	"code" : 40090,
	"codeName" : "Location40090"
} : aggregate failed :
[email protected]/mongo/shell/utils.js:25:13
[email protected]/mongo/shell/assert.js:18:14
[email protected]/mongo/shell/assert.js:639:17
[email protected]/mongo/shell/assert.js:729:16
[email protected]/mongo/shell/db.js:266:5
[email protected]/mongo/shell/collection.js:1058:12
@(shell):1:1

Zoals de foutmelding aangeeft, vereist $indexOfArray requires an array as a first argument .