MongoCollection
Manuel PHP

MongoCollection::insert

(PECL mongo >=0.9.0)

MongoCollection::insert — Insère un document dans la collection

Description

public bool|array MongoCollection::insert ( array|object $a [, array $options = array() ] )

Toutes les chaînes envoyées à la base de données doivent être en UTF-8. Si une chaîne n'est pas UTF-8, une exception MongoException sera émise. Pour insérer (ou chercher) une chaîne non-UTF-8, utilisez la méthode MongoBinData.

Liste de paramètres

a

Un tableau ou un objet. Si un objet est utilisé, ces propriétés ne doivent être ni protégées, ni privées.

Note:

Si le paramètre n'a pas de clé _id ou de propriété, une nouvelle instance MongoId sera créée et utilisée. Ce comportement spécial ne signifie pas que le paramètre est passé par référence.

options

Options d'insertion.

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

Retourne un tableau contenant le statut de l'insertion si l'option "w" est définie. Sinon, retourne TRUE si le tableau inséré n'est pas vide (une exception MongoException sera lancée si le tableau inséré est vide).

Si un tableau est retourné, les clés suivantes peuvent être présentes :

ok

Doit toujours valoir 1 (à moins que last_error échoue).

err

Si ce champ est non-nul, une erreur est survenue lors de la dernière opération. Si ce champ est défini, il sera une chaîne de caractères décrivant l'erreur survenue.

code

Si une erreur de base de données est survenue, le code erreur de cette erreur sera passé au client.

errmsg

Ce champ est défini si quelque chose a échoué avec une commande de base de données. Il est couplé avec ok qui vaudra alors 0. Par exemple, si w est défini et que le délai maximal d'attente est atteint, errmsg sera défini à "timed out waiting for slaves" et ok vaudra 0. Si ce champ est défini, il sera une chaîne de caractères décrivant l'erreur survenue.

n

Si la dernière opération était une mise à jour, un upsert ou une suppression, le nombre d'objets affectés sera retourné. Pour les opérations d'insertion, cette valeur sera toujours de 0.

wtimeout

Si l'option précédente a expiré en attendant la réplication.

waited

Le temps que l'opération doit attendre avant d'expirer.

wtime

Si w a été défini et que l'opération réussit, ce sera le temps prit pour la réplication vers les w serveurs.

upserted

Si un upsert survient, ce champ contiendra le champ _id du nouvel enregistrement. Pour les upserts, soit ce champ, soit le champ updatedExisting sera présent (à moins qu'une erreur ne survienne).

updatedExisting

Si un upsert met à jour un élément existant, ce champ vaudra TRUE. Pour les upserts, soit ce champ, soit le champ upserted sera présent (à moins qu'une erreur ne survienne).

Erreurs / Exceptions

Lance une exception MongoCursorTimeoutException si le document inséré est vide ou s'il contient des clés d'une longueur de zéro. Le fait de tenter d'insérer un objet avec des propriétés protégées ou privées causera une erreur de type "clé d'une longueur zéro".

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.3.0 Le paramètre options n'accepte plus de booléen pour indiquer une insertion reconnue. A la place, ceci doit maintenant être effectué via array('w' => 1) (Le comportement par défaut de MongoClient).
1.2.0 Ajout de l'option "timeout".
1.0.11 Se déconnecte lors d'erreurs "not master" si "safe" est utilisé.
1.0.9

Ajout de la possibilité de passer des entiers à l'option "safe" (auparavant, seuls les booléens étaient acceptés).

Ajotu de l'option "fsync".

Le type retourné a changé. C'est maintenant un tableau contenant les informations d'erreur si l'option "safe" est utilisée, sinon, c'est un booléen, comme auparavant.

1.0.5 Modification du second paramètre en un tableau d'options. Avant la version 1.0.5, le second paramètre était un booléen indiquant l'option "safe".
1.0.1 Lance une exception MongoCursorException si l'option "safe" est définie et que l'insertion échoue.

Exemples

Exemple #1 Exemple avec MongoCollection::insert() _id

<?php

$m = new MongoClient();
$collection = $m->selectCollection('test', 'phpmanual');

// Si un tableau litéral est utilisé, il n'y a aucun moyen d'accéder à l'_id généré
$collection->insert(array('x' => 1));

// L'_id est disponible pour un tableau passé par valeur
$a = array('x' => 2);
$collection->insert($a);
var_dump($a);

// L'_id n'est pas disponible sur un tableau passé par référence
$b = array('x' => 3);
$ref = &$b;
$collection->insert($ref);
var_dump($ref);

// L'_id est disponible si la fonction ne déclenche pas de copy-on-write
function insert_no_cow($collection, $document)
{
	$collection->insert($document);
}

$c = array('x' => 4);
insert_no_cow($collection, $c);
var_dump($c);

// L'_id n'est pas disponible si la fonction déclenche un copy-on-write
function insert_cow($collection, $document)
{
	$document['y'] = 1;
	$collection->insert($document);
}

$d = array('x' => 5);
insert_cow($collection, $d);
var_dump($d);

?>
<?php

$person = array("name" => "Joe", "age" => 20);
$collection->insert($person);

// Maintenant, $person a un champ _id, aussi, si vous le sauvegardez à nouveau,
// une exception sera émise
try {
	$collection->insert($person, array("w" => 1));
} catch(MongoCursorException $e) {
	echo "Vous ne pouvez pas sauvegarder la même personne 2 fois !\n";
}

?>

Voir aussi

MongoCollection
Manuel PHP
LoadingChargement en cours