MongoDB\Collection::drop()

本页内容

定义

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

定义

MongoDB\Collection::drop()

删除集合。

function drop(array $options = []): array|object

参数

$options : array

指定所需选项的数组。

名称	类型	描述
注释	mixed	允许用户指定一个任意的注释，以帮助通过数据库分析器、当前操作输出和日志来跟踪操作。数据库分析器，当前操作，日志此选项自MongoDB 4.4版本起可用，如果为较旧的服务器版本指定，则在执行时将引发异常。新增在版本1.13.
encryptedFields	array\|object	本文档描述了可查询加密的加密字段。如果省略，将咨询 `autoEncryption` 驱动选项内的 `encryptedFieldsMap` 选项。如果 `encryptedFieldsMap` 已定义但未指定此集合，库将最终尝试咨询服务端 `encryptedFields` 的值。有关更多信息，请参阅 MongoDB 手册中的字段加密和可查询性。此选项不会传递给 drop 命令。库使用它来确定除了加密集合外还应删除的相关元数据集合。新增在版本1.13.
会话	MongoDB\Driver\Session	与操作关联的客户端会话。新增在版本1.3.
typeMap	数组	应用于游标的类型映射，它决定了 BSON 文档如何转换为 PHP 值。默认为集合的类型映射。这将用于返回的命令结果文档。
writeConcern	MongoDB\Driver\WriteConcern	写入关注用于操作的选项。默认为集合的写入关注。在事务中无法为单个操作指定写入关注。相反，在开始事务时设置 `writeConcern` 选项。

返回值

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

错误/异常

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

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

对于扩展级别的其他错误（例如连接错误），将抛出 MongoDB\Driver\Exception\RuntimeException。

示例

以下操作将在 test 数据库中删除 restaurants 集合

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

输出结果将类似

object(MongoDB\Model\BSONDocument)#9 (1) {
  ["storage":"ArrayObject":private]=>
  array(3) {
    ["ns"]=>
    string(16) "test.restaurants"
    ["nIndexesWas"]=>
    int(3)
    ["ok"]=>
    float(1)
  }
}

另请参阅

MongoDB\Database::dropCollection()
drop 命令参考 MongoDB 手册

distinct()

dropIndex()