Docs 菜单
Docs 主页
/
语言
/
PHP
/
PHP 库手册
/
API 文档
/
MongoDB\Collection 类

MongoDB\Collection::dropIndex()

在此页面上

  • 定义
  • 参数
  • 返回值
  • 错误/异常
  • 例子
  • 另请参阅

定义

MongoDB\Collection::dropIndex()

从collection中删除索引。

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

参数

$indexName ： 细绳| MongoDB\Model\IndexInfo
要删除的索引的名称或模型对象。使用MongoDB\Collection::listIndexes()方法查看集合上的现有索引。
$options : array

指定所需选项的数组。

名称
类型
说明
评论
混合

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

自 MongoDB 4.4 起此选项可用，如果为旧服务器版本指定，则会在执行时导致异常。

1.13 版本中的新增功能。

maxTimeMS
整型

处理游标操作的累计时间限制（以毫秒为单位）。MongoDB 最早会在中断点之后中止操作。

1.3 版本中的新增功能。

会议

与操作相关联的客户端会话。

1.3 版本中的新增功能。

typeMap
阵列

类型映射 应用于游标，决定如何将 BSON 文档转换为 PHP 值。默认为集合的类型映射。

这将用于返回的命令结果文档。

writeConcern

写关注用于操作。默认为集合的写关注。

无法将单个操作的写关注指定为事务的一部分。 相反，请在writeConcern 启动事务 时设置 选项。

返回值

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

错误/异常

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

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

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

例子

以下操作从数据库test的collectionrestaurants中删除名为borough_1的索引：

<?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()

在此页面上