MongoDB\Database::drop()

Definition

MongoDB\Database::drop()

Drop the database.

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

Parameters

$options : array

An array specifying the desired options.

Name	Type	Description
comment	mixed	Enables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs. This option is available since MongoDB 4.4 and will result in an exception at execution time if specified for an older server version. New in version 1.13.
session	MongoDB\Driver\Session	Client session to associate with the operation. New in version 1.3.
typeMap	array	The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the database's type map. This will be used for the returned command result document.
writeConcern	MongoDB\Driver\WriteConcern	Write concern to use for the operation. Defaults to the database's write concern.

Return Values

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

Errors/Exceptions

MongoDB\Exception\UnsupportedException if options are used and not supported by the selected server (e.g. collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\Driver\Exception\RuntimeException for other errors at the extension level (e.g. connection errors).

Example

The following example drops the test database:

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

The output would then resemble:

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

See Also

• MongoDB\Client::dropDatabase()

• dropDatabase command reference in the MongoDB manual