MongoDB\Driver\BulkWrite::update

(mongodb >=1.0.0)

MongoDB\Driver\BulkWrite::updateAdd an update operation to the bulk

说明

public MongoDB\Driver\BulkWrite::update ( array|object $filter , array|object $newObj [, array $updateOptions ] ) : void

Adds an update operation to the MongoDB\Driver\BulkWrite.

参数

filter ( array|object)

The » query predicate. An empty predicate will match all documents in the collection.

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

newObj ( array|object)

A document containing either update operators (e.g. $set) or a replacement document (i.e. only field:value expressions).

updateOptions

updateOptions
Option Type Description Default
arrayFilters array|object

An array of filter documents that determines which array elements to modify for an update operation on an array field. See » Specify arrayFilters for Array Update Operations in the MongoDB manual for more information.

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

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.

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

multi boolean Update only the first matching document if FALSE, or all matching documents TRUE. This option cannot be TRUE if newObj is a replacement document. FALSE
upsert boolean If filter does not match an existing document, insert a single document. The document will be created from newObj if it is a replacement document (i.e. no update operators); otherwise, the operators in newObj will be applied to filter to create the new document. FALSE

返回值

没有返回值。

错误/异常

更新日志

版本 说明
1.5.0 Using the "arrayFilters" option will result in an exception at execution time if unsupported by the server. Previously, no exception would be thrown and the option may have been ignored.
1.4.0 Added the "arrayFilters" option.
1.2.0 Added the "collation" option.

范例

Example #1 MongoDB\Driver\BulkWrite::update() example

<?php

$bulk 
= new MongoDB\Driver\BulkWrite;
$bulk->update(
    [
'x' => 2],
    [
'$set' => ['y' => 3]],
    [
'multi' => false'upsert' => false]
);

$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$result $manager->executeBulkWrite('db.collection'$bulk);

?>

参见

相关文章
php mongodb driver the mongodb driver bulkwrite classphp mongodb driver exception the mongodb driver exception bulkwriteexception classphp mongodb driver monitoring the mongodb driver monitoring subscriber interfacephp mongodb driver bulkwrite create a new bulkwritephp mongodb driver bulkwrite count number of write operations in the bulkphp mongodb driver bulkwrite add a delete operation to the bulkphp mongodb driver bulkwrite add an insert operation to the bulkphp mongodb driver bulkwrite add an update operation to the bulkphp mongodb driver cursor checks if the cursor may have additional resultsphp mongodb driver manager select a server matching a read preferencephp mongodb driver monitoring commandfailedevent returns the command s operation idphp mongodb driver monitoring commandstartedevent returns the command s operation idphp mongodb driver monitoring commandsubscriber notification method for a started commandphp mongodb driver monitoring commandsucceededevent returns the command s operation idphp mongodb driver readpreference returns the readpreference s mode optionphp mongodb driver server checks if this server is an arbiter member of a replica setphp mongodb driver writeerror returns the index of the write operation corresponding to this writeerrorphp mongodb driver writeerror returns additional metadata for the writeerrorphp mongodb driver exception writeexception returns the writeresult for the failed write operationphp mongodb driver writeresult returns the number of documents selected for update
关注编程学问公众号