MongoDB\Collection::updateOne()

On this page

Definition

Parameters
Return Values
Errors/Exceptions
Behavior
Examples
See Also

Definition

MongoDB\Collection::updateOne()

Update at most one document that matches the filter criteria. If multiple documents match the filter criteria, only the first matching document will be updated.

function updateOne(
    array|object $filter,
    array|object $update,
    array $options = []
): MongoDB\UpdateResult

Parameters

$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
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.
bypassDocumentValidation	boolean	If `true`, allows the write operation to circumvent document level validation. Defaults to `false`.
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.2 and will result in an exception at execution time if specified for an older server version. New in version 1.6.
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.
session	MongoDB\Driver\Session	Client session to associate with the operation. New in version 1.3.
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	MongoDB\Driver\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.

Return Values

A MongoDB\UpdateResult object, which encapsulates a MongoDB\Driver\WriteResult 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\BulkWriteException for errors related to the write operation. Users should inspect the value returned by getWriteResult() to determine the nature of the error.

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

If a MongoDB\Driver\Exception\BulkWriteException is thrown, users should call getWriteResult() and inspect the returned MongoDB\Driver\WriteResult object to determine the nature of the error.

For example, a write operation may have been successfully applied to the primary server but failed to satisfy the write concern (e.g. replication took too long). Alternatively, a write operation may have failed outright (e.g. unique key violation).

Examples

The following example updates one document with the restaurant_id of "40356151" by setting the name field to "Brunos on Astoria":

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$updateResult = $collection->updateOne(
    [ 'restaurant_id' => '40356151' ],
    [ '$set' => [ 'name' => 'Brunos on Astoria' ]]
);
printf("Matched %d document(s)\n", $updateResult->getMatchedCount());
printf("Modified %d document(s)\n", $updateResult->getModifiedCount());

The output would then resemble:

Matched 1 document(s)
Modified 1 document(s)