(No version information available, might only be in Git)

Collection::removeOneRemove one collection document


public mysql_xdevapi\Collection::removeOne(string $id): mysql_xdevapi\Result

Remove one document from the collection with the correspending ID. This is a shortcut for Collection.remove("_id = :id").bind("id", id).execute().

Liste de paramètres


The ID of the collection document to remove. Typically this is the _id that was generated by MySQL Server when the record was added.

Valeurs de retour

A Result object that can be used to query the number of affected items or the number warnings generated by the operation.


Exemple #1 mysql_xdevapi\Collection::removeOne() example

= mysql_xdevapi\getSession("mysqlx://user:password@localhost");

$session->sql("DROP DATABASE IF EXISTS addressbook")->execute();
$session->sql("CREATE DATABASE addressbook")->execute();

$schema = $session->getSchema("addressbook");
$collection = $schema->createCollection("people");

$result = $collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute();

// Normally the _id is known by other means,
// but for this example let's fetch the generated id and use it
$ids = $result->getGeneratedIds();
$alfred_id = $ids[0];

$result = $collection->removeOne($alfred_id);

$result->getAffectedItemsCount()) {
"Alfred with id $alfred_id was not removed.";
} else {
"Goodbye, Alfred, you can take _id $alfred_id with you.";

Résultat de l'exemple ci-dessus est similaire à :

Goodbye, Alfred, you can take _id 00005b6b536100000000000000cb with you.
add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top