MongoDB\Database::dropCollection()

本页内容

定义

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

定义

MongoDB\Database::dropCollection()

在当前数据库中删除集合。

function dropCollection(
    string $collectionName,
    array $options = []
): array|object

参数

$collectionName : 字符串

要删除的集合名称。

$options : 数组

指定所需选项的数组。

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

返回值

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

错误/异常

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

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

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

示例

以下示例在 test 数据库中删除了 users 集合

<?php
$db = (new MongoDB\Client)->test;
$result = $db->dropCollection('users');
var_dump($result);

输出将类似于

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

另请参阅

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

drop()

getDatabaseName()