MongoDB\Client::dropDatabase()

For the complete MongoDB documentation index, see www.mongodb.com/docs/llms.txt

MongoDB\Client::dropDatabase()

Definition

Drop a database on the server.

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

Parameters

$databaseName : string

The name of the database to drop.

$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](https://php.net/manual/en/mongodb.persistence.deserialization.php#mongodb.persistence.typemaps 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 Write concern to use for the operation. Defaults to the client's write concern.

Errors/Exceptions

[MongoDB\Exception\UnsupportedException](https://www.mongodb.com/docs/php-library/current/reference/exception-classes.md#mongodb-phpclass-phpclass.MongoDB-Exception-UnsupportedException if options are used and not supported by the selected server (e.g. collation, readConcern, writeConcern).

[MongoDB\Exception\InvalidArgumentException](https://www.mongodb.com/docs/php-library/current/reference/exception-classes.md#mongodb-phpclass-phpclass.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

$client = new MongoDB\Client;

$client->dropDatabase('test');

See Also

  • [MongoDB\Database::drop()](https://www.mongodb.com/docs/php-library/current/reference/method/mongodbdatabase-drop.md#mongodb-phpmethod-phpmethod.MongoDB-Database--drop--

  • dropDatabase command reference in the MongoDB manual