===============================
MongoDB\\GridFS\\Bucket::find()
===============================

.. default-domain:: mongodb

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

Definition
----------

.. phpmethod:: MongoDB\GridFS\Bucket::find()

   Finds documents from the GridFS bucket's files collection matching the query.

   .. code-block:: php

      function find(
          array|object $filter = [],
          array $options = []
      ): MongoDB\Driver\Cursor

Parameters
----------

``$filter`` : array|object
  The filter criteria that specifies the documents to query.

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

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

     * - Name
       - Type
       - Description

     * - allowDiskUse
       - boolean
       - Enables writing to temporary files. When set to ``true``, queries can
         write data to the ``_tmp`` sub-directory in the ``dbPath`` directory.

     * - allowPartialResults
       - boolean
       - For queries against a sharded collection, returns partial results from
         the :program:`mongos` if some shards are unavailable instead of
         throwing an error.

     * - batchSize
       - integer
       - The number of documents to return in the first batch. Defaults to
         ``101``. A batchSize of ``0`` means that the cursor will be
         established, but no documents will be returned in the first batch.

         Unlike the previous wire protocol version, a batchSize of ``1`` for the
         :dbcommand:`find` command does not close the cursor.

     * - codec
       - MongoDB\\Codec\\DocumentCodec
       - .. include:: /includes/extracts/bucket-option-codec.rst

         .. versionadded:: 1.17

     * - collation
       - array|object
       - .. include:: /includes/extracts/common-option-collation.rst

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

         .. include:: /includes/extracts/common-option-comment-string-before-4.4.rst

     * - cursorType
       - integer
       - Indicates the type of cursor to use. ``cursorType`` supports the
         following values:

         - ``MongoDB\Operation\Find::NON_TAILABLE`` (*default*)
         - ``MongoDB\Operation\Find::TAILABLE``

     * - hint
       - string|array|object
       - .. include:: /includes/extracts/common-option-hint.rst

         .. versionadded:: 1.2

     * - let
       - array|object
       - .. include:: /includes/extracts/common-option-let.rst

         .. versionadded:: 1.13

     * - limit
       - integer
       - The maximum number of documents to return. If unspecified, then
         defaults to no limit. A limit of ``0`` is equivalent to setting no
         limit.

         A negative limit is similar to a positive limit but closes the cursor
         after returning a single batch of results. As such, with a negative
         limit, if the limited result set does not fit into a single batch, the
         number of documents received will be less than the specified limit. By
         passing a negative limit, the client indicates to the server that it
         will not ask for a subsequent batch via getMore.

     * - max
       - array|object
       - The exclusive upper bound for a specific index.

         .. versionadded:: 1.2

     * - maxAwaitTimeMS
       - integer
       - Positive integer denoting the time limit in milliseconds for the server
         to block a getMore operation if no data is available. This option
         should only be used if cursorType is TAILABLE_AWAIT.

         .. versionadded:: 1.2

     * - maxScan
       - integer
       - Maximum number of documents or index keys to scan when executing the
         query.

         .. deprecated:: 1.4
         .. versionadded:: 1.2

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

     * - min
       - array|object
       - The inclusive lower bound for a specific index.

         .. versionadded:: 1.2

     * - modifiers
       - array|object
       - :manual:`Meta operators </reference/operator/query-modifier>` that
         modify the output or behavior of a query. Use of these operators is
         deprecated in favor of named options.

     * - noCursorTimeout
       - boolean
       - Prevents the server from timing out idle cursors after an inactivity
         period (10 minutes).

     * - oplogReplay
       - boolean
       - Internal use for replica sets. To use ``oplogReplay``, you must include
         the following condition in the filter:

         .. code-block:: javascript

            { ts: { $gte: <timestamp> } }

         The :php:`MongoDB\BSON\Timestamp <class.mongodb-bson-timestamp>`
         class reference describes how to represent MongoDB's BSON timestamp
         type with PHP.

         .. deprecated:: 1.7

     * - projection
       - array|object
       - The :ref:`projection specification <projections>` to determine which
         fields to include in the returned documents. See
         :manual:`Project Fields to Return from Query </tutorial/project-fields-from-query-results>`
         and :manual:`Projection Operators </reference/operator/projection>` in
         the MongoDB manual.

     * - readConcern
       - :php:`MongoDB\Driver\ReadConcern <class.mongodb-driver-readconcern>`
       - .. include:: /includes/extracts/bucket-option-readConcern.rst

         .. include:: /includes/extracts/common-option-readConcern-transaction.rst

     * - readPreference
       - :php:`MongoDB\Driver\ReadPreference <class.mongodb-driver-readpreference>`
       - .. include:: /includes/extracts/bucket-option-readPreference.rst

     * - returnKey
       - boolean
       - If true, returns only the index keys in the resulting documents.

         .. versionadded:: 1.2

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

         .. versionadded:: 1.3

     * - showRecordId
       - boolean
       - Determines whether to return the record identifier for each document.
         If true, adds a field ``$recordId`` to the returned documents.

         .. versionadded:: 1.2

     * - skip
       - integer
       - Number of documents to skip. Defaults to ``0``.

     * - sort
       - array|object
       - The sort specification for the ordering of the results.

     * - snapshot
       - boolean
       - Prevents the cursor from returning a document more than once because of
         an intervening write operation.

         .. deprecated:: 1.4
         .. versionadded:: 1.2

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

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

A :php:`MongoDB\Driver\Cursor <class.mongodb-driver-cursor>` object.

Errors/Exceptions
-----------------

.. include:: /includes/extracts/error-unsupportedexception.rst
.. include:: /includes/extracts/error-invalidargumentexception.rst
.. include:: /includes/extracts/error-driver-runtimeexception.rst

Behavior
--------

.. include:: /includes/extracts/note-bson-comparison.rst

Examples
--------

.. code-block:: php

   <?php

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

   $stream = fopen('php://temp', 'w+b');
   fwrite($stream, "foobar");
   rewind($stream);

   $bucket->uploadFromStream('b', $stream);

   $cursor = $bucket->find(
       ['length' => ['$lte' => 6]],
       [
           'projection' => [
               'filename' => 1,
               'length' => 1,
               '_id' => 0,
            ],
            'sort' => ['length' => -1],
        ]
   );

   var_dump($cursor->toArray());

The output would then resemble:

.. code-block:: none

   array(1) {
     [0]=>
     object(MongoDB\Model\BSONDocument)#3015 (1) {
       ["storage":"ArrayObject":private]=>
       array(2) {
         ["filename"]=>
         string(1) "b"
         ["length"]=>
         int(6)
       }
     }
   }

See Also
--------

- :phpmethod:`MongoDB\Collection::find()`
- :phpmethod:`MongoDB\GridFS\Bucket::findOne()`
