MongoDBDatabase-listCollections.txt

====================================
MongoDB\\Database::listCollections()
====================================

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

Definition
----------

.. phpmethod:: MongoDB\Database::listCollections()

   Returns information for all collections in this database.

   .. code-block:: php

      function listCollections(array $options = []): Iterator

Parameters
----------

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

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

     * - Name
       - Type
       - Description

     * - authorizedCollections
       - boolean
       - A flag that determines which collections are returned based on the user
         privileges when access control is enabled. For more information, see
         the :manual:`listCollections </reference/command/listCollections>`
         command documentation.

         For servers < 4.0, this option is ignored.

         .. versionadded:: 1.12

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

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

         .. versionadded:: 1.13

     * - filter
       - array|object
       - A query expression to filter the list of collections.

         You can specify a query expression for collection fields (e.g.
         ``name``, ``options``).

     * - maxTimeMS
       - integer
       - .. include:: /includes/extracts/common-option-maxTimeMS.rst

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

         .. versionadded:: 1.3

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

An :php:`Iterator <manual/en/class.iterator.php>`
instance, which provides a :phpclass:`MongoDB\Model\CollectionInfo`
object for each collection in the database.

Example
-------

The following example lists all of the collections in the ``test`` database:

.. code-block:: php

   <?php

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

   foreach ($database->listCollections() as $collectionInfo) {
       var_dump($collectionInfo);
   }

The output would then resemble:

.. code-block:: none

   object(MongoDB\Model\CollectionInfo)#3 (2) {
     ["name"]=>
     string(11) "restaurants"
     ["options"]=>
     array(0) {
     }
   }
   object(MongoDB\Model\CollectionInfo)#3 (2) {
     ["name"]=>
     string(5) "users"
     ["options"]=>
     array(0) {
     }
   }
   object(MongoDB\Model\CollectionInfo)#3 (2) {
     ["name"]=>
     string(6) "restos"
     ["options"]=>
     array(0) {
     }
   }

The following example lists all collections whose name starts with ``"rest"``
in the ``test`` database:

.. code-block:: php

   <?php

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

   $collections = $database->listCollections([
       'filter' => [
           'name' => new MongoDB\BSON\Regex('^rest.*'),
       ],
   ]);

   foreach ($collections as $collectionInfo) {
       var_dump($collectionInfo);
   }

The output would then resemble:

.. code-block:: none

   object(MongoDB\Model\CollectionInfo)#3 (2) {
     ["name"]=>
     string(11) "restaurants"
     ["options"]=>
     array(0) {
     }
   }
   object(MongoDB\Model\CollectionInfo)#3 (2) {
     ["name"]=>
     string(6) "restos"
     ["options"]=>
     array(0) {
     }
   }

See Also
--------

- :phpmethod:`MongoDB\Database::listCollectionNames()`
- :manual:`listCollections </reference/command/listCollections>` command
  reference in the MongoDB manual
- `Enumerating Collections
  <https://github.com/mongodb/specifications/blob/master/source/enumerate-collections/enumerate-collections.md>`_
  specification