Atlas Search 索引

在此页面上

Overview

创建搜索索引
搜索索引列表
更新搜索索引
删除搜索索引
更多信息

Overview

MongoDB Atlas Search 功能使您能够对 Atlas 上托管的集合执行全文搜索。在执行 Atlas Search 查询之前，您必须创建索引，指定要为哪些字段编制索引以及如何为它们编制索引。

要了解有关 Atlas Search 的更多信息，请参阅 Atlas Search 概述。

您可以在 MongoDB\Collection 实例上使用以下方法来管理 Atlas Search 索引：

MongoDB\Collection::createSearchIndex()
MongoDB\Collection::createSearchIndexes()
MongoDB\Collection::listSearchIndexes()
MongoDB\Collection::updateSearchIndex()
MongoDB\Collection::dropSearchIndex()

注意

Atlas Search索引管理是异步的

MongoDB PHP库异步管理Atlas Search索引。以下部分中描述的库方法会立即返回服务器响应，但对搜索索引的更改会在背景进行，可能要稍后一段时间才能完成。

以下各节将提供代码示例，演示如何使用每种 Atlas Search 索引管理方法。

创建搜索索引

您可以使用 createSearchIndex() 方法在集合上创建单个 Atlas Search 索引，也可以使用 createSearchIndexes() 方法同时创建多个索引。

以下代码示例展示了如何创建单个 Atlas Search 索引：

$indexName = $collection->createSearchIndex(
    ['mappings' => ['dynamic' => true]],
    ['name' => 'mySearchIdx']
);

以下代码示例展示了如何创建多个 Atlas Search 索引：

$indexNames = $collection->createSearchIndexes(
    [
        [
            'name' => 'SearchIdx_dynamic',
            'definition' => ['mappings' => ['dynamic' => true]],
        ],
        [
            'name' => 'SearchIdx_simple',
            'definition' => [
                'mappings' => [
                    'dynamic' => false,
                    'fields' => [
                        'title' => [
                            'type' => 'string',
                            'analyzer' => 'lucene.simple'
                        ]
                    ]
                ]
            ],
        ],
    ]
);

创建搜索索引后，您可以对集合执行 Atlas Search 查询。要了解更多信息，请参阅 Atlas 文档中的创建和运行 Atlas 搜索查询。

搜索索引列表

您可以使用 listSearchIndexes() 方法返回集合上的 Atlas Search 索引数组：

foreach ($collection->listSearchIndexes() as $indexInfo) {
    echo json_encode($indexInfo), PHP_EOL;
}

更新搜索索引

您可以使用 updateSearchIndex() 方法更新 Atlas Search 索引。您可以使用此方法更改搜索索引的名称或更改索引的配置。

以下代码展示了如何更新搜索索引，以对 title 字段使用简单分析器：

$collection->updateSearchIndex(
    'mySearchIdx',
    ['mappings' => [
        'dynamic' => false,
        'fields' => [
            'title' => [
                'type' => 'string',
                'analyzer' => 'lucene.simple'
            ]
        ]
    ]]
);

删除搜索索引

您可以使用 dropSearchIndex() 方法从集合中删除 Atlas Search 索引。

以下代码显示如何删除名为 mySearchIdx 的 Atlas Search 索引：

$collection->dropSearchIndex('mySearchIdx');