文档菜单
文档首页
/ / /
PHP 库手册
/ /

MongoDB\Collection::dropSearchIndex()

在本页

  • 定义
  • 参数
  • 错误/异常
  • 另请参阅

新增在版本1.17.

MongoDB\collection::dropSearchIndex()

删除集合的Atlas Search索引。

function dropSearchIndex(string $name, array $options = []): void

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

$name : string
要删除的索引名称。
$options : array

指定所需选项的数组。

名称
类型
描述
注释
mixed

允许用户指定任意注释以帮助通过数据库分析器当前操作输出和日志追踪操作。

MongoDB\Exception\UnsupportedException 如果使用了不被所选服务器支持的选项(例如 collationreadConcernwriteConcern)。

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

MongoDB\Driver\Exception\RuntimeException 对于扩展级别的其他错误(例如连接错误)。

返回

dropIndexes()