MongoCollectionMongoCollection::batchInsert
(PECL mongo >=0.9.0)
MongoCollection::batchInsert — 複数のドキュメントをコレクションに追加する
説明
パラメータ
-
a -
配列の配列。
-
options -
追加時のオプション。
-
"safe"
boolean あるいは整数値で、デフォルトは
FALSEです。FALSEの場合、データベースからの応答を待たずにプログラムを続行します。TRUEの場合、プログラムはデータベースからの応答を待ち、 追加に失敗したときには MongoCursorException をスローします。safe が整数値の場合は、 指定した数のマシンで追加が成功するまでは成功したと見なしません (処理がタイムアウトした場合は例外をスローします。wtimeout を参照ください)。 これは、コレクションに設定された w 変数をオーバーライドします。
-
"fsync"
boolean で、デフォルトは
FALSEです。 追加操作がディスク上に同期されるまで成功とは見なさないようにさせます。TRUEの場合は "安全な" 追加操作が前提となり、 safe の設定をFALSEにオーバーライドします。 -
"continueOnError"
boolean で、デフォルトは
FALSEです。 これを設定すると、(ID の重複などが原因で) 一括インサートが失敗したときにもデータベースは処理を続行します。 その結果、一括インサート処理の挙動が一件ごとのインサートを繰り返したときと同じになります。 ただし、MongoDB::lastError() をコールすると、 直近の操作が失敗していなくても何か失敗があればエラーが設定されています。 複数のエラーが発生したときには、 MongoDB::lastError() が返すのは最後に発生したエラーだけとなります。
-
返り値
"safe" が設定されているときは、追加の状況 ("ok") と発生したエラー ("err")
を連想配列で返します。設定されていないときは、一括追加の送信に成功すれば
TRUE、失敗すれば FALSE を返します。
エラー / 例外
"safe" オプションが設定されていて追加に失敗した場合に MongoCursorException をスローします。
"safe" オプションが 1 より大きい整数値に設定されているとき、 MongoCollection::$wtimeout ミリ秒以内に処理が終わらなかった場合に MongoCursorTimeoutException をスローします。
変更履歴
| バージョン | 説明 |
|---|---|
| 1.0.5 | "options" パラメータが追加されました。 |
| 1.0.9 | "safe" オプションに整数値がわたせるようになり (以前は booleans のみでした)、さらに "fsync" オプションが追加されました。 |
| 1.2.7 | continueOnError フラグが追加されました。 |
例
例1 MongoCollection::batchInsert() の例
バッチ挿入を使用すると、多くの要素を一度にデータベースに追加できます。
<?php
$users = array();
for ($i = 0; $i<100; $i++) {
$users[] = array('username' => 'user'.$i, 'i' => $i);
}
$mongo = new Mongo();
$collection = $mongo->my_db->users;
$collection->drop();
$collection->batchInsert($users);
foreach ($users as $user) {
echo $user['_id']."\n"; // MongoId のインスタンスが格納されています
}
$users = $collection->find()->sort(array('i' => 1));
foreach ($users as $user) {
var_dump($user['username']);
}
?>
上の例の出力は、 たとえば以下のようになります。
4bf43ac68ead0e1971000000 4bf43ac68ead0e1971010000 4bf43ac68ead0e1971020000 ... string(5) "user1" string(5) "user2" string(5) "user3" ...
例2 MongoCollection::batchInsert() でエラーを無視する例
<?php
$con = new Mongo;
$db = $con->demo;
$doc1 = array(
'_id' => new MongoId('4cb4ab6d7addf98506010001'),
'id' => 1,
'desc' => "ONE",
);
$doc2 = array(
'_id' => new MongoId('4cb4ab6d7addf98506010002'),
'id' => 2,
'desc' => "TWO",
);
$doc3 = array(
'_id' => new MongoId('4cb4ab6d7addf98506010002'), // same _id as above
'id' => 3,
'desc' => "THREE",
);
$doc4 = array(
'_id' => new MongoId('4cb4ab6d7addf98506010004'),
'id' => 4,
'desc' => "FOUR",
);
$c = $db->selectCollection('c');
$c->batchInsert(
array($doc1, $doc2, $doc3, $doc4),
array('continueOnError' => true)
);
$docs = $c->find();
foreach ($docs as $doc) {
var_dump($doc['desc']);
}
?>
上の例の出力は、 たとえば以下のようになります。
string(3) "ONE" string(3) "TWO" string(4) "FOUR"
参考
- MongoCollection::insert() - 配列をコレクションに追加する
- MongoCollection::update() - 指定した条件にもとづいてレコードを更新する
- MongoCollection::find() - コレクションに問い合わせ、結果セットの MongoCursor を返す
- MongoCollection::remove() - レコードをコレクションから削除する
- MongoDB コアドキュメントの » insert
add a note
User Contributed Notes
MongoCollection::batchInsert