MongoDB\ClientBulkWrite::updateOne()

Definition

MongoDB\ClientBulkWrite::updateOne()

Specify an update operation in the bulk write command for the first matching document. This method returns the MongoDB\ClientBulkWrite instance on which it's called.

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

Parameters

$filter : array|object

The filter criteria that specifies the documents to update.

$update : array|object

The field and value combinations to update and any relevant update operators. $update uses MongoDB's update operators. You can pass an aggregation pipeline 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.
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.
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.
sort	array|object	The sort specification for the ordering of the matched documents. Set this option to apply an order to matched documents before the server performs the update operation.
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.

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\BulkWriteCommandException for errors related to the write operation. You can inspect the value returned by getWriteErrors() 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\BulkWriteCommandException is thrown, you can call getWriteErrors() and inspect the information in the returned array 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. Alternatively, a write operation may have failed outright, for example for violating the unique key constraint.

See Also

• Client Bulk Write section of the Bulk Write Operations guide