This version of the documentation is archived and no longer supported. To learn how to upgrade your version of PHP Library Manual, refer to the upgrade documentation.




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

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

This method has the following parameters:

Parameter Type Description
$filter array|object Optional. The filter criteria that specifies the documents to query.
$options array Optional. An array specifying the desired options.

The $options parameter supports the following options:

Option Type Description
projection array|object Optional. The projection specification to determine which fields to include in the returned documents. See Project Fields to Return from Query and Projection Operators in the MongoDB manual.
sort array|object Optional. The sort specification for the ordering of the results.
skip integer Optional. Number of documents to skip. Defaults to 0.
limit integer

Optional. 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.

batchSize integer

Optional. 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 find command does not close the cursor.

collation array|object

Optional. Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the locale field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.

If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.

This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.

comment string Optional. A comment to attach to the query to help interpret and trace query profile data.
cursorType integer

Optional. Indicates the type of cursor to use. cursorType supports the following values:

  • MongoDB\Operation\Find::NON_TAILABLE (default)
  • MongoDB\Operation\Find::TAILABLE
maxTimeMS integer Optional. The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
readConcern MongoDB\Driver\ReadConcern Optional. Read concern to use for the operation. Defaults to the bucket’s read concern.
readPreference MongoDB\Driver\ReadPreference Optional. Read preference to use for the operation. Defaults to the bucket’s read preference.
oplogReplay boolean

Optional. Internal use for replica sets. To use oplogReplay, you must include the following condition in the filter:

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

The MongoDB\BSON\Timestamp class reference describes how to represent MongoDB’s BSON timestamp type with PHP.

noCursorTimeout boolean Optional. Prevents the server from timing out idle cursors after an inactivity period (10 minutes).
allowPartialResults boolean Optional. For queries against a sharded collection, returns partial results from the mongos if some shards are unavailable instead of throwing an error.
typeMap array Optional. The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the bucket’s type map.
modifiers array|object Optional. Meta operators that modify the output or behavior of a query. Use of these operators is deprecated in favor of named options.

Return Values

A MongoDB\Driver\Cursor object.


MongoDB\Exception\UnsupportedException if options are used and not supported by the selected server (e.g. collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).


When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP’s comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class in the driver (e.g. use MongoDB\BSON\ObjectId to match an ObjectId).