MongoDB\Collection::updateSearchIndex()

本页内容

新增自版本1.17.

定义

MongoDB\Collection::updateSearchIndex()

更新集合的 Atlas Search 索引。

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

此命令只能在托管在 MongoDB Atlas 上的部署上运行MongoDB Atlas 上，并且需要至少 M10 的 Atlas 集群级别。也可以使用本地 Atlas 部署进行开发。

$name : 字符串

要更新的索引名称。

$definition : 数组|对象

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

$options : 数组

指定所需选项的数组。

名称	类型	描述
注释	混合	允许用户指定任意注释以帮助通过数据库分析器、当前操作输出和日志。

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

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

Atlas Search 索引是异步管理的。在创建或更新索引后，您可以定期执行 MongoDB\Collection::listSearchIndexes() 并检查 queryable 输出字段以确定它是否已准备好使用。

updateOne()

watch()