MongoDBDatabase-dropCollection.txt

===================================
MongoDB\\Database::dropCollection()
===================================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. phpmethod:: MongoDB\\Database::dropCollection

   Drop a collection within the current database.
   
   .. code-block:: php
   
      function dropCollection($collectionName, array $options = []): array|object
   
   :phpmethod:`MongoDB\\Database::dropCollection` has the following
   parameters:
   
   .. include:: /includes/apiargs/MongoDBDatabase-method-dropCollection-param.rst
   
   The ``$options`` parameter accepts the following options:
   
   .. include:: /includes/apiargs/MongoDBDatabase-method-dropCollection-option.rst

Output
------

Returns the command result document as an array.

Example
-------

The following example drops the ``users`` collection in the ``demo``
database:

.. code-block:: php

   $db = (new MongoDB\Client)->demo;

   $result = $db->dropCollection('users');
   
   
   var_dump($result);

The output would then resemble::

   object(MongoDB\Model\BSONDocument)#8 (1) {
     ["storage":"ArrayObject":private]=>
     array(3) {
       ["ns"]=>
       string(10) "demo.users"
       ["nIndexesWas"]=>
       int(1)
       ["ok"]=>
       float(1)
     }
   }

.. seealso::

   - :phpmethod:`MongoDB\\Collection::drop`
   - :manual:`drop </reference/command/drop>` command reference in
     the MongoDB manual