MongoDB\Client::dropDatabase()
Definition
Parameters
$databaseName
: string- The name of the database to drop.
$options
: arrayAn array specifying the desired options.
NameTypeDescriptioncommentmixedEnables 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.
sessionClient session to associate with the operation.
New in version 1.3.
typeMaparrayThe 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.
writeConcernWrite concern to use for the operation. Defaults to the client's write concern.
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:
$client = new MongoDB\Client; $client->dropDatabase('test');
See Also
dropDatabase command reference in the MongoDB manual