インデックスの作成

サンプル データ

このガイドの例では、nutritionフィールドの値として埋め込み Nutrition モデルを含む Recipe モデルを使用します。 これらのモデル クラスには、次の定義があります。

from django.db import models
from django.db.models import Q, F
from django_mongodb_backend.models import EmbeddedModel
from django_mongodb_backend.fields import EmbeddedModelField, ArrayField
from django_mongodb_backend.indexes import SearchIndex, VectorSearchIndex
class Nutrition(EmbeddedModel):
    calories = models.IntegerField(default=0)
    carb_grams = models.IntegerField(default=0)
    protein_grams = models.IntegerField(default=0)
class Recipe(models.Model):
    title = models.CharField(max_length=200)
    cuisine = models.CharField(max_length=200)
    cook_time = models.IntegerField(default=0)
    allergens = ArrayField(models.CharField(max_length=100), null=True, blank=True)
    ratings = ArrayField(models.IntegerField(default=0), size=10)
    nutrition = EmbeddedModelField(Nutrition, null=True, blank=True)
    class Meta:
        db_table = "recipes"
    def __str__(self):
        return self.title

Recipe モデルの Metaクラスでは、db_table = "recipes" オプションは、Recipe モデルを recipes と呼ばれるMongoDBコレクションにマッピングするように Diango MongoDBバックエンドに指示します。モデルを使用してMongoDBコレクションを操作する Djangoアプリケーションを作成する方法については、「を使い始める」チュートリアルをご覧ください。

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

単一フィールドインデックスは、コレクション内の単一フィールドからの情報を保存します。 デフォルトでは 、すべてのMongoDBコレクションには _idフィールドのインデックスがあります。

次の例では、 Recipe モデルの Metaクラスを更新して titleフィールドに単一のフィールドインデックスを作成します。これによりMongoDBバックエンドは recipesコレクションに作成します。

class Meta:
    db_table = "recipes"
    indexes = [
        models.Index(fields=["title"], name="title_idx"),
    ]

あるいは、次のコードに示すように、モデルの titleフィールドに db_index オプションを設定して、インデックスを作成することもできます。

class Recipe(models.Model):
    title = models.CharField(max_length=200, db_index=True)

複合インデックス

複合インデックスは、コレクション内の複数のフィールドからデータを収集してソートします。 MongoDB は、インデックスで指定された最初のフィールドごとにデータをグループ化し、その後は後続のフィールドごとにデータをグループ化します。

次の例では、 Recipe モデルの Metaクラスを更新して title フィールドと cook_time フィールドに複合インデックスを作成します。これによりMongoDBバックエンドは recipesコレクションに作成します。

class Meta:
    db_table = "recipes"
    indexes = [
        models.Index(fields=["title", "cook_time"]),
    ]

Multikey Index

マルチキー インデックスは、配列フィールドからデータを収集してソートします。 配列フィールドにインデックスを作成すると、 MongoDB は自動的にそのインデックスをマルチキーインデックスとして設定します。

次の例では、 Recipe モデルの Metaクラスを更新して allergens 配列フィールドに複合インデックスを作成します。これによりMongoDBバックエンドは recipesコレクションに作成します。

class Meta:
    db_table = "recipes"
    indexes = [
        models.Index(fields=["allergens"], name="allergy_idx"),
    ]

埋め込みドキュメントインデックス

埋め込みモデル値を保存するフィールドにインデックスを作成できます。埋め込みドキュメントとしてMongoDB は埋め込みドキュメントとして表現します。

次の例では、 Recipe モデルの Metaクラスを更新して nutrition 埋め込みモデルフィールドにインデックスを作成します。このMongoDBは recipesコレクションに作成されます。

class Meta:
    db_table = "recipes"
    indexes = [
        models.Index(fields=["nutrition"]),
    ]

検索インデックス

MongoDB 検索インデックスは、MongoDB コレクションに対する全文検索である MongoDB 検索クエリの動作を指定します。

検索インデックスを作成するには、モデルの Metaクラスの indexes オプションを SearchIndexオブジェクトに割り当てます。次の引数を任意の順序で SearchIndex() コンストラクターに渡します。

• fields:インデックスを作成するフィールド。

