Indexes

操作上の考慮事項

クエリのパフォーマンスを向上させるには、ソートされた結果を返すアプリケーションのクエリや操作で頻繁に表示されるフィールドにインデックスをビルドします。 追加する各インデックスはアクティブな場合にディスク領域とメモリを消費するため、キャパシティー プランニングとしてインデックス メモリとディスク使用量を追跡することをお勧めします。 さらに、書込み操作によってインデックス付きフィールドがアップデートされると、MongoDB は関連するインデックスをアップデートします。

MongoDB は動的スキーマをサポートしているため、アプリケーションは名前が事前に不明であるか、任意のフィールドであるフィールドに対してクエリを実行できます。 MongoDB 4.2では、これらのクエリをサポートするためにワイルドカード インデックスが導入されています。 ワイルドカード インデックスは、ワークロードベースのインデックス プランニングを置き換えるように設計されていません。

データモデルの設計とアプリケーションに適したインデックスの選択の詳細については、 マニュアルの「 データ モデリングとインデックス MongoDB Server」のガイドを参照してください。

サンプル データ

このガイドの例では、 Atlas サンプル データセットのsample_mflix.moviesコレクションを使用します。 MongoDB Atlas クラスターを無料で作成して、サンプル データセットをロードする方法については、 PyMongo を使い始める を参照してください。

単一フィールドと複合インデックス

movies.create_index("title")

query = { "title": "Batman" }
sort = [("title", 1)]
cursor = movies.find(query).sort(sort)

movies.create_index([("type", pymongo.ASCENDING), ("genre", pymongo.ASCENDING)])

query = { "type": "movie", "genre": "Drama" }
sort = [("type", pymongo.ASCENDING), ("genre", pymongo.ASCENDING)]
cursor = movies.find(query).sort(sort)

マルチキー インデックス（配列フィールドへのインデックス）

マルチキー インデックスは、配列値を含むインデックスを持つフィールドを指定するクエリのパフォーマンスを向上させるインデックスです。 単一フィールドまたは複合インデックスと同じ構文を使用して、マルチキー インデックスを定義できます。

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

result = movies.create_index("cast")

以下は、前のコード例で作成されたインデックスを使用するクエリの例です。

query = { "cast": "Viola Davis" }
cursor = movies.find(query)

マルチキー インデックスは、クエリ カバレッジ、インデックスバウンド計算、およびソート動作の点で他のインデックスとは動作が異なります。マルチキー インデックス（動作や制限事項を含む）の詳細については、 MongoDB Serverマニュアルのマルチキー インデックスガイドを参照してください。

Atlas Search と Vector Search インデックス

PyMongo を使用して、 Atlas Search および Atlas Vector Search のインデックスを管理できます。インデックスは、検索の動作とインデックスを作成するフィールドを指定します。

Atlas Search を使用すると、MongoDB Atlas でホストされているコレクションに対して全文検索を実行できます。 Atlas Search インデックスは、検索の動作とインデックスを作成するフィールドを指定します。

Atlas Vector Search を使用すると、MongoDB Atlas に保存されているベクトル埋め込みに対してセマンティック検索を実行できます。 ベクトル検索インデックスは、クエリ対象のベクトル埋め込みと、データを事前フィルタリングするために使用するブール値、日付、ObjectId、数値、string、または UUID 値のインデックスを定義します。

コレクションに対して次のメソッドを呼び出して、Atlas Search インデックスと Vector Search インデックスを管理できます。

• create_search_index()

• create_search_indexes()

• list_search_indexes()

• update_search_index()

• drop_search_index()

次のセクションでは、前述の各メソッドの使用方法を示すコード例を示します。

index = {
    "definition": {
        "mappings": {
            "dynamic": True
        }
    },
    "name": "<index name>",
}
collection.create_search_index(index)

from pymongo.operations import SearchIndexModel
search_index_model = SearchIndexModel(
  definition={
    "fields": [
      {
        "type": "vector",
        "numDimensions": <number of dimensions>,
        "path": "<field to index>",
        "similarity":  "<select from euclidean, cosine, dotProduct>"
      }
    ]
  },
  name="<index name>",
  type="vectorSearch",
)
collection.create_search_index(model=search_index_model)

search_idx = SearchIndexModel(
    definition ={
        "mappings": {
            "dynamic": True
        }
    },
    name="my_index",
)
vector_idx = SearchIndexModel(
  definition={
    "fields": [
      {
        "type": "vector",
        "numDimensions": <number of dimensions>,
        "path": "<field to index>",
        "similarity": "<select from euclidean, cosine, dotProduct>"
      }
    ]
  },
  name="my_vector_index",
  type="vectorSearch",
)
indexes = [search_idx, vector_idx]
collection.create_search_indexes(models=indexes)

