MongoCollection::findAndModify
(PECL mongo >=1.3.0)
MongoCollection::findAndModify — Met à jour un document et le retourne
Description
$query
[, array $update
[, array $fields
[, array $options
]]] )La méthode findAndModify modifie automatiquement un document et le retourne. Par défaut, le document retourné n'inclut pas les modifications effectuées lors de la mise à jour. Pour retourner le document avec les modifications effectuées lors de la mise à jour, utilisez la méthode avec l'option new.
Liste de paramètres
-
query -
Les critères de recherche.
-
update -
Les critères de mise à jour.
-
fields -
Optionnellement, ne retourne que ces champs.
-
options -
Un tableau d'options à appliquer, comme le fait de supprimer le document trouvé depuis la base de données et le retourner.
Option Description sort array Détermine le document que l'opération va modifier si la requête sélectionne plusieurs documents. findAndModify va modifier le premier document suivant l'ordre spécifié par cet argument. remove boolean Optionnel si le champ update existe. Lorsque vaut TRUE, le document sélectionné sera supprimé. Par défaut, vautFALSE.update array Optionnel, si le champ remove existe. Effectue une mise à jour du document sélectionné. new boolean Optionnel. Lorsque vaut TRUE, retourne le document modifié plutôt que l'original. La méthode findAndModify ignore l'option new pour les opérations de suppression. Par défaut, vautFALSE.upsert boolean Optionnel. Utilisé en conjonction du champ update. Lorsque vaut TRUE, la méthode findAndModify crée un nouveau document si la requête retourne aucun document. Par défaut, vautFALSE. En MongoDB 2.2, la méthode findAndModify retourneNULLlorsque upsert vautTRUE.
Valeurs de retour
Retourne le document original, ou le document modifié lorsque new est défini.
Erreurs / Exceptions
Lance une exception MongoResultException en cas d'échec.
Exemples
Exemple #1 Exemple avec MongoCollection::findAndModify()
<?php
$m = new Mongo;
$col = $m->selectDB("test")->jobs;
$col->insert(array(
"name" => "Next promo",
"inprogress" => false,
"priority" => 0,
"tasks" => array( "select product", "add inventory", "do placement"),
) );
$col->insert(array(
"name" => "Biz report",
"inprogress" => false,
"priority" => 1,
"tasks" => array( "run sales report", "email report" )
) );
$col->insert(array(
"name" => "Biz report",
"inprogress" => false,
"priority" => 2,
"tasks" => array( "run marketing report", "email report" )
),
array("w" => 1)
);
$retval = $col->findAndModify(
array("inprogress" => false, "name" => "Biz report"),
array('$set' => array('inprogress' => true, "started" => new MongoDate())),
null,
array(
"sort" => array("priority" => -1),
"new" => true,
)
);
var_dump($retval);
?><?php
$m = new Mongo;
$col = $m->selectDB("test")->jobs;
try {
$retval = $col->findAndModify(
array("inprogress" => false, "name" => "Next promo"),
array('$pop' => array("tasks" => -1)),
array("tasks" => array('$pop' => array("stuff"))),
array("new" => true)
);
} catch(MongoResultException $e) {
echo $e->getCode(), " : ", $e->getMessage(), "\n";
var_dump($e->getDocument());
}
?>L'exemple ci-dessus va afficher quelque chose de similaire à :
13097 : exception: Unsupported projection option: $pop
array(3) {
["errmsg"]=>
string(46) "exception: Unsupported projection option: $pop"
["code"]=>
int(13097)
["ok"]=>
float(0)
}
Voir aussi
- La documentation MongoDB sur » findAndModify
