- 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 The name 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 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.
This is not supported for server versions prior to 3.4 and will result in an exception at execution time if used.
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:
object(MongoDB\Model\BSONDocument)#9 (1) {
["storage":"ArrayObject":private]=>
array(2) {
["nIndexesWas"]=>
int(2)
["ok"]=>
float(1)
}
}
See Also
MongoDB\Collection::dropIndexes()
- Indexes
- dropIndexes command reference in the MongoDB manual
- Index documentation in the MongoDB manual