Docs 菜单

Docs 主页 → 开发应用程序 → Python 驱动程序 → pymongo

Atlas Search 索引

在此页面上

  • Overview
  • 创建搜索索引
  • 搜索索引列表
  • 更新搜索索引
  • 删除搜索索引

Overview

Atlas Search 功能使您能够对 MongoDB Atlas 上托管的集合执行全文搜索。索引指定了搜索行为以及要索引的字段。

要了解有关MongoDB Atlas Atlas Search的更多信息，请参阅 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_indexes() 创建 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_indexes() 方法返回集合的 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 →

在此页面上