MongoDB\Collection::findOneAndUpdate()

On this page

Definition
Return Values
Errors/Exceptions
Behavior
Examples
See Also

Definition

MongoDB\Collection::findOneAndUpdate

Finds a single document matching the query and updates it.

function findOneAndUpdate($filter, $update, array $options = []): object|null

This method has the following parameters:

Parameter	Type	Description
`$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	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.
`arrayFilters`	array	Optional. An array of filter documents that determines which array elements to modify for an update operation on an array field. This is not supported for server versions prior to 3.6 and will result in an exception at execution time if used. New in version 1.3.
`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. This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version. 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.
`hint`	string\|array\|object	Optional. 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 in 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	Optional. The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
`bypassDocumentValidation`	boolean	Optional. If `true`, allows the write operation to circumvent document level validation. Defaults to `false`. This option is available in MongoDB 3.2+ and is ignored for older server versions, which do not support document level validation.
`returnDocument`	integer	Optional. 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`	MongoDB\Driver\Session	Optional. Client session to associate with the operation. Sessions are not supported for server versions prior to 3.6. New in version 1.3.
`typeMap`	array	Optional. 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	Optional. 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`	MongoDB\Driver\WriteConcern	Optional. 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 with startTransaction. This is not supported for server versions prior to 3.2 and will result in an exception at execution time if used.

Return Values

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.

Errors/Exceptions

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 driver 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 driver (e.g. use MongoDB\BSON\ObjectId to match an ObjectId).

Examples

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":

copy

<?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"
      }
    }
  }
}