===================================
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(
          string $collectionName,
          array $options = []
      ): array|object

Parameters
----------

``$collectionName`` : string
  The name of the collection to drop.

``$options`` : array
  An array specifying the desired options.

  .. list-table::
     :header-rows: 1
     :widths: 20 20 80

     * - Name
       - Type
       - Description

     * - comment
       - mixed
       - .. include:: /includes/extracts/common-option-comment.rst

         .. include:: /includes/extracts/option-requires-4.4.rst

         .. versionadded:: 1.13

     * - encryptedFields
       - array|object
       - A document describing encrypted fields for queryable encryption. If
         omitted, the ``encryptedFieldsMap`` option within the
         ``autoEncryption`` driver option will be consulted. If
         ``encryptedFieldsMap`` was defined but does not specify this
         collection, the library will make a final attempt to consult the
         server-side value for ``encryptedFields``. See
         `Field Encryption and Queryability <https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/encrypt-and-query/>`_
         in the MongoDB manual for more information.

         .. note::

            This option is not passed to the
            :manual:`drop </reference/command/drop>` command. The library uses
            it to determine related metadata collections that should be dropped
            in addition to an encrypted collection.

         .. versionadded:: 1.13

     * - session
       - :php:`MongoDB\Driver\Session <class.mongodb-driver-session>`
       - .. include:: /includes/extracts/common-option-session.rst

         .. versionadded:: 1.3

     * - typeMap
       - array
       - .. include:: /includes/extracts/database-option-typeMap.rst

         This will be used for the returned command result document.

     * - writeConcern
       - :php:`MongoDB\Driver\WriteConcern <class.mongodb-driver-writeconcern>`
       - .. include:: /includes/extracts/database-option-writeConcern.rst

Return Values
-------------

An array or object with the result document of the :manual:`drop
</reference/command/drop>` 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 example drops the ``users`` collection in the ``test`` database:

.. code-block:: php

   <?php

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

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

   var_dump($result);

The output would then resemble:

.. code-block:: none

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

See Also
--------

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