- Reference >
- MongoDB\Collection Class >
- MongoDB\Collection::dropIndex()
MongoDB\Collection::dropIndex()
On this page
Definition
-
MongoDB\Collection::dropIndex
Drop an index from the collection.
This method has the following parameters:
Parameter Type Description $indexName
string| MongoDB\Model\IndexInfo
The name or model object of the index to drop. View the existing indexes on the collection using the listIndexes()
method.$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.
maxTimeMS
integer Optional. The 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.
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 dropIndexes 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 drops an indexes with name borough_1
from the restaurants
collection in the test
database:
The output would then resemble:
See Also
MongoDB\Collection::dropIndexes()
- Indexes
- dropIndexes command reference in the MongoDB manual
- Index documentation in the MongoDB manual