MongoDB\Collection::drop()

On this page

Definition

Parameters
Errors/Exceptions
Example
See Also

Definition

MongoDB\Collection::drop()

Drop the collection.

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

Parameters

$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. 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	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 collection'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 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.

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 operation drops the restaurants collection in the test database:

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

Definition

Parameters

Errors/Exceptions

Example

See Also