Navigation

MongoDB\Database::dropCollection()

Definition

MongoDB\Database::dropCollection

Drop a collection within the current database.

function dropCollection($collectionName, array $options = []): array|object

This method has the following parameters:

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

The $options parameter supports the following options:

Option Type Description
encryptedFields array|object

Optional. A document describing encrypted fields for queryable encryption. If omitted, the encryptedFieldsMap option within the autoEncryption driver option will be consulted. If encryptedFieldsMap was defined but does not specify this collection, the library will make a final attempt to consult the server-side value for encryptedFields. See the Client Side Encryption specification for more information.

New in version 1.13.

comment mixed

Optional. Enables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs.

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

New in version 1.13.

session MongoDB\Driver\Session

Optional. Client session to associate with the operation.

New in version 1.3.

typeMap array

Optional. 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 Optional. 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 drop 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 users collection in the test database:

<?php

$db = (new MongoDB\Client)->test;

$result = $db->dropCollection('users');

var_dump($result);

The output would then resemble:

object(MongoDB\Model\BSONDocument)#8 (1) {
  ["storage":"ArrayObject":private]=>
  array(3) {
    ["ns"]=>
    string(10) "test.users"
    ["nIndexesWas"]=>
    int(1)
    ["ok"]=>
    float(1)
  }
}

See Also