MongoDB\Collection::drop()

定义

MongoDB\Collection::drop()

删除该集合。

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

参数

$options : array

指定所需选项的数组。

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

Return Values

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

错误/异常

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

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

MongoDB\ 驱动程序\Exception\RuntimeException 对于扩展级别的其他错误（例如连接错误）。

例子

以下操作会删除test数据库中的restaurantscollection：

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

• MongoDB 手册中的drop命令参考