Navigation

MongoDB\Client::dropDatabase()

Definition

MongoDB\Client::dropDatabase

Drop a database on the server.

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

This method has the following parameters:

Parameter Type Description
$databaseName string The name of the database to drop.
$options array Optional. An array specifying the desired options.

The $options parameter supports the following options:

Option Type Description
typeMap array

Optional. The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the client’s type map.

This will be used for the returned command result document.

writeConcern MongoDB\Driver\WriteConcern

Optional. Write concern to use for the operation. Defaults to the client’s write concern.

This is not supported for server versions prior to 3.4 and will result in an exception at execution time if used.

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 driver level (e.g. connection errors).

Example

The following example drops the test database:

<?php

$client = new MongoDB\Client;

$result = $client->dropDatabase('test');

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