Edit Report a Bug

    MongoCollection::save

    (PECL mongo >=0.9.0)

    MongoCollection::save — Sauvegarde un document dans une collection

    Description

    public MongoCollection::save ( array|object $document [, array $options = array() ] ) : mixed

    Si l'objet est déjà dans la base, modifie la base et sinon, insère l'objet.

    Liste de paramètres

    document

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

    Note:

    Si le paramètre n'a pas de clé _id, ni 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 pour la sauvegarde.

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

    • "wtimeout"

      Alias obsolète pour "wTimeoutMS".

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

    • "safe"

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

    • "timeout"

      Alias obsolète pour "socketTimeoutMS".

    Valeurs de retour

    Si w est utilisé, retourne un tableau contenant le statut de la sauvegarde. Sinon, retourne un booléen si le tableau était non vide (un tableau vide ne sera pas inséré).

    Erreurs / Exceptions

    Lance une exception MongoException si le document inséré est vide, ou s'il contient des clés de valeurs nulles. Tenter d'insérer un objet avec des propriétés protégées ou privées causera une erreur de type "clés de valeurs nulles".

    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 l'option "wtimeout". Emets une alerte de type E_DEPRECATED lorsque "wtimeout" est utilisée.

    Ajout de l'option "socketTimeoutMS", qui remplace l'option "timeout". Emets une alerte de type E_DEPRECATED lorsque "timeout" est utilisée.

    Emets une alerte de type E_DEPRECATED lorsque "safe" est utilisée.

    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 l'option "fsync".

    1.0.5 Ajout du paramètre options.

    Exemples

    Exemple #1 Exemple avec MongoCollection::save()

    <?php

    $obj     = array('x' => 1);

    // insertion de $obj dans la base
    $collection->save($obj);
    var_dump($obj);

    // ajout d'un nouveau champ
    $obj['foo'] = 'bar';

    // $obj ne peut pas être inséré, car il causerait une duplication
    $collection->insert($obj);

    // sauvegarde de la modification de $obj
    $collection->save($obj);

    ?>

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

    array(2) {
  ["x"]=>
  int(1)
  ["_id"]=>
  object(MongoId)#4 (1) {
    ["$id"]=>
    string(24) "50b6afe544415ed606000000"
  }
}
    add a note add a note

    User Contributed Notes 1 note

    up
    -6
    cuisdy at gmail dot com
    11 years ago
    Same as with method insert(), it is worth noting that creating a reference to $obj will have the same effect as $obj being a reference itself, i.e. no _id field will be added.

    <?php

    $a     = &$obj;

    $m = new MongoClient;
    $collection = $m->test->phpmanual;

    $obj = array('x' => 1);

    // Suppose you create a reference for some reason
    $a = &$obj;

    $collection->save($obj);

    var_dump($obj);
    // prints: array(1) { ["x"]=> int(1) }
    ?>
    add a note add a note
    To Top