MongoDBで配列フィールド内の特定要素のインデックスを取得する方法

MongoDBでは、配列フィールド内に格納された特定の要素が何番目に位置しているか（インデックス）を調べたい場面があります。そんなときに便利なのが、集計フレームワークで使える $indexOfArray 演算子です。

この記事では、実際にドキュメントを作成しながら、$indexOfArray の使い方を具体的な例とともに解説します。

サンプルコレクションの作成

まず、insertOne() メソッドを使って、講師情報を含むドキュメントをコレクションに挿入します。

> db.getIndexDemo.insertOne({"InstructorName":"Chris","InstructorSubject":["MongoDB","MySQL","Java","C++"]});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5cbd5251de8cc557214c0df8")
}

次に、find() メソッドを使って、コレクション内のすべてのドキュメントを表示してみましょう。

> db.getIndexDemo.find().pretty();

上記のクエリを実行すると、次のような出力が得られます。

{
   "_id" : ObjectId("5cbd5251de8cc557214c0df8"),
   "InstructorName" : "Chris",
   "InstructorSubject" : [
      "MongoDB",
      "MySQL",
      "Java",
      "C++"
   ]
}

$indexOfArray演算子で要素のインデックスを取得する

配列フィールド内の特定要素のインデックスを取得するには、aggregate() メソッドと $project ステージを組み合わせて $indexOfArray を使用します。

たとえば、「MongoDB」という要素のインデックスを取得するクエリは以下のとおりです。

> db.getIndexDemo.aggregate( [ { "$project": { "matchedIndex": { "$indexOfArray": [ "$InstructorSubject", "MongoDB" ] } } } ] );

実行結果は次のようになります。

{ "_id" : ObjectId("5cbd5251de8cc557214c0df8"), "matchedIndex" : 0 }

「MongoDB」は配列の先頭にあるため、インデックスとして 0 が返されました。

同様に、別の要素「C++」のインデックスを取得してみます。

> db.getIndexDemo.aggregate( [ { "$project": { "matchedIndex": { "$indexOfArray": [ "$InstructorSubject", "C++" ] } } } ] );

実行結果：

{ "_id" : ObjectId("5cbd5251de8cc557214c0df8"), "matchedIndex" : 3 }

「C++」は配列の4番目の要素なので、インデックス 3 が返されています。

注意点：配列のインデックスは0から始まる

多くのプログラミング言語と同様に、MongoDBの配列インデックスも 0から始まります。つまり、配列の最初の要素のインデックスは0であり、最後の要素のインデックスは「n - 1」（nは配列の要素数）となります。

また、$indexOfArray は指定した要素が配列内に存在しない場合、-1 を返します。この仕様を覚えておくと、要素の存在チェックにも活用できて便利です。