MongoWriteBatch::execute
(PECL mongo >= 1.5.0)
MongoWriteBatch::execute — Executes a batch of write operations
Description
$write_options
) : arrayExecutes the batch of write operations.
Return Values
Returns an array containing statistical information for the full batch. If the batch had to be split into multiple batches, the return value will aggregate the values from individual batches and return only the totals.
If the batch was empty, an array containing only the 'ok' field is returned (as TRUE) although
nothing will be shipped over the wire (NOOP).
| Array key | Value meaning | Returned for batch type |
|---|---|---|
| nInserted | Number of inserted documents | MongoWriteBatch::COMMAND_INSERT batch |
| nMatched | Number of documents matching the query criteria | MongoWriteBatch::COMMAND_UPDATE batch |
| nModified | Number of documents actually needed to be modied | MongoWriteBatch::COMMAND_UPDATE batch |
| nUpserted | Number of upserted documents | MongoWriteBatch::COMMAND_UPDATE batch |
| nRemoved | Number of documents removed | MongoWriteBatch::COMMAND_DELETE batch |
| ok | Command success indicator | All |
Examples
Example #1 MongoWriteBatch::add() example
Batching up multiple insert operations
<?php
$mc = new MongoClient("localhost");
$collection = $mc->selectCollection("test", "test");
$docs = array();
$docs[] = array("my" => "demo");
$docs[] = array("is" => "working");
$docs[] = array("pretty" => "well");
$batch = new MongoInsertBatch($collection);
foreach($docs as $document) {
$batch->add($document);
}
$retval = $batch->execute(array("w" => 1));
var_dump($retval);
?>
The above example will output:
array(2) {
["nInserted"]=>
int(3)
["ok"]=>
bool(true)
}
Example #2 MongoWriteBatch::add() example
Batching up multiple update operations
<?php
$mc = new MongoClient("localhost");
$collection = $mc->selectCollection("test", "test");
$item1 = array(
"q" => array("my" => "demo"),
"u" => array('$set' => array("try" => 1)),
"multi" => false, /* default value */
"upsert" => false, /* default value */
);
$item2 = array(
"q" => array("is" => "working"),
"u" => array('$set' => array("try" => 2)),
"multi" => true,
);
$item3 = array(
"q" => array("created" => "new-document"),
"u" => array('$set' => array("try" => 3)),
"upsert" => true,
);
$batch = new MongoUpdateBatch($collection);
$batch->add($item1);
$batch->add($item2);
$batch->add($item3);
$retval = $batch->execute(array("w" => 1));
var_dump($retval);
?>
The above example will output:
array(4) {
["nMatched"]=>
int(18)
["nModified"]=>
int(2)
["nUpserted"]=>
int(0)
["ok"]=>
bool(true)
}
Example #3 MongoWriteBatch::add() example
Batching up multiple delete operations
<?php
$mc = new MongoClient("localhost");
$collection = $mc->selectCollection("test", "test");
$item1 = array(
"q" => array("my" => "demo"),
"limit" => 1,
);
$item2 = array(
"q" => array("try" => 3),
"limit" => 1,
);
$batch = new MongoDeleteBatch($collection);
$batch->add($item1);
$batch->add($item2);
$retval = $batch->execute(array("w" => 1));
var_dump($retval);
?>
The above example will output:
array(2) {
["nRemoved"]=>
int(1)
["ok"]=>
bool(true)
}
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-mongowritebatch.execute.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
