インデックスの作成

前提条件

このガイドのコード例を実行するには、プログラムに次のインポート ステートメントを含める必要があります。

import org.mongodb.scala._
import org.mongodb.Indexes
import org.mongodb.IndexOptions
import org.mongodb.Filters

MongoDB 配置への接続

まず、MongoDB 配置に接続し、 インスタンスとMongoDatabase MongoCollectionインスタンスを 宣言して定義します。

次のコードは、ポート27017のlocalhostで実行されているスタンドアロンの MongoDB 配置に接続します。 次に、 testデータベースを参照するためのdatabase変数と、 restaurantsコレクションを参照するためのcollection変数を定義します。

val mongoClient: MongoClient = MongoClient()
val database: MongoDatabase = mongoClient.getDatabase("test")
val collection: MongoCollection[Document] = database.getCollection("restaurants")

MongoDB 配置への接続の詳細については、「 MongoDB への接続」チュートリアルを参照してください。

昇順インデックス

昇順インデックスの仕様を作成するには、 Indexes.ascending()静的ヘルパー メソッドを使用します。

collection.createIndex(Indexes.ascending("name"))
          .printResults()

collection.createIndex(Indexes.ascending("stars", "name"))
          .printResults()

降順インデックス

降順インデックスの仕様を作成するには、 Indexes.descending()静的ヘルパー メソッドを使用します。

collection.createIndex(Indexes.descending("stars"))
          .printResults()

collection.createIndex(Indexes.descending("stars", "name"))
          .printResults()

複合インデックス

複合インデックスの仕様を作成するには、 Indexes.compoundIndex()静的ヘルパー メソッドを使用します。

次の例では、 starsフィールドでは降順で、 nameフィールドでは昇順で複合インデックスが作成されます。

collection.createIndex(
              Indexes.compoundIndex(Indexes.descending("stars"),
                                    Indexes.ascending("name")))
          .printResults()

Text Indexes

MongoDB は、string コンテンツのテキスト クエリをサポートするために インデックス を提供します。テキストインデックスには、値が string または複数の string 配列である任意のフィールドを含めることができます。テキストインデックスの仕様を作成するには、Indexes.text()ヘルパーメソッドを使用します。

次の例では、 nameフィールドに テキスト インデックスを作成しています。

collection.createIndex(Indexes.text("name"))
          .printResults()

テキスト インデックスの詳細については、サーバー マニュアルの「テキストインデックス 」を参照してください。

ハッシュされたインデックス

ハッシュ インデックス インデックスの仕様を作成するには、 Indexes.hashed()静的ヘルパー メソッドを使用します。

次の例では、 _idフィールドに ハッシュされたインデックスを作成しています。

collection.createIndex(Indexes.hashed("_id"))
          .printResults()

ハッシュインデックスの詳細については、サーバー マニュアルの「 ハッシュされたインデックス 」を参照してください。

地理空間インデックス

地理空間クエリをサポートするために、MongoDB はさまざまな地理空間インデックスをサポートしています。 地理空間インデックスの詳細については、サーバー マニュアルの「地理空間インデックス 」を参照してください。

collection.createIndex(Indexes.geo2dsphere("contact.location"))
          .printResults()

インデックス オプション

インデックス仕様ドキュメントに加えて、 createIndex()メソッドは、一意のインデックスまたは部分インデックスを作成するようにドライバーに指示するインデックス オプション ドキュメントを受け入れることができます。

ドライバーはさまざまなインデックス オプションを指定するためのIndexOptionsクラスを提供します。

次のインポート ステートメントをコードに追加して、 IndexOptionsインスタンスを作成します。

import org.mongodb.scala.model.IndexOptions

val indexOptions = IndexOptions().unique(true)
collection.createIndex(Indexes.ascending("name", "stars"), indexOptions)
          .printResults()

val partialFilterIndexOptions = IndexOptions()
             .partialFilterExpression(Filters.exists("contact.email"))
collection.createIndex(
                Indexes.descending("name", "stars"), partialFilterIndexOptions)
          .printResults()

コレクションのインデックスのリストの取得

インデックスのリストを取得するには、 listIndexes()メソッドを使用します。 次のコードを使用することで、 コレクションのインデックスが一覧表示されます。

collection.listIndexes().printResults()

その他のインデックス オプションの詳細については、サーバー マニュアルの「インデックス プロパティ」を参照してください。