Docs Menu

Docs HomePHP Library Manual

MongoDB\Database::dropCollection()

On this page

  • Definition
  • Parameters
  • Return Values
  • Errors/Exceptions
  • Example
  • See Also
MongoDB\\Database::dropCollection()

Drop a collection within the current database.

function dropCollection(
string $collectionName,
array $options = []
): array|object
$collectionName : string
The name of the collection 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.

encryptedFields
array|object

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 Field Encryption and Queryability in the MongoDB manual for more information.

Note

This option is not passed to the drop command. The library uses it to determine related metadata collections that should be dropped in addition to an encrypted collection.

New in version 1.13.

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

Write concern to use for the operation. Defaults to the database's write concern.

An array or object with the result document of the drop command. The return type will depend on the typeMap option.

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

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)
}
}
←  MongoDB\Database::drop()MongoDB\Database::getDatabaseName() →