MongoDB\Database::drop()

Definition

MongoDB\Database::drop()

Drop the database.

function drop(array $options = []): void

$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. To use this option, you must connect to MongoDB 6.0 or later. If you are connected to an earlier version, the server returns an exception at execution time. 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.

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).

The following example drops the test database:

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