MongoDB\Database::drop()

定义

MongoDB\Database::drop()

删除数据库。

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

参数

$options : array

指定所需选项的数组。

名称	类型	描述
注释	mixed	启用用户指定任意注释以帮助通过数据库分析器、当前操作输出和日志来跟踪操作。数据库分析器、当前操作和日志。 此选项自MongoDB 4.4版开始可用，如果指定用于旧服务器版本，则在执行时将引发异常。 新增在版本1.13.
会话	MongoDB\Driver\Session	与操作关联的客户端会话。 新增在版本1.3.
typeMap	array	将 类型映射 应用到游标上，它决定了 BSON 文档如何转换为 PHP 值。默认为数据库的类型映射。 这将用于返回的命令结果文档。
写关注	MongoDB\Driver\WriteConcern	写关注 用于操作。默认为数据库的写关注。

返回值

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

错误/异常

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

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

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

示例

以下示例删除了 test 数据库

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

输出结果将类似于

object(MongoDB\Model\BSONDocument)#8 (1) {
  ["storage":"ArrayObject":private]=>
  array(2) {
    ["dropped"]=>
    string(4) "test"
    ["ok"]=>
    float(1)
  }
}

另请参阅

• MongoDB\Client::dropDatabase()

• dropDatabase 命令参考 MongoDB 手册