MongoDB\Client::dropDatabase()

定义

MongoDB\Client::dropDatabase()

在服务器上删除数据库。

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

参数

$databaseName : string

要删除的数据库的名称。

$options : array

指定所需选项的数组。

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

返回值

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

错误/异常

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

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

对于扩展级别的其他错误（例如连接错误），抛出 MongoDB\Driver\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 命令参考，请参阅 MongoDB 手册