results = list(collection.list_search_indexes())
for index in results:
    print(index)

new_index_definition = {
    "mappings": {
        "dynamic": False
    }
}
collection.update_search_index("my_index", new_index)

new_index_definition = {
    "fields": [
        {
            "type": "vector",
            "numDimensions": 1536,
            "path": "<field to index>",
            "similarity": "euclidean"
        },
    ]
}
collection.update_search_index("my_vector_index", new_index_definition)

collection.drop_search_index("my_index")

Text Indexes

テキスト インデックスは、string コンテンツに対するテキスト検索クエリをサポートします。 これらのインデックスには、値が string または複数の string 配列である任意のフィールドを含めることができます。 MongoDB はさまざまな言語のテキスト検索をサポートしています。 インデックスの作成時に、オプションとしてデフォルト言語を指定できます。

movies.create_index(
    [( "plot", "text" )]
)

query = { "$text": { "$search": "a time-traveling DeLorean" } }
cursor = movies.find(query)

result = myColl.create_index(
    [("title", "text"), ("genre", "text")],
    default_language="english",
    weights={ "title": 10, "genre": 3 }
)

地理空間インデックス

MongoDB は、 2 dsphere インデックスを使用した地理空間座標データのクエリをサポートしています。 2dsphereインデックスを使用すると、包含、交差、近接性について地理空間データを照会できます。 地理空間データのクエリの詳細については、「地理空間クエリ 」を参照してください。

2dsphereインデックスを作成するには、 GeoJSON オブジェクトのみを含むフィールドを指定する必要があります。 これについて詳しくは、 マニュアルの「GeoJSON オブジェクト ガイドMongoDB Server 」を参照してください。

sample_mflixデータベース内のtheatersコレクションの次のサンプル ドキュメントのlocation.geoフィールドは、劇場の座標を記述する GeoJSON ポイント オブジェクトです。

{
   "_id" : ObjectId("59a47286cfa9a3a73e51e75c"),
   "theaterId" : 104,
   "location" : {
      "address" : {
         "street1" : "5000 W 147th St",
         "city" : "Hawthorne",
         "state" : "CA",
         "zipcode" : "90250"
      },
      "geo" : {
         "type" : "Point",
         "coordinates" : [
            -118.36559,
            33.897167
         ]
      }
   }
}

theaters.create_index(
    [( "location.geo", "2dsphere" )]
)

Unique Indexes

一意なインデックス により、インデックス フィールドに重複する値が保存されなくなります。 デフォルトでは、MongoDB はコレクションの作成中に_idフィールドに一意のインデックスを作成します。 一意のインデックスを作成するには、次の手順を実行します。

• 重複を防ぐフィールドまたはフィールドの組み合わせを指定します。

• uniqueオプションを ``True`` に設定します。

theaters.create_index("theaterId", unique=True)

ワイルドカード インデックス

ワイルドカード インデックスを使用すると、不明なフィールドや任意のフィールドに対するクエリが可能になります。 動的スキーマを使用している場合は、これらのインデックスが役立ちます。

movies.create_index({ "location.$**": pymongo.ASCENDING })

クラスター化インデックス

クラスター化されたインデックスは、キー値の順にドキュメントを保存するようにコレクションに指示します。 クラスター化インデックスを作成するには、コレクションを作成するときに次の手順を実行します。

• _idフィールドをキーとして クラスター化インデックス オプション を指定します。

• 一意のフィールドをTrueに設定します。

sample_mflix.create_collection("movies", clusteredIndex={
    "key": { "_id": 1 }, 
    "unique": True
})

単一インデックスを排除する

インデックスのインスタンスまたはインデックス名をdrop_index()メソッドに渡して、コレクションからインデックスを削除します。

次の例では、 moviesコレクションから"_title_"という名前のインデックスを削除します。

movies.drop_index("_title_")

すべてのインデックスを削除する

MongoDB 4.2 以降では、コレクションでdrop_indexes()メソッドを呼び出すことで、すべてのインデックスを削除できます。

collection.drop_indexes()

以前のバージョンの MongoDB の場合は、コレクションでdrop_index()を呼び出すパラメータとして"*"を渡します。

collection.drop_index("*")

DuplicateKeyException

一意なインデックスに違反する重複値を保存する書込み操作を実行すると、ドライバーはDuplicateKeyExceptionを発生させ、MongoDB は次のようなエラーを返します。

E11000 duplicate key error index

API ドキュメント

このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。

• create_index()

• create_indexes()

• drop_index()

• drop_indexes()