(PECL mongo >=0.9.0)
MongoCollection::update — Update records based on a given criteria
$criteria
, array $new_object
[, array $options
= array()
] ) : bool|array
criteria
Query criteria for the documents to update.
new_object
The object used to update the matched documents. This may either contain update operators (for modifying specific fields) or be a replacement document.
options
An array of options for the update operation. Currently available options include:
"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"
O valoare boolean-ă, valoarea
implicită este false
. Dacă jurnalizarea e activată, ea funcționează exact ca
"j"
. Dacă jurnalizarea nu este acticvată, atunci se forțează
sincronizarea pe disc a operațiunii de inserare înainte de a întoarce succes.
Dacă are valoarea true
, se presupune efectuarea
unei inserări cu confirmare și setarea w
va fi modificată în
0
.
Notă: Dacă jurnalizarea este activată, utilizatorii sunt încurajați să utilizeze opțiunea
"j"
în loc de"fsync"
. Nu utilizați"fsync"
și"j"
simultan, deoarece aceasta va rezulta în eroare.
"j"
O valoare boolean-ă, cu valoarea
implicită false
. Forțează sincronizarea cu jurnalul a operațiunii de inserare,
înainte de a întoarce succes. Dacă are valoarea true
, se presupune efectuarea
unei inserări cu confirmare și setarea w
va fi modificată în
0
.
Notă: Dacă această opțiune e utilizată, iar jurnalizarea e dezactivată, MongoDB 2.6+ va emite o eroare și înscrierea va eșua; versiunile mai vechi ale serverului pur și simplu vor ignora opțiunea.
"socketTimeoutMS"
Această opțiune specifică
limita de timp în milisecunde pentru comunicarea prin socket. Dacă serverul nu
răspunde în limita intervalului de timp, se va emite o
MongoCursorTimeoutException și nu va fi nici o posibilitate
de a determina dacă serverul a efectuat înscrierea, sau nu. Valoarea
-1
poate fi specificată pentru a suspenda pentru o perioadă
nedefinită. Valoarea implicită pentru MongoClient este
30000
(30 secunde).
"w"
Vedeți
WriteConcerns. Valoarea implicită
pentru MongoClient este 1
.
"wTimeoutMS"
Această opțiune specifică
limita de timp în milisecunde pentru confirmarea
write concern. Aceasta este aplicabilă
doar atunci când "w"
este mai mare decât 1
,
deoarece expirarea timpului ține de replicare. Dacă "write concern" nu este
satisfăcută în limita intervalului de timp, se va emite o MongoCursorException.
Valoarea 0
poate fi specificată pentru a suspenda pentru o
perioadă nedefinită. Valoarea implicită pentru MongoClient
este 10000
(zece secunde).
The following options are deprecated and should no longer be used:
"safe"
Învechită. Utilizați opțiunea
WriteConcern
w
.
"timeout"
Un pseudonim învechit pentru "socketTimeoutMS"
.
"wtimeout"
Un pseudonim învechit pentru
"wTimeoutMS"
.
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().
Generează o excepție MongoCursorException dacă opțiunea
"w"
este stabilită și înscrierea eșuează.
Generează o excepție
MongoCursorTimeoutException dacă opțiunea
"w"
este stabilită la o valoare mai mare decât unu și
operațiunea durează mai mult de MongoCursor::$timeout
milisecunde. Aceasta nu va întrerupe operațiunea pe server, este un timeout de
partea clientului. Operațiunea din MongoCollection::$wtimeout
este în milisecunde.
Versiune | Descriere |
---|---|
PECL mongo 1.5.0 |
Added the
Added the
Emits |
PECL mongo 1.3.4 | Added "wtimeout" option. |
PECL mongo 1.3.0 |
Added
The |
PECL mongo 1.2.11 |
Emits E_DEPRECATED when
options is scalar.
|
PECL mongo 1.2.0 | Added "timeout" option. |
PECL mongo 1.0.11 |
Disconnects on "not master" errors if "safe" is set.
|
PECL mongo 1.0.9 |
Added ability to pass integers to the
Added
The return type was changed to be an array containing error information
if the |
PECL mongo 1.0.5 | Added "safe" option. |
PECL mongo 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")));
?>
Exemplul de mai sus va afișa ceva similar cu:
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());
?>
Exemplul de mai sus va afișa ceva similar cu:
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());
?>
Exemplul de mai sus va afișa ceva similar cu:
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.