Enlève un document de la collection

# Collection::removeOne

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

Collection::removeOne — Enlève un document de la collection

### Description

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

Enlève un document de la collection avec l'ID correspondant. Ceci est un raccourci pour `Collection.remove("_id = :id").bind("id", id).execute()`.

### Liste de paramètres

`id`

  L'identifiant du document de la collection à enlever. Typiquement c'est le _id généré par le serveur MySQL lors de l'ajout de l'enregistrement.

### Valeurs de retour

Un objet Result qui peut être utilisé pour interroger le nombre d'éléments affectés ou le nombre d'avertissements générés par l'opération.

### Exemples

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

    <?php
    $session = 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();

    // Normalement l'_id est connu par d'autres moyens,
    // mais pour cet exemple, récupérons l'identifiant généré et utilisons-le
    $ids       = $result->getGeneratedIds();
    $alfred_id = $ids[0];

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

    if(!$result->getAffectedItemsCount()) {
        echo "Alfred with id $alfred_id was not removed.";
    } else {
        echo "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.

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open