MongoDB\Collection::dropIndexes()
Definition
Parameters
$indexName
: string|MongoDB\Model\IndexInfo
- The name or model object of the index to drop. View the existing indexes on
the collection by using the
MongoDB\Collection::listIndexes()
method. $options
: arrayAn array specifying the desired options.
NameTypeDescriptioncommentmixedEnables 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.
maxTimeMSintegerThe cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
New in version 1.3.
sessionClient session to associate with the operation.
New in version 1.3.
typeMaparrayThe 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.
writeConcernWrite 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 drops all indexes from the restaurants
collection in the
test
database:
$collection = (new MongoDB\Client)->test->restaurants; $collection->dropIndexes();
See Also
dropIndexes command reference in the MongoDB manual
Index documentation in the MongoDB manual