PHP Classes

File: vendor/mongodb/mongodb/docs/reference/method/MongoDBCollection-dropIndexes.txt

Recommend this page to a friend!
  Classes of walid laggoune   MongoDB Queue PHP Query Execute   vendor/mongodb/mongodb/docs/reference/method/MongoDBCollection-dropIndexes.txt   Download  
File: vendor/mongodb/mongodb/docs/reference/method/MongoDBCollection-dropIndexes.txt
Role: Documentation
Content type: text/plain
Description: Documentation
Class: MongoDB Queue PHP Query Execute
Query and execute multiple queries using MongoDB
Author: By
Last change:
Date: 4 years ago
Size: 2,010 bytes
 

Contents

Class file image Download
================================== MongoDB\\Collection::dropIndexes() ================================== .. default-domain:: mongodb .. contents:: On this page :local: :backlinks: none :depth: 1 :class: singlecol Definition ---------- .. phpmethod:: MongoDB\\Collection::dropIndexes() Drop all indexes in the collection, except for the required index on the ``_id`` field. .. code-block:: php function dropIndexes(array $options = []): array|object This method has the following parameters: .. include:: /includes/apiargs/MongoDBCollection-method-dropIndex-param.rst The ``$options`` parameter supports the following options: .. include:: /includes/apiargs/MongoDBCollection-method-dropIndex-option.rst Return Values ------------- An array or object with the result document of the :manual:`dropIndexes </reference/command/dropIndexes>` command. The return type will depend on the ``typeMap`` option. Errors/Exceptions ----------------- .. include:: /includes/extracts/error-unsupportedexception.rst .. include:: /includes/extracts/error-invalidargumentexception.rst .. include:: /includes/extracts/error-driver-runtimeexception.rst Example ------- The following drops all indexes from the ``restaurants`` collection in the ``test`` database: .. code-block:: php <?php $collection = (new MongoDB\Client)->test->restaurants; $result = $collection->dropIndexes(); var_dump($result); The output would then resemble:: object(MongoDB\Model\BSONDocument)#9 (1) { ["storage":"ArrayObject":private]=> array(3) { ["nIndexesWas"]=> int(3) ["msg"]=> string(38) "non-_id indexes dropped for collection" ["ok"]=> float(1) } } See Also -------- - :phpmethod:`MongoDB\\Collection::dropIndex()` - :doc:`/tutorial/indexes` - :manual:`dropIndexes </reference/command/dropIndexes>` command reference in the MongoDB manual - :manual:`Index documentation </indexes>` in the MongoDB manual