MongoDB\Collection::dropIndex()

在本页

定义

参数
返回值
错误/异常
示例
另请参阅

定义

MongoDB\Collection::dropIndex()

从集合中删除索引。

function dropIndex(
    string|MongoDB\Model\IndexInfo $indexName,
    array $options = []
): array|object

参数

$indexName : string|MongoDB\Model\IndexInfo

要删除的索引的名称或模型对象。使用 MongoDB\Collection::listIndexes() 方法查看集合上的现有索引。

$options : array

指定所需选项的数组。

名称	类型	描述
comment	mixed	允许用户指定任意注释以帮助通过数据库分析器数据库分析器、当前操作输出和日志来追踪操作。此选项自MongoDB 4.4版本起可用，如果用于旧版本服务器，则在执行时将引发异常。新在版本1.13.
maxTimeMS	整数	处理游标上操作的累积时间限制（以毫秒为单位）。MongoDB在下一个中断点处终止操作。新在版本1.3.
会话	MongoDB\Driver\Session	与操作关联的客户端会话。新在版本1.3.
typeMap	数组	应用于游标的类型映射，它决定了BSON文档如何转换为PHP值。默认为集合的类型映射。这将用于返回的命令结果文档。
writeConcern	MongoDB\Driver\WriteConcern	用于操作的写入关注点。默认为集合的写入关注点。在事务中不能为单个操作指定写关注。相反，当启动事务时，设置`writeConcern`选项。

返回值

一个包含dropIndexes命令结果文档的数组或对象。返回类型将取决于typeMap选项。

错误/异常

如果选项被使用且所选服务器不支持（例如collation，readConcern，writeConcern），则抛出MongoDB\Exception\UnsupportedException。

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

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

示例

以下示例将 borough_1 索引从 restaurants 集合在 test 数据库中删除

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$result = $collection->dropIndex('borough_1');
var_dump($result);

输出结果将类似于

object(MongoDB\Model\BSONDocument)#9 (1) {
  ["storage":"ArrayObject":private]=>
  array(2) {
    ["nIndexesWas"]=>
    int(2)
    ["ok"]=>
    float(1)
  }
}

另请参阅

drop()

dropIndexes()