diff --git a/language-snippets.ent b/language-snippets.ent index a1d0f7dbea..d8d73dd161 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -1735,6 +1735,7 @@ paths Returns &true; on success, or &false; otherwise.'> Emits E_WARNING if the w parameter is not an integer or string value.'> This function returns an array describing the write concern. The array contains the values w for an integer acknowledgement level or string mode, and wtimeout denoting the maximum number of milliseconds to wait for the server to satisfy the write concern.'> +"maxTimeMS"Specifies a cumulative time limit in milliseconds for processing the operation (does not include idle time). If the operation is not completed within the timeout period, a MongoExecutionTimeoutException will be thrown.'> "w"See WriteConcerns. The default value for MongoClient is 1.'> "wtimeout"How long to wait for WriteConcern acknowledgement. The default value for MongoClient is 10000 milliseconds.Deprecated in favour of the "wTimeoutMS" option'> "wTimeoutMS"How long to wait for WriteConcern acknowledgement. The default value for MongoClient is 10000 milliseconds.'> diff --git a/reference/mongo/mongocollection/aggregate.xml b/reference/mongo/mongocollection/aggregate.xml index 6b832b09d3..8de43e3650 100644 --- a/reference/mongo/mongocollection/aggregate.xml +++ b/reference/mongo/mongocollection/aggregate.xml @@ -48,9 +48,26 @@ options - - Array of command arguments, such as allowDiskUse, explain or cursor. - + Options for the aggregation command. Valid options include: + + + "allowDiskUse" + Allow aggregation stages to write to temporary files + + + "cursor" + + Options controlling the creation of the cursor object. If you need to + use this option, you should consider using + MongoCollection::aggregateCursor. + + + + "explain" + Return information on the processing of the pipeline. + + &mongo.command.parameters.maxtimems; + @@ -528,6 +545,7 @@ array(2) { &reftitle.seealso; + MongoCollection::aggregateCursor The MongoDB aggregation framework diff --git a/reference/mongo/mongocollection/aggregatecursor.xml b/reference/mongo/mongocollection/aggregatecursor.xml index 618fbcba5b..1fae3d1516 100644 --- a/reference/mongo/mongocollection/aggregatecursor.xml +++ b/reference/mongo/mongocollection/aggregatecursor.xml @@ -39,24 +39,23 @@ - - options - + options - - Options for the aggregation commant. - - - - "cursor" - - - It is possible to configure how many initial documents the server - should return with the first result set. The default initial batch size - is 101. You can change it by adding the - cursor option: - - + Options for the aggregation command. Valid options include: + + + "allowDiskUse" + Allow aggregation stages to write to temporary files + + + "cursor" + + It is possible to configure how many initial documents the server + should return with the first result set. The default initial batch size + is 101. You can change it by adding the + batchSize option: + + aggregateCursor( @@ -64,16 +63,24 @@ $collection->aggregateCursor( [ "cursor" => [ "batchSize" => 4 ] ] ); ]]> - - - This option does only configure the first batch size. To configure the - size of future batches, please use the - MongoCommandCursor::batchSize method on the - returned MongoCommandCursor object. - - - - + + + This option only configures the size of the first batch. To configure + the size of future batches, please use the + MongoCommandCursor::batchSize method on the + returned MongoCommandCursor object. + + + + "explain" + + Return information on the processing of the pipeline. If you need to + use this option, you should consider using + MongoCollection::aggregate. + + + &mongo.command.parameters.maxtimems; + diff --git a/reference/mongo/mongocollection/findone.xml b/reference/mongo/mongocollection/findone.xml index 8ee8e46bd2..62d4f4e189 100644 --- a/reference/mongo/mongocollection/findone.xml +++ b/reference/mongo/mongocollection/findone.xml @@ -13,6 +13,7 @@ public arrayMongoCollection::findOne arrayqueryarray() arrayfieldsarray() + arrayoptionsarray() As opposed to MongoCollection::find, this method @@ -58,15 +59,32 @@ + + + options + + + + This parameter is an associative array of the form + array("name" => <value>, ...). Currently + supported options are: + + + &mongo.command.parameters.maxtimems; + + + + &reftitle.returnvalues; Returns record matching the search or &null;. + &reftitle.errors; @@ -74,7 +92,29 @@ database. - + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 1.5.0 + + Added optional options argument. + + + + + + + &reftitle.examples; diff --git a/reference/mongo/mongocollection/group.xml b/reference/mongo/mongocollection/group.xml index 8bbbe59570..7cf64cc289 100644 --- a/reference/mongo/mongocollection/group.xml +++ b/reference/mongo/mongocollection/group.xml @@ -85,6 +85,7 @@ reduce function. + &mongo.command.parameters.maxtimems; @@ -111,6 +112,10 @@ + + 1.5.0 + Added "maxTimeMS" option. + 1.2.11 diff --git a/reference/mongo/mongoexecutiontimeoutexception.xml b/reference/mongo/mongoexecutiontimeoutexception.xml index efb86baecf..0f73c9c7ed 100644 --- a/reference/mongo/mongoexecutiontimeoutexception.xml +++ b/reference/mongo/mongoexecutiontimeoutexception.xml @@ -12,10 +12,12 @@
&reftitle.intro; - Throw when a operation times out server side (e.g. in MongoDB). + Thrown when a operation times out server side (i.e. in MongoDB). - To configure the operation timeout threshold, use MongoCursor::maxTimeMS + To configure the operation timeout threshold, use + MongoCursor::maxTimeMS or the + "maxTimeMS" command option.