MongoDB\Collection::updateSearchIndex()

在此页面上

1.17 版本中的新增功能。

定义

MongoDB\Collection::updateSearchIndex()

更新collection的 Atlas Search 搜索索引。

function updateSearchIndex(
    string $name,
    array|object $definition,
    array $options = []
): void

此命令只能在托管在 MongoDB Atlas上的部署上运行，并且需要至少 M 10的 Atlas 集群层。本地 Atlas 部署也可用于开发。

$name ：细绳

要更新的索引的名称。

$definition : array|object

描述更新的Atlas Search索引定义的文档。指定的定义会替换Atlas Search索引中先前的定义。有关定义语法的详细信息，请参阅Atlas Search索引定义语法。

$options : array

指定所需选项的数组。

名称	类型	说明
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。

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

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

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

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

后退

updateOne()

来年

watch()