Atlas Search インデックス

項目一覧

Overview

検索インデックスを作成
検索インデックスをリストする
検索インデックスをアップデートする
検索インデックスを削除する

Overview

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

MongoDB AtlasSearch の詳細については、「Atlas Search インデックス」ドキュメントを参照してください。

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

create_search_index()
create_search_indexes()
list_search_indexes()
update_search_index()
drop_search_index()

注意

Atlas Search インデックスマネジメントのメソッドは非同期で実行されます。ドライバーメソッドは、正常に実行されたことを確認する前に戻ることができます。インデックスの現在のステータスを確認するには、list_search_indexes() メソッドを呼び出します。

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

検索インデックスを作成

create_search_index() および create_search_indexs() Atlas Search インデックスを作成するメソッド。

次のコード例は、単一インデックスを作成する方法を示しています。

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

次のコード例は、複数のインデックスを作成する方法を示しています。

index_one = {
    "definition": {
        "mappings": {
            "dynamic": True
        }
    },
    "name": "my_index",
}
index_two = {
    "definition": {
        "mappings": {
            "dynamic": True
        }
    },
    "name": "my_other_index",
}
indexes = [index_one, index_two]
collection.create_search_indexes(models=indexes)

検索インデックスをリストする

list_search_indexs() を使用できますメソッドを使用して、コレクションの Atlas Search インデックスを返します。

次のコード例は、コレクションの検索インデックスのリストを出力する方法を示しています。

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

検索インデックスをアップデートする

update_search_index() Atlas Search インデックスを更新する方法。

次のコードは、検索インデックスを更新する方法を示しています。

new_index = {
    "definition": {
        "mappings": {
            "dynamic": True
        }
    },
    "name": "my_new_index",
}
collection.update_search_index("my_index", new_index)

検索インデックスを削除する

drop_search_index() を使用できますメソッドを使用して、Atlas Search インデックスを削除します。

次のコードは、コレクションから検索インデックスを削除する方法を示しています。

collection.drop_index("my_index")

戻る

Multikey Indexes

Text Indexes