MongoDB\GridFS\Bucket::find()
Definition
Parameters
$filter
: array|object- The filter criteria that specifies the documents to query.
$options
: arrayAn array specifying the desired options.
NameTypeDescriptionallowDiskUsebooleanEnables writing to temporary files. When set totrue
, queries can write data to the_tmp
sub-directory in thedbPath
directory.allowPartialResultsbooleanFor queries against a sharded collection, returns partial results from themongos
if some shards are unavailable instead of throwing an error.batchSizeintegerThe number of documents to return in the first batch. Defaults to
101
. A batchSize of0
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 thefind
command does not close the cursor.codecMongoDB\Codec\DocumentCodecThe codec to use for encoding or decoding documents. This option is mutually exclusive with the
typeMap
option.Defaults to the bucket's codec. Inheritance for a default
codec
option takes precedence over that of thetypeMap
option.New in version 1.17.
collationarray|objectCollation 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.commentmixedEnables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs.
The comment can be any valid BSON type since MongoDB 4.4. Earlier server versions only support string values.
cursorTypeintegerIndicates the type of cursor to use.
cursorType
supports the following values:MongoDB\Operation\Find::NON_TAILABLE
(default)MongoDB\Operation\Find::TAILABLE
hintstring|array|objectThe index to use. Specify either the index name as a string or the index key pattern as a document. If specified, then the query system will only consider plans using the hinted index.
New in version 1.2.
letarray|objectMap of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g.
$$var
).This is not supported for server versions prior to 5.0 and will result in an exception at execution time if used.
New in version 1.13.
limitintegerThe 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.
maxarray|objectThe exclusive upper bound for a specific index.
New in version 1.2.
maxAwaitTimeMSintegerPositive 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.
New in version 1.2.
maxTimeMSintegerThe cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
minarray|objectThe inclusive lower bound for a specific index.
New in version 1.2.
noCursorTimeoutbooleanPrevents the server from timing out idle cursors after an inactivity period (10 minutes).projectionarray|objectThe 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.readConcernRead concern to use for the operation. Defaults to the bucket's read concern.
It is not possible to specify a read concern for individual operations as part of a transaction. Instead, set the
readConcern
option when starting the transaction.readPreferenceRead preference to use for the operation. Defaults to the bucket's read preference.
returnKeybooleanIf true, returns only the index keys in the resulting documents.
New in version 1.2.
sessionClient session to associate with the operation.
New in version 1.3.
showRecordIdbooleanDetermines whether to return the record identifier for each document. If true, adds a field
$recordId
to the returned documents.New in version 1.2.
skipintegerNumber of documents to skip. Defaults to0
.sortarray|objectThe sort specification for the ordering of the results.typeMaparrayThe type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the bucket's type map.
Return Values
A MongoDB\Driver\Cursor object.
Errors/Exceptions
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 extension level (e.g. connection errors).
Behavior
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 extension (e.g. use MongoDB\BSON\ObjectId to match an ObjectId).
Examples
$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:
array(1) { [0]=> object(MongoDB\Model\BSONDocument)#3015 (1) { ["storage":"ArrayObject":private]=> array(2) { ["filename"]=> string(1) "b" ["length"]=> int(6) } } }