• name: （任意） 検索インデックスの名前。この引数を指定しない場合、Diango はインデックス名を自動的に生成します。

Django MongoDBバックエンド v5.2.2 以降、次の引数を SearchIndex() に渡すこともできます。

• field_mappings: （任意）フィールド名をインデックスオプションにマッピングする辞書。fields の代わりにこの引数を使用して、個々のフィールドに対してインデックス動作を指定する複雑な検索インデックスを作成できます。

• analyzer: （任意） インデックスの作成中に string フィールドに適用するアナライザ。この引数を指定しない場合、 MongoDB Server はデフォルトで lucene.standard になります。

• search_analyzer: （任意）クエリ テキストに適用するアナライザ。この引数を指定しない場合、その値は analyzer 値と同じになります。両方の引数を省略すると、 MongoDB Server はデフォルトで lucene.standard になります。

class Meta:
    db_table = "recipes"
    indexes = [
        SearchIndex(
            fields=["title"],
            name="title_search_idx",
        )
    ]

class Meta:
    db_table = "recipes"
    indexes = [
        SearchIndex(
            name="cuisine_search_idx",
            field_mappings={
                "cuisine": {
                    "type": "token"
                }
            },
            analyzer="lucene.simple"
        )
    ]

ベクトル検索インデックス

MongoDB ベクトル検索インデックスを使用すると、キーワード一致ではなく、セマンティック意味に基づいてデータをクエリできます。ベクトル検索を全文検索クエリとAIフレームワークと統合して、ユースケースの範囲をサポートできます。

ベクトル検索インデックスを作成するには、モデルの Metaクラスの indexes オプションを VectorSearchIndexオブジェクトに割り当てます。次の引数を任意の順序で VectorSearchIndex() コンストラクターに渡します。

• name: （任意）ベクトル検索インデックスの名前。この引数を指定しない場合、Diango はインデックス名を自動的に生成します。

• fields:インデックスを作成するフィールド。少なくとも 1 つは、サイズ のある FloatField または IntegerField の値の配列で表されるベクトルフィールドである必要があります。

• similarities: 使用する類似度関数。"cosine"、"dotProduct"、または "euclidean" 類似度関数を使用できます。関数は、単一の string 値または個々のベクトルフィールドに関数を割り当てる値のリストとして指定されます。

次の例では、Recipe モデルの Metaクラスを更新して、ratingsベクトルフィールドと cook_time 数値フィールドに "vector_search_idx" という名前のベクトル検索インデックスを作成します。

class Meta:
    db_table = "recipes"
    indexes = [
        VectorSearchIndex(
            name=["vector_search_idx"],
            fields=["ratings", "cook_time"],
            similarities=["cosine", "euclidean"],
        )
    ]

部分インデックス

部分インデックスでは、コレクション内の指定フィルター条件を満たすドキュメントのみがインデックス、ストレージ使用量とパフォーマンスのコストが削減されます。

部分インデックスを作成するには、condition 引数を models.Index() メソッドに渡します。 条件値をフィルター条件を含む Qオブジェクトに設定します。 condition 引数を使用する場合は、name 引数も models.Index() に渡す必要があります。

次の例では、 Recipe モデルの Metaクラスを更新して cuisineフィールドに部分インデックスを作成し、Diango MongoDBバックエンドに cook_time の値が 30 より小さいドキュメントのみをインデックスに指示します。

class Meta:
    db_table = "recipes"
    indexes = [
        models.Index(fields=["cuisine"],
                     condition=Q(cook_time__lt=30),
                     name="fast_cuisine_idx"),
    ]

Unique Indexes

一意なインデックス により、インデックス フィールドに重複する値が保存されるのを防ぐことができます。 単一のフィールドでは、一意のインデックスにより、指定されたフィールドに値が最大 1 回表示されるようになります。 複数のフィールドでは、一意なインデックス により、インデックスキー値の任意の組み合わせが最大 1 回表示されるようになります。

cuisine = models.CharField(max_length=200, unique=True)

class Meta:
    db_table = "recipes"
    constraints = [
        models.UniqueConstraint(fields=["title", "cuisine"],
                                name="unique_regional_meal"),
    ]