MongoDB\Client::dropDatabase()

定义

MongoDB\Client::dropDatabase()

在服务器上删除数据库。

function dropDatabase(string $databaseName, array $options = []): array|object

参数

$databaseName ： 细绳

要删除的数据库的名称。

$options : array

指定所需选项的数组。

名称	类型	说明
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。 自 MongoDB 4.4 起此选项可用，如果为旧服务器版本指定，则会在执行时导致异常。 1.13版本新增。
会话	MongoDB\Driver\Session	与操作相关联的客户端会话。 1.3版本新增。
typeMap	阵列	应用游标的类型映射，决定如何将BSON文档转换为PHP值。默认为客户端的类型映射。 这将用于返回的命令结果文档。
writeConcern	MongoDB\Driver\WriteConcern	写入用于操作的关注。 默认为客户端的写关注。

Return Values

An array or object with the result document of the dropDatabase command. The return type will depend on the typeMap option.

错误/异常

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

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

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

例子

以下示例删除test数据库：

<?php
$client = new MongoDB\Client;
$result = $client->dropDatabase('test');
var_dump($result);

而输出将类似如下所示：

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

另请参阅

• MongoDB\Database::drop()

• dropDatabase command reference in the MongoDB manual