MongoDB\Driver\Query: : _ _construct
(mongodb >=1.0.0)
MongoDB\Driver\Query::__construct — Create a new Query
Description
Constructs a new MongoDB\Driver\Query, which is an immutable value object that represents a database query. The query may then be executed with MongoDB\Driver\Manager::executeQuery().
Parameters
-
filter(array|object) -
The » query predicate. An empty predicate will match all documents in the collection.
Note: 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 (e.g. use MongoDB\BSON\ObjectId to match an » ObjectId).
-
queryOptions -
queryOptions Option Type Description allowPartialResults boolean For queries against a sharded collection, returns partial results from the mongos if some shards are unavailable instead of throwing an error.
Falls back to the deprecated "partial" option if not specified.
awaitData boolean Use in conjunction with the "tailable" option to block a getMore operation on the cursor temporarily if at the end of data rather than returning no data. After a timeout period, the query returns as normal. batchSize integer The number of documents to return in the first batch. Defaults to 101. A batch size of 0 means that the cursor will be established, but no documents will be returned in the first batch.
In versions of MongoDB before 3.2, where queries use the legacy wire protocol OP_QUERY, a batch size of 1 will close the cursor irrespective of the number of matched documents.
collation array|object » 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 A comment to attach to the query to help interpret and trace query profile data.
Falls back to the deprecated "$comment" modifier if not specified.
exhaust boolean Stream the data down full blast in multiple "more" packages, on the assumption that the client will fully read all data queried. Faster when you are pulling a lot of data and know you want to pull it all down. Note: the client is not allowed to not read all the data unless it closes the connection.
This option is not supported by the find command in MongoDB 3.2+ and will force the driver to use the legacy wire protocol version (i.e. OP_QUERY).
explain boolean If
TRUE, the returned MongoDB\Driver\Cursor will contain a single document that describes the process and indexes used to return the query.Falls back to the deprecated "$explain" modifier if not specified.
This option is not supported by the find command in MongoDB 3.2+ and will only be respected when using the legacy wire protocol version (i.e. OP_QUERY). The » explain command should be used on MongoDB 3.0+.
hint string|array|object Index specification. Specify either the index name as a string or the index key pattern. If specified, then the query system will only consider plans using the hinted index.
Falls back to the deprecated "hint" option if not specified.
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 will be interpreted as a positive limit with the "singleBatch" option set to
TRUE. This behavior is supported for backwards compatibility, but should be considered deprecated.max array|object The exclusive upper bound for a specific index.
Falls back to the deprecated "$max" modifier if not specified.
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 in conjunction with the "tailable" and "awaitData" options.
maxScan integer WarningThis option is deprecated and should not be used.
Positive integer denoting the maximum number of documents or index keys to scan when executing the query.
Falls back to the deprecated "$maxScan" modifier if not specified.
maxTimeMS integer The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
Falls back to the deprecated "$maxTimeMS" modifier if not specified.
min array|object The inclusive lower bound for a specific index.
Falls back to the deprecated "$min" modifier if not specified.
modifiers array » Meta operators modifying 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:
[ 'ts' => [ '$gte' => <timestamp> ] ]
projection array|object The » projection specification to determine which fields to include in the returned documents.
If you are using the ODM functionality to deserialise documents as their original PHP class, make sure that you include the __pclass field in the projection. This is required for the deserialization to work and without it, the driver will return (by default) a stdClass object instead.
readConcern MongoDB\Driver\ReadConcern A read concern to apply to the operation. By default, the read concern from the MongoDB Connection URI will be used.
This option is available in MongoDB 3.2+ and will result in an exception at execution time if specified for an older server version.
returnKey boolean If
TRUE, returns only the index keys in the resulting documents. Default value isFALSE. IfTRUEand the find command does not use an index, the returned documents will be empty.Falls back to the deprecated "$returnKey" modifier if not specified.
showRecordId boolean Determines whether to return the record identifier for each document. If
TRUE, adds a top-level "$recordId" field to the returned documents.Falls back to the deprecated "$showDiskLoc" modifier if not specified.
singleBatch boolean Determines whether to close the cursor after the first batch. Defaults to FALSE.skip integer Number of documents to skip. Defaults to 0. slaveOk boolean Allow query of replica set secondaries snapshot boolean WarningThis option is deprecated and should not be used.
Prevents the cursor from returning a document more than once because of an intervening write operation.
Falls back to the deprecated "$snapshot" modifier if not specified.
sort array|object The sort specification for the ordering of the results.
Falls back to the deprecated "$orderby" modifier if not specified.
tailable boolean Returns a tailable cursor for a capped collection.
Errors/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
Changelog
| Version | Description |
|---|---|
| 1.5.0 |
The "maxScan" and "snapshot" options are deprecated. |
| 1.3.0 |
Added the "maxAwaitTimeMS" option. |
| 1.2.0 |
Added the "allowPartialResults", "collation", "comment", "hint", "max", "maxScan", "maxTimeMS", "min", "returnKey", "showRecordId", and "snapshot" options. Renamed the "partial" option to "allowPartialResults". For backwards compatibility, "partial" will still be read if "allowPartialResults" is not specified. Removed the "slaveOk" option, which is obsolete. For queries using the legacy wire protocol OP_QUERY, the driver will set the slaveOk bit as needed in accordance with the » Server Selection Specification. |
| 1.1.0 | Added the "readConcern" option. |
Examples
Example #1 MongoDB\Driver\Query::__construct() example
<?php
/* Select only documents authord by "bjori" with at least 100 views */
$filter = [
'author' => 'bjori',
'views' => [
'$gte' => 100,
],
];
$options = [
/* Only return the following fields in the matching documents */
'projection' => [
'title' => 1,
'article' => 1,
],
/* Return the documents in descending order of views */
'sort' => [
'views' => -1
],
];
$query = new MongoDB\Driver\Query($filter, $options);
$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
$cursor = $manager->executeQuery('databaseName.collectionName', $query, $readPreference);
foreach($cursor as $document) {
var_dump($document);
}
?>
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-mongodb-driver-query.construct.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
