MongoCollection::batchInsert

(PECL mongo >=0.9.0)

MongoCollection::batchInsertInsère plusieurs documents dans la collection

Description

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

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

Options d'insertion.

  • "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 vaut FALSE. Force la synchronisation de l'insertion avant de retourner le succès de l'opération. Si vaut TRUE, une insertion reconnue est implicite, et écrasera la configuration de w à 0.

  • "j"

    Booléen, par défaut FALSE. Force l'insertion à être synchronisée avec le journal avant de retourner le succès de l'opération. Si vaut TRUE, la reconnaissance d'une insertion sera appliquée, et va écraser la configuration passant de w à 0.

  • "w"

    Voir WriteConcerns. La valeur par défaut pour MongoClient est 1.

  • "wtimeout"

    Durée d'attente pour la reconnaissance WriteConcern. La valeur par défaut pour MongoClient est 10000 millisecondes.

  • "safe"

    Obsolète. Veuillez utiliser l'option w de WriteConcern w.

  • "timeout"

    Entier, par défaut, vaut MongoCursor::$timeout. Si la reconnaissance des écritures est utilisée, ceci va définir (en millisecondes) la durée d'attente du client d'une réponse de la base de données. Si la base de données ne répond pas durant cette période, une exception de type MongoCursorTimeoutException sera émise.

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 à un, et que l'opération prend plus de temps que MongoCursor::$timeout millisecondes à se terminer. Ceci ne tue pas l'opération sur le serveur, c'est un délai d'attente maximal côté client. La mesure pour MongoCollection::$wtimeout est le milliseconde.

Historique

Version Description
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()

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

?>
<?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

LoadingChargement en cours