Insère plusieurs documents dans la collection

# MongoCollection::batchInsert

(PECL mongo >=0.9.0)

MongoCollection::batchInsert — Insère plusieurs documents dans la collection

### Description

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

### Liste de paramètres

`a`

  Un tableau de tableaux ou d'objets. Si des objets sont utilisés, il ne faut pas que leurs propriétés soient protégées ou privées.

  > Note:

  > Si le document à insérer n'a pas de clé _id ou de propriété, une nouvelle instance MongoId sera créée et utilisée. Voir la méthode MongoCollection::insert() pour plus d'informations quant à ce comportement.

`options`

  Un tableau d'options pour le lot d'opérations d'insertion. Actuellement, les options valides sont :

  - "continueOnError"

    Booléen, par défaut, `FALSE`. Si défini, la base de données n'arrêtera pas une insertion bulk si une d'entre elles échoue (i.e. en raison d'un ID dupliqué). Ceci rend les insertions bulk comme une succession d'insertion simple, sauf que lors d'un appel à la méthode MongoDB::lastError(), un jeu d'erreurs sera retourné lors de l'échec d'une insertion, et pas seulement la dernière. Si plusieurs erreurs surviennent, seule la plus récente sera rapportée par la méthode MongoDB::lastError().

    > Note:

    > Veuillez noter que continueOnError affecte les erreurs côté base de données uniquement. Si vous tentez d'insérer un document qui contient des erreurs (par exemple, il contient une clé dont le nom est vide), alors le document ne sera pas transféré à la base de données car le driver va détecter cette erreur et l'indiquer. continueOnError n'a aucun effet sur les erreurs détectées dans le document par le driver.

  - "fsync"

    Booléen, par défaut à `FALSE`. Si l'historisation est activée, il fonctionne exactement comme "j". Si l'historisation n'est pas activée, l'opération en écriture sera bloquante tant qu'elle ne sera pas synchronisé sur les fichiers de base de données du disque. Si vaut `TRUE`, une insertion reconnue devient implicite, et cette option va écraser la configuration "w" à 0.

    > Note: Si l'historisation est activée, les utilisateurs sont vivement encouragés à utiliser l'option "j" au lieu de "fsync". N'utilisez pas "fsync" et "j" en même temps, ou une erreur sera produite.

  - "j"

    Booléen, par défaut à `FALSE`. Force les opérations en écriture a être bloquantes tant qu'elles ne sont pas synchronisées dans le journal du disque. Si vaut `TRUE`, une écriture reconnue est implicite, et cette option va écraser la configuration "w" à 0.

    > Note: Si cette option est utilisée, et que l'historisation est désactivée, MongoDB 2.6+ va lancer une erreur, et l'écriture échouera ; les anciennes versions du serveur vont simplement ignorer cette ooption.

  - "socketTimeoutMS"

    Cette option spécifie la durée limite, en millisecondes, pour la communication avec un socket. Si le serveur ne répond pas pendant cette période, une exception MongoCursorTimeoutException sera émise et il n'y a aucune façon de déterminer si le serveur gère actuellement l'écriture ou non. Une valeur de -1 peut être spécifiée pour bloquer indéfiniement. La valeur par défaut pour MongoClient est 30000 (30 secondes).

  - "w"

    Voir les préoccupatios d'écriture. La valeur par défaut pour MongoClient est 1.

  - "wTimeoutMS"

    Cette option spécifie la durée limite, en millisecondes, pour la reconnaissance des préoccupations d'écriture.Ceci n'est applicable que lorsque "w" est supérieur à 1, sachant que le délai d'attente maximal est en relation avec la réplication. Si la préoccupation d'écriture n'est pas spécifiée dans la durée limite, une exception MongoCursorException sera émise. Une valeur de 0 peut être spécifiée pour un blocage permanent. La valeur par défaut pour MongoClient est 10000 (dix secondes).

  Les options suivantes sont obsolètes, et ne devraient plus être utilisées :

  - "safe"

    Deprecated. Please use the write concern "w" option.

  - "timeout"

    Alias obsolète pour "socketTimeoutMS".

  - "wtimeout"

    Alias obsolète pour "wTimeoutMS".

### Valeurs de retour

Si le paramètre w est défini pour reconnaître l'écriture, retourne un tableau associatif contenant le statut de l'insertion ("ok") ainsi que toutes les erreurs survenues ("err"). Sinon, retourne `TRUE` si l'insertion a été envoyée avec succès, `FALSE` sinon.

### Erreurs / Exceptions

Lance une exception MongoException si les documents insérés sont vides, ou s'ils contiennent une clé de valeur nulle. Tenter d'insérer un objet avec des propriétés protégées et privées causera une erreur de type "clé de valeur nulle". 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.

Lance une exception MongoCursorException si l'option "w" est définie, et que l'écriture échoue.

Lance une exception MongoCursorTimeoutException si l'option "w" est définie à une valeur supérieure à 1 et que l'opération prend plus de temps que MongoCursor::$timeout millisecondes à se terminer. Ceci ne va pas mettre fin à l'opération sur le serveur, ce n'est qu'un délai d'attente maximal côté client. L'unité pour MongoCollection::$wtimeout est la milliseconde.

### Historique

Version | Description
--- | ---
1.5.0 | Ajout de l'option "wTimeoutMS", qui remplace "wtimeout". Emets une alerte de niveau `E_DEPRECATED` lorsque "wtimeout" est utilisée. Ajout de l'option "socketTimeoutMS", qui remplace "timeout". Emets une alerte de niveau `E_DEPRECATED` lorsque "timeout" est utilisée. Emets une alerte de niveau `E_DEPRECATED` lorsque "safe" est utilisée.
1.3.4 | Ajout de l'option "wtimeout".
1.3.0 | Ajout de l'option "w".
1.2.7 | Le drapeau "continueOnError" a été ajouté.
1.0.9 | Ajout de la possibilité de passer des entiers à l'option "safe" (auparavant, seuls les booléens étaient acceptés). Ajout de l'option "fsync".
1.0.5 | Ajout du paramètre `options`.

### Exemples

Exemple #1 Exemple avec MongoCollection::batchInsert()

L'insertion en masse est un moyen rapide d'insérer rapidement de nombreux éléments à la fois dans une base

`<?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"; // peuplé via l'instance de MongoId
}
$users = $collection->find()->sort(array('i' => 1));
foreach ($users as $user) {
var_dump($user['username']);
}
?>`

L'exemple ci-dessus va afficher quelque chose de similaire à :

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

Exemple #2 Exemple avec MongoCollection::batchInsert() où l'on ignore les erreurs

`<?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'), // _id identique au précédent
'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']);
}
?>`

L'exemple ci-dessus va afficher quelque chose de similaire à :

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

### Voir aussi

- MongoCollection::insert() - Insère un document dans la collection
- MongoCollection::update() - Modifie les enregistrements
- MongoCollection::find() - Interroge une collection, et retourne comme jeu de résultats un objet MongoCursor
- MongoCollection::remove() - Supprime un enregistrement d'une collection
- Documentation interne MongoDB sur » insert.