MongoDB\Collection::createSearchIndex()

定义

MongoDB\Collection::createSearchIndex()

为集合创建MongoDB Search 或MongoDB Vector Search索引。

function createSearchIndex(
    array|object $definition,
    array $options = []
): string

This command can only be run on a deployment hosted on MongoDB Atlas and requires an Atlas cluster tier of at least M10. A Local Atlas Deployment can also be used for development.

参数

$definition : array|object

Document describing the index to create. For details on definition syntax, see Search Index Definition Syntax.

$options : array

指定所需选项的数组。

名称	类型	说明
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。
名称	字符串	要创建的搜索索引的名称。 不能在单个集合上创建多个同名索引。如果未指定名称，则默认索引名称为 default。
类型	字符串	要创建的索引类型。接受的值为 'search' 和 'vectorSearch'。如果省略此选项，则默认值为 'search'，并且该方法会创建MongoDB搜索索引。

Return Values

以string形式表示的已创建MongoDB Search 或 Vector Search索引的名称。

错误/异常

MongoDB\Exception\UnsupportedException，如果所选服务器使用了选项但不支持选项（例如collation、readConcern、writeConcern）。

MongoDB\Exception\InvalidArgumentException 用于与参数或选项解析相关的错误。

MongoDB\ 驱动程序\Exception\RuntimeException 用于扩展级别的其他错误（例如连接错误）。

行为

MongoDB Search 和 Vector Search 搜索索引是异步托管的。创建或更新索引后，您可以定期执行 MongoDB\Collection::listSearchIndexes() 并检查 queryable 输出字段，以确定是否可以使用。

示例

<?php
$collection = (new MongoDB\Client)->selectCollection('test', 'articles');
$indexName = $collection->createSearchIndex(
   ['mappings' => ['dynamic' => true]],
   ['name' => 'test-search-index']
);
var_dump($indexName);

string(17) "test-search-index"

另请参阅

• MongoDB\Collection::createSearchIndexes()

• MongoDB\Collection::dropSearchIndex()

• MongoDB\Collection::listSearchIndexes()

• MongoDB\Collection::updateSearchIndex()

• MongoDB 搜索索引 指南

• createSearchIndexes command reference in the MongoDB manual

• MongoDB Search documentation in the MongoDB Manual