- Reference >
- MongoDB\Collection Class >
- MongoDB\Collection::drop()
MongoDB\Collection::drop()
On this page
Definition
-
MongoDB\Collection::drop
Drop the collection.
This method has the following parameters:
Parameter Type Description $options
array Optional. An array specifying the desired options. The
$options
parameter supports the following options:Option Type Description 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.
encryptedFields
array|object Optional. A document describing encrypted fields for queryable encryption. If omitted, the
encryptedFieldsMap
option within theautoEncryption
driver option will be consulted. IfencryptedFieldsMap
was defined but does not specify this collection, the library will make a final attempt to consult the server-side value forencryptedFields
. 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.
Note
Queryable Encryption is in public preview and available for evaluation purposes. It is not yet recommended for production deployments as breaking changes may be introduced. See the Queryable Encryption Preview blog post for more information.
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 collection’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 collection’s write concern.
It is not possible to specify a write concern for individual operations as part of a transaction. Instead, set the
writeConcern
option when starting the transaction with startTransaction.
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 operation drops the restaurants
collection in the test
database:
The output would then resemble:
See Also
MongoDB\Database::dropCollection()
- drop command reference in the MongoDB manual