MongoCollection::save
(PECL mongo >=0.9.0)
MongoCollection::save — Saves an object to this collection
Description
If the object is from the database, update the existing database object, otherwise insert this object.
Parameters
- a
-
Array to save.
- options
-
Options for the save.
-
"safe"
Can be a boolean or integer, defaults to FALSE. If FALSE, the program continues executing without waiting for a database response. If TRUE, the program will wait for the database response and throw a MongoCursorException if the insert did not succeed.
If you are using replication and the master has changed, using "safe" will make the driver disconnect from the master, throw and exception, and attempt to find a new master on the next operation (your application must decide whether or not to retry the operation on the new master).
If you do not use "safe" with a replica set and the master changes, there will be no way for the driver to know about the change so it will continuously and silently fail to write.
If safe is an integer, will replicate the insert to that many machines before returning success (or throw an exception if the replication times out, see wtimeout). This overrides the w variable set on the collection.
-
"fsync"
Boolean, defaults to FALSE. Forces the insert to be synced to disk before returning success. If TRUE, a safe insert is implied and will override setting safe to FALSE.
-
Return Values
If safe was set, returns an array containing the status of the save. Otherwise, returns a boolean representing if the array was not empty (an empty array will not be inserted).
Errors/Exceptions
Throws MongoCursorException if the "safe" option is set and the save fails.
Throws MongoCursorTimeoutException if the "safe" option is set to a value greater than one and the database cannot replicate the operation in MongoCollection::$wtimeout milliseconds.
Changelog
| Version | Description |
|---|---|
| 1.0.5 | Added "options" parameter. |
| 1.0.9 | Added ability to pass integers to "safe" options (only accepted booleans before) and added "fsync" option. |
| 1.0.11 | Disconnects on "not master" errors if "safe" is set. |
Examples
Example #1 MongoCollection::save() example
<?php
$obj = array('x' => 1);
// insert $obj into the db
$collection->save($obj);
// add another field
$obj['foo'] = 'bar';
// $obj cannot be inserted again, causes duplicate _id error
$collection->insert($obj);
// save updates $obj with the new field
$collection->save($obj);
?>