Elimina un documento de la colección

# Collection::removeOne

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

Collection::removeOne — Elimina un documento de la colección

### Descripción

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

Elimina un documento de la colección con el ID correspondiente. Esto es un atajo para `Collection.remove("_id = :id").bind("id", id).execute()`.

### Parámetros

`id`

  El identificador del documento de la colección a eliminar. Generalmente es el _id generado por el servidor MySQL al añadir el registro.

### Valores devueltos

Un objeto Result que puede ser utilizado para consultar el número de elementos afectados o el número de advertencias generadas por la operación.

### Ejemplos

Ejemplo #1 Ejemplo 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();

    // Normalmente el _id es conocido por otros medios,
    // pero para este ejemplo, recuperemos el identificador generado y utilicémoslo
    $ids       = $result->getGeneratedIds();
    $alfred_id = $ids[0];

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

    if(!$result->getAffectedItemsCount()) {
        echo "Alfred con id $alfred_id no fue eliminado.";
    } else {
        echo "Adiós, Alfred, puedes llevarte el _id $alfred_id contigo.";
    }
    ?>

Resultado del ejemplo anterior es similar a:

    Adiós, Alfred, puedes llevarte el _id 00005b6b536100000000000000cb contigo.

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