Docs Menu
Docs Home
/ / /
PHP Library Manual
/ /

MongoDB\Collection::findOneAndUpdate()

On this page

  • Definition
  • Parameters
  • Return Values
  • Errors/Exceptions
  • Behavior
  • Examples
  • See Also
MongoDB\Collection::findOneAndUpdate()

Finds a single document matching the query and updates it.

function findOneAndUpdate(
array|object $filter,
array|object $update,
array $options = []
): object|null
$filter : array|object
The filter criteria that specifies the documents to update.
$update : array|object
Specifies the field and value combinations to update and any relevant update operators. $update uses MongoDB's update operators. Starting with MongoDB 4.2, an aggregation pipeline can be passed as this parameter.
$options : array

An array specifying the desired options.

Name
Type
Description
bypassDocumentValidation
boolean
If true, allows the write operation to circumvent document level validation. Defaults to false.
arrayFilters
array

An array of filter documents that determines which array elements to modify for an update operation on an array field.

New in version 1.3.

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.

comment
mixed

Enables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs.

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

New in version 1.13.

hint
string|array|object

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

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

New in version 1.7.

maxTimeMS
integer

The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.

let
array|object

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

projection
array|object
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.
returnDocument
integer

Specifies whether to return the document before the update is applied, or after. returnDocument supports the following values:

  • MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_BEFORE (default)

  • MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER

session

Client session to associate with the operation.

New in version 1.3.

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

The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the collection's type map.

This will be used for the returned result document.

upsert
boolean
If set to true, creates a new document when no document matches the query criteria. The default value is false, which does not insert a new document when no match is found.
writeConcern

Write concern to use for the operation. Defaults to the collection's write concern.

It is not possible to specify a write concern for individual operations as part of a transaction. Instead, set the writeConcern option when starting the transaction.

An array or object for either the original or the updated document, depending on the specified value of the returnDocument option. By default, the original document is returned. If no document matched the query, null is returned. The return type will depend on the typeMap option.

MongoDB\Exception\UnexpectedValueException if the command response from the server was malformed.

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

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

The following operation updates the restaurant with restaurant_id of "40361708" in the restaurants collection in the test database by setting its building number to "761":

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$updatedRestaurant = $collection->findOneAndUpdate(
[ 'restaurant_id' => '40361708' ],
[ '$set' => [ 'address.building' => '761' ]],
[
'projection' => [ 'address' => 1 ],
'returnDocument' => MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER,
]
);
var_dump($updatedRestaurant);

The output would then resemble:

object(MongoDB\Model\BSONDocument)#20 (1) {
["storage":"ArrayObject":private]=>
array(2) {
["_id"]=>
object(MongoDB\BSON\ObjectId)#12 (1) {
["oid"]=>
string(24) "594d5ef280a846852a4b3dee"
}
["address"]=>
object(MongoDB\Model\BSONDocument)#19 (1) {
["storage":"ArrayObject":private]=>
array(4) {
["building"]=>
string(3) "761"
["coord"]=>
object(MongoDB\Model\BSONArray)#18 (1) {
["storage":"ArrayObject":private]=>
array(2) {
[0]=>
float(-73.9925306)
[1]=>
float(40.7309346)
}
}
["street"]=>
string(8) "Broadway"
["zipcode"]=>
string(5) "10003"
}
}
}
}

Back

findOneAndReplace()

Next

getCollectionName()