MongoCollection
PHP Manual

MongoCollection::batchInsert

(PECL mongo >=0.9.0)

MongoCollection::batchInsertInserts multiple documents into this collection

Descrierea

public mixed MongoCollection::batchInsert ( array $a [, array $options = array() ] )

Parametri

a

An array of arrays or objects. If any objects are used, they may not have protected or private properties.

Notă:

If the documents to insert do not have an _id key or property, a new MongoId instance will be created and assigned to it. See MongoCollection::insert() for additional information on this behavior.

options

An array of options for the batch of insert operations. Currently available options include:

  • "continueOnError"

    Boolean, defaults to FALSE. If set, the database will not stop processing a bulk insert if one fails (eg due to duplicate IDs). This makes bulk insert behave similarly to a series of single inserts, except that calling MongoDB::lastError() will have an error set if any insert fails, not just the last one. If multiple errors occur, only the most recent will be reported by MongoDB::lastError().

    Notă:

    Please note that continueOnError affects errors on the database side only. If you try to insert a document that has errors (for example it contains a key with an empty name), then the document is not even transferred to the database as the driver detects this error and bails out. continueOnError has no effect on errors detected in the documents by the driver.

  • "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ă:

    Această opțiune e învechită. Utilizați în loc opțiunea "j".

  • "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.

  • "socketTimeoutMS"

    Integer, defaults to MongoCursor::$timeout. If acknowledged writes are used, this sets how long (in milliseconds) for the client to wait for a database response. If the database does not respond within the timeout period, a MongoCursorTimeoutException will be thrown.

  • "w"

    Vedeți WriteConcerns. Valoarea implicită pentru MongoClient este 1.

  • "wTimeoutMS"

    How long to wait for write concern acknowledgement. The default value for MongoClient is 10000 milliseconds.

The following options are deprecated and should no longer be used:

  • "safe"

    Dezaprobat. Utilizați opțiunea WriteConcern w.

  • "timeout"

    O valoare de tip întreg, implicit este MongoCursor::$timeout. Dacă se utilizează înscrieri cu confirmare, acest parametru stabilește intervalul de timp maximal (în milisecunde) pentru ca clientul să primească răspuns de la baza de date. Dacă baza de date nu răspunde în intervalul de timeout, o excepție MongoCursorTimeoutException va fi emisă.

  • "wtimeout"

    Cât timp să se aștepte confirmarea WriteConcern. Valoarea implicită pentru MongoClient este 10000 milisecunde.

Valorile întoarse

If the w parameter is set to acknowledge the write, returns an associative array with the status of the inserts ("ok") and any error that may have occurred ("err"). Otherwise, returns TRUE if the batch insert was successfully sent, FALSE otherwise.

Erori/Excepții

Throws MongoException if any inserted documents are empty or if they contains zero-length keys. Attempting to insert an object with protected and private properties will cause a zero-length key error.

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.

Istoria schimbărilor

Versiunea Descriere
1.5.0

Added the "wTimeoutMS" option, which replaces "wtimeout". Emits E_DEPRECATED when "wtimeout" is used.

Added the "socketTimeoutMS" option, which replaces "timeout". Emits E_DEPRECATED when "timeout" is used.

Emits E_DEPRECATED when "safe" is used.

1.3.4 Added "wtimeout" option.
1.3.0 Added "w" option.
1.2.7 Added "continueOnError" option.
1.0.9

Added ability to pass integers to the "safe" option, which previously only accepted booleans.

Added "fsync" option.

1.0.5 Added options parameter.

Exemple

Example #1 MongoCollection::batchInsert() example

Batch insertion is a quick way to add many elements to the database at once

<?php

$users 
= array();
for (
$i 0$i<100$i++) {
  
$users[] = array('username' => 'user'.$i'i' => $i);
}

$mongo = new MongoClient();
$collection $mongo->my_db->users;
$collection->drop();

$collection->batchInsert($users);

foreach (
$users as $user) {
  echo 
$user['_id']."\n"// populated with instanceof MongoId
}

$users $collection->find()->sort(array('i' => 1));
foreach (
$users as $user) {
    
var_dump($user['username']);
}

?>

Exemplul de mai sus va afișa ceva similar cu:

4bf43ac68ead0e1971000000
4bf43ac68ead0e1971010000
4bf43ac68ead0e1971020000
...
string(5) "user1"
string(5) "user2"
string(5) "user3"
...

Example #2 MongoCollection::batchInsert() example with ignoring errors

<?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']);
}
?>

Exemplul de mai sus va afișa ceva similar cu:

string(3) "ONE"
string(3) "TWO"
string(4) "FOUR"

Vedeți de asemenea


MongoCollection
PHP Manual