MongoCollection::update
(PECL mongo >=0.9.0)
MongoCollection::update — Update records based on a given criteria
Описание
$criteria
, array $new_object
[, array $options = 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_objectcontains atomic modifiers (i.e. $ operators), those operations will be applied to the$criteriaparameter to create the new document. If$new_objectdoes 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"
Булево, по умолчанию
FALSE. Если включено журналирование, то работает также как и "j". Если журналирование не включено, то операции записи блокируются пока не будут синхронизированы с файлами на жестком диске. ЕслиTRUE, то применяется подтвержденная вставка и эта опция переопределяет опцию "w" в значение 0.Замечание: Если журналирование включено, то пользователю настоятельно рекомендуется использовать опцию "j" вместо "fsync". Не используйте "fsync" и "j" одновременно,так как это может привести к ошибке.
"j"
Булево, по умолчанию
FALSE. Блокирует операции записи пока они не будут синхронизированы с журналом на диске. ЕслиTRUE, то применяется подтвержденная вставка и эта опция переопределяет опцию "w" в значение 0.Замечание: Если применяется эта опция и журналирование отключено, то MongoDB 2.6+ выбросит ошибку и прервет запись; старые версии сервера просто игнорируют эту опцию.
"socketTimeoutMS"
Эта опция определяет время в миллисекундах для общения в socket. Если сервер не ответил за отведенное время, то будет брошено исключение MongoCursorTimeoutException, и не будет никакой возможности определить произвел ли сервер запись или нет. Значение -1 используется для постоянно отключения этой функции. Значением по умолчанию для MongoClient является 30000 (30 секунд).
"w"
Смотрите Контроль записи. Значение по умолчанию для MongoClient является 1.
"wTimeoutMS"
Эта опция определяет лимит времени в миллисекундах для подтверждения контроля записи. Она применима только, если "w" больше 1, так как ограничение времени относится к репликации. Если контроль записи не подтвержден за отведенное время, то будет выброшено исключение MongoCursorException. Значение 0 для постоянного отключения. Значением по умолчанию для MongoClient является 10000 (десять секунд).
The following options are deprecated and should no longer be used:
"safe"
Устаревшая опция. Используйте опцию "w" контроля записи.
"timeout"
Устаревший псевдоним для "socketTimeoutMS".
"wtimeout"
Устаревший псевдоним для "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().
Ошибки
Исключение MongoCursorException бросается, если установлена опция "w" и не прошла запись.
Исключение MongoCursorTimeoutException бросается, если опция "w" установлена в значение больше одного и операция заняла больше, чем MongoCursor::$timeout миллисекунд. При этом операция на сервере не прерывается, так как это ограничение времени работает на клиентской стороне. Операция в миллисекундах в MongoCollection::$wtimeout.
Список изменений
| Версия | Описание |
|---|---|
| 1.5.0 |
Added the "wTimeoutMS" option, which replaces
"wtimeout". Emits
Added the "socketTimeoutMS" option, which replaces
"timeout". Emits
Emits |
| 1.3.4 | Added "wtimeout" option. |
| 1.3.0 |
Added "w" option.
The |
| 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.
|
Примеры
Пример #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")));
?>
Результатом выполнения данного примера будет что-то подобное:
array(4) {
["_id"]=>
object(MongoId)#6 (0) {
}
["firstname"]=>
string(3) "Bob"
["lastname"]=>
string(5) "Jones"
["address"]=>
string(12) "1 Smith Lane"
}
Пример #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());
?>
Результатом выполнения данного примера будет что-то подобное:
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());
?>
Результатом выполнения данного примера будет что-то подобное:
array(3) {
["_id"]=>
object(MongoId)#10 (0) {
}
["username"]=>
string(6) "joe312"
["createdAt"]=>
object(MongoDate)#4 (0) {
}
}
Пример #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.
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения для работы с базами данных
- Расширения для работы с базами данных отдельных производителей
- MongoDB
- Базовые классы
- Функция MongoCollection::aggregate() - Perform an aggregation using the aggregation framework
- Функция MongoCollection::aggregateCursor() - Execute an aggregation pipeline command and retrieve results through a cursor
- Функция MongoCollection::batchInsert() - Inserts multiple documents into this collection
- Функция MongoCollection::__construct() - Creates a new collection
- Функция MongoCollection::count() - Counts the number of documents in this collection
- Функция MongoCollection::createDBRef() - Creates a database reference
- Функция MongoCollection::createIndex() - Creates an index on the specified field(s) if it does not already exist.
- Функция MongoCollection::deleteIndex() - Deletes an index from this collection
- Функция MongoCollection::deleteIndexes() - Delete all indices for this collection
- Функция MongoCollection::distinct() - Retrieve a list of distinct values for the given key across a collection.
- Функция MongoCollection::drop() - Drops this collection
- Функция MongoCollection::ensureIndex() - Creates an index on the specified field(s) if it does not already exist.
- MongoCollection::find
- Функция MongoCollection::findAndModify() - Update a document and return it
- Функция MongoCollection::findOne() - Queries this collection, returning a single element
- Функция MongoCollection::__get() - Gets a collection
- Функция MongoCollection::getDBRef() - Fetches the document pointed to by a database reference
- Функция MongoCollection::getIndexInfo() - Returns information about indexes on this collection
- Функция MongoCollection::getName() - Returns this collection's name
- Функция MongoCollection::getReadPreference() - Get the read preference for this collection
- Функция MongoCollection::getSlaveOkay() - Get slaveOkay setting for this collection
- Функция MongoCollection::getWriteConcern() - Get the write concern for this collection
- Функция MongoCollection::group() - Performs an operation similar to SQL's GROUP BY command
- Функция MongoCollection::insert() - Inserts a document into the collection
- Функция MongoCollection::parallelCollectionScan() - Returns an array of cursors to iterator over a full collection in parallel
- Функция MongoCollection::remove() - Remove records from this collection
- Функция MongoCollection::save() - Saves a document to this collection
- Функция MongoCollection::setReadPreference() - Set the read preference for this collection
- Функция MongoCollection::setSlaveOkay() - Change slaveOkay setting for this collection
- Функция MongoCollection::setWriteConcern() - Set the write concern for this database
- Функция MongoCollection::toIndexString() - Converts keys specifying an index to its identifying string
- Функция MongoCollection::__toString() - String representation of this collection
- Функция MongoCollection::update() - Update records based on a given criteria
- Функция MongoCollection::validate() - Validates this collection
Коментарии
The return type of update changed in 1.09 if you are using safe => TRUE. It now returns something that looks like the info returned by MongoDB::lastError:
Array
(
[err] =>
[updatedExisting] => 1
[n] => 1
[ok] => 1
)
Do note, for incrementing a value using $inc, typecast the value to an integer before passing the new object to update().
<?php
$votes = (int) $votes;
$newData = array('$inc' => array('votes'=>$votes));
$c->update(array("firstname" => "Bob"), $newData);
?>
This is especially noteworthy, if you are taking values from $_GET and pushing them for increment.
Please note under optional third parameter "options":
While the official MongoDB documentation references the keyword "multi" to flag the use of multiple updates, the PHP implementation uses the key "multiple" instead.
This may cause a little confusion if you're basing your keys on the OFFICIAL MongoDB documentation.
For anyone referencing records by the Mongo _id object, it's important to recognise that it is in fact an object, and not a string.
If you have a record with a Mongo ID of say "4e519d5118617e88f27ea8cd" that you are trying to retrieve or update, you cannot search for it using something like:
<?php
$m = new Mongo();
$db = $m->selectDB('db');
$collection = 'collection';
$db->$collection->findOne(array('_id', '4e519d5118617e88f27ea8cd'));
?>
There is some documentation that mentions simple conversion to string will solve this, but I have found the only reliable way to locate records based on their ID is to first pass it to MondoID(), then use that for reference.
Something like this will be far more reliable:
<?php
$m = new Mongo();
$db = $m->selectDB('db');
$collection = 'collection';
$mongoID = new MongoID('4e519d5118617e88f27ea8cd');
$db->$collection->findOne(array('_id', $mongoID));
?>
This may prove useful for anyone using the ID object like an auto-increment database key would be used in MySQL or similar.
if you want emulate on mongoDb "insert on duplicate key update" in SQL notation, you must use flag "upsert" with "$set" in "update" operation.
In this sample uses unique key (user id and product id) and date user visit product:page. Each execute this code make update 'lasttime' field:
<?php
$client = new MongoClient(MONGO_DB);
$users = $client->users;
$last_views = $users->createCollection('last_views');
// create unique index
$result = $last_views->ensureIndex(
array("user_id" => 1, "warecode" => 1),
array("unique" => 1)
);
$uviews = new stdClass();
$uviews->user_id = $this->user_id;
$uviews->warecode = $this->warecode;
$res = $users->last_views->update(
$uviews,
array('$set' => array('lasttime' => new MongoTimestamp())),
array('upsert' => true)
);
?>
Re. nerds @ limeworks comment:Thanks for your helpful tip - right what I was looking for. One note, though: Instead of comma, it's a => as in:
<?php
...->findOne(array('_id' => $mongoID);
?>
A need for an app was to add a new entry to the industries collection if it didn't already exist, and pass that "string" _id back to the caller to add it to the businesses collection (as a string also - database design by others.... :))
function GetIndustryID($db, $industry_name_eng, $industry_name_rus) {
// $db is the MongoDB database object
// $industry_name_eng is English of the industry name
// $industry_name_rus is Russian of the industry name
if ( $industry_name_eng == "" && $industry_name_rus == "" ) {
return "";
exit;
}
// lookup russian version
// of industry name from industries collection and try to return the _id
// if not found, add this as a new document and return its _id
// $c_ind = industry collection object
// "industries" is the collection name
$c_ind = $db->industries;
// you could use findOne here....
$cursor = $c_ind->find(array('industry_name.russian' => $industry_name_rus));
if ( $cursor->hasNext() ) {
foreach ( $cursor as $document ) {
$id = $document['_id'];
}
} else {
// not found here - go add it
$document = array(
"industry_id" => "",
"industry_name" => array("english" => $industry_name_eng, "russian" => $industry_name_rus )
);
$db->industries->insert($document);
$id = $document['_id'];
// update the industry_id in the industries collection
// with the id returned - because we just added it, and
// we need the industry_id the same as the _id
// see: mongocollection.update
// update ( array $criteria , array $new_object [, array $options = array() ] )
// note how I cast the MongoID "object" to a string
$document['industry_id'] = (string)$id;
// the $id in the next line is the ObjectID, not a string.
$db->industries->update(array("_id" => $id), $document, array("upsert" => true));
}
return (string)$id;
}
Results: (using RoboMongo)
{
"_id" : ObjectId("5427acf7a495dbd420b2e2ea"),
"industry_id" : "5427acf7a495dbd420b2e2ea",
"industry_name" : {
"english" : "Oil and Gas",
"russian" : "Нефть, Газ, Энергетика"
}
}
It took me ages to work this out. Hope it helps someone else.
$inc and set in one statement<?php
$m = new Mongo();
$db = $m->selectDB('db');
$collection = 'collection';
$db->$collection->insert(array("firstname" => "Nanhe", "lastname" => "Kumar","attempt"=>1 ));
$newdata = array('$inc'=>array("attempt"=>1),'$set' => array("address" => "Delhi India"));
$db->$collection->update(array("firstname" => "Nanhe"), $newdata);
?>