(PECL mongo >=0.9.0)
MongoCollection::update — Update records based on a given criteria
$criteria
, array $new_object
[, array $options = array()
] )
criteria
Description of the objects to update.
new_object
The object with which to update the matching records.
options
This parameter is an associative array of the form array("optionname" => <boolean>, ...). Currently supported options are:
"w"
See WriteConcerns. The default value for MongoClient is 1.
"upsert"
If no document matches $criteria, a new
document will be inserted.
If a new document would be inserted and
$new_object contains atomic modifiers
(i.e. $ operators), those operations will be
applied to the $criteria parameter to create
the new document. If $new_object does not
contain atomic modifiers, it will be used as-is for the inserted
document. See the upsert examples below for more information.
"multiple"
All documents matching $criteria will be updated. MongoCollection::update() has exactly the opposite behavior of MongoCollection::remove(): it updates one document by default, not all matching documents. It is recommended that you always specify whether you want to update multiple documents or a single document, as the database may change its default behavior at some point in the future.
"fsync"
Boolean, defaults to FALSE. Forces the insert to be synced to disk before returning success. If TRUE, an acknowledged insert is implied and will override setting w to 0.
"timeout"
Integer, defaults to MongoCursor::$timeout. If "safe" is set, this sets how long (in milliseconds) for the client to wait for a database response. If the database does not respond within the timeout period, a MongoCursorTimeoutException will be thrown.
"safe"
Deprecated. Please use the WriteConcern w option.
Returns an array containing the status of the update if the
"w" option is set. Otherwise, returns TRUE.
Fields in the status array are described in the documentation for MongoCollection::insert().
Throws MongoCursorException if the "w" option is set and the write fails.
Throws MongoCursorTimeoutException if the "w" option is set to a value greater than one and the operation takes longer than MongoCursor::$timeout milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in MongoCollection::$wtimeout is milliseconds.
| Version | Description |
|---|---|
| 1.3.0 |
The options parameter no longer accepts a boolean
to signify an upsert. Instead, this now has to be done with
array('upsert' => true).
|
| 1.2.11 |
Emits E_DEPRECATED when
options is scalar.
|
| 1.2.0 | Added "timeout" option. |
| 1.0.11 | Disconnects on "not master" errors if "safe" is set. |
| 1.0.9 |
Added ability to pass integers to the "safe" option, which previously only accepted booleans. Added "fsync" option. The return type was changed to be an array containing error information if the "safe" option is used. Otherwise, a boolean is returned as before. |
| 1.0.5 | Added "safe" option. |
| 1.0.1 |
Changed options parameter from boolean to array.
Pre-1.0.1, the second parameter was an optional boolean value specifying
an upsert.
|
Example #1 MongoCollection::update()
Adding an address field to a document.
<?php
$c->insert(array("firstname" => "Bob", "lastname" => "Jones" ));
$newdata = array('$set' => array("address" => "1 Smith Lane"));
$c->update(array("firstname" => "Bob"), $newdata);
var_dump($c->findOne(array("firstname" => "Bob")));
?>
The above example will output something similar to:
array(4) {
["_id"]=>
object(MongoId)#6 (0) {
}
["firstname"]=>
string(3) "Bob"
["lastname"]=>
string(5) "Jones"
["address"]=>
string(12) "1 Smith Lane"
}
Example #2 MongoCollection::update() upsert examples
Upserts can simplify code, as a single line can create the document if it
does not exist (based on $criteria), or update an
existing document if it matches.
In the following example, $new_object contains an
atomic modifier. Since the collection is empty and upsert must insert a new
document, it will apply those operations to the
$criteria parameter in order to create the document.
<?php
$c->drop();
$c->update(
array("uri" => "/summer_pics"),
array('$inc' => array("page hits" => 1)),
array("upsert" => true)
);
var_dump($c->findOne());
?>
The above example will output something similar to:
array(3) {
["_id"]=>
object(MongoId)#9 (0) {
}
["uri"]=>
string(12) "/summer_pics"
["page hits"]=>
int(1)
}
If $new_object does not contain atomic modifiers
(i.e. $ operators), upsert will use
$new_object as-is for the new document. This matches
the behavior of a normal update, where not using atomic modifiers causes the
document to be overwritten.
<?php
$c->drop();
$c->update(
array("name" => "joe"),
array("username" => "joe312", "createdAt" => new MongoDate()),
array("upsert" => true)
);
var_dump($c->findOne());
?>
The above example will output something similar to:
array(3) {
["_id"]=>
object(MongoId)#10 (0) {
}
["username"]=>
string(6) "joe312"
["createdAt"]=>
object(MongoDate)#4 (0) {
}
}
Example #3 MongoCollection::update() multiple example
By default, MongoCollection::update() will only update
the first document matching $criteria that it
finds. Using the "multiple" option can override this behavior, if needed.
This example adds a "gift" field to every person whose birthday is in the next day.
<?php
$today = array('$gt' => new MongoDate(), '$lt' => new MongoDate(strtotime("+1 day")));
$people->update(
array("birthday" => $today),
array('$set' => array('gift' => $surprise)),
array("multiple" => true)
);
?>
The PHP documentation on updates and the » MongoDB core docs.