La clase MongoDB\Driver\BulkWrite

(mongodb >=1.0.0)

Introducción

El MongoDB\Driver\BulkWrite recopila una o más operaciones de escritura que deberían ser enviadas al servidor. Después de agregar un número cualquiera de operaciones de inserción, actualización y eliminación, la colección puede ser ejecutada a través de MongoDB\Driver\Manager::executeBulkWrite().

Las operaciones de escritura pueden ser ordenadas (por omisión) o no ordenadas. Las operaciones de escritura ordenadas son enviadas al servidor, en el orden proporcionado, para una ejecución serial. Si una escritura falla, todas las operaciones restantes serán canceladas. Las operaciones no ordenadas son enviadas al servidor en un orden arbitrario donde pueden ser ejecutadas en paralelo. Todos los errores que ocurren son reportados después de que todas las operaciones hayan sido intentadas.

Sinopsis de la Clase

final class MongoDB\Driver\BulkWrite implements Countable {

/* Métodos */

public __construct(?array $options = null)

public count(): int

public delete(array|object $filter, ?array $deleteOptions = null): void

public insert(array|object $document): mixed

public update(array|object $filter, array|object $newObj, ?array $updateOptions = null): void

}

Ejemplos

Ejemplo #1 Operaciones de escritura ordenadas por tipo

Las operaciones de escritura mixtas (es decir, las inserciones, las actualizaciones y las eliminaciones) serán ensambladas en comandos de escritura tipificados para ser enviados secuencialmente al servidor.

<?php

$bulk = new MongoDB\Driver\BulkWrite(['ordered' => true]);
$bulk->insert(['_id' => 1, 'x' => 1]);
$bulk->insert(['_id' => 2, 'x' => 2]);
$bulk->update(['x' => 2], ['$set' => ['x' => 1]]);
$bulk->insert(['_id' => 3, 'x' => 3]);
$bulk->delete(['x' => 1]);

?>

Resulta en cuatro comandos de escritura (es decir, idas y vueltas) ejecutadas. Dado que las operaciones son ordenadas, la tercera inserción no puede ser enviada hasta que la actualización previa sea ejecutada.

Ejemplo #2 Operaciones de escritura ordenadas causando un error

<?php

$bulk = new MongoDB\Driver\BulkWrite(['ordered' => true]);
$bulk->delete([]);
$bulk->insert(['_id' => 1]);
$bulk->insert(['_id' => 2]);
$bulk->insert(['_id' => 3, 'hello' => 'world']);
$bulk->update(['_id' => 3], ['$set' => ['hello' => 'earth']]);
$bulk->insert(['_id' => 4, 'hello' => 'pluto']);
$bulk->update(['_id' => 4], ['$set' => ['hello' => 'moon']]);
$bulk->insert(['_id' => 3]);
$bulk->insert(['_id' => 4]);
$bulk->insert(['_id' => 5]);

$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$writeConcern = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 1000);

try {
    $result = $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]);
} catch (MongoDB\Driver\Exception\BulkWriteException $e) {
    $result = $e->getWriteResult();

    // Verifica si la escritura no pudo ser satisfecha
    if ($writeConcernError = $result->getWriteConcernError()) {
        printf("%s (%d): %s\n",
            $writeConcernError->getMessage(),
            $writeConcernError->getCode(),
            var_export($writeConcernError->getInfo(), true)
        );
    }

    // Verifica si una operación de escritura no pudo ser completada
    foreach ($result->getWriteErrors() as $writeError) {
        printf("Operación#%d: %s (%d)\n",
            $writeError->getIndex(),
            $writeError->getMessage(),
            $writeError->getCode()
        );
    }
} catch (MongoDB\Driver\Exception\Exception $e) {
    printf("Otro error: %s\n", $e->getMessage());
    exit;
}

printf("Insertados %d documento(s)\n", $result->getInsertedCount());
printf("Actualizados  %d documento(s)\n", $result->getModifiedCount());

?>

El ejemplo anterior mostrará:

Operación#7: E11000 duplicate key error index: db.collection.$_id_ dup key: { : 3 } (11000)
Insertados 4 documento(s)
Actualizados  2 documento(s)

Si el write concern no puede ser satisfecho, el ejemplo anterior mostrará algo como:

esperando la replicación tiempo agotado (64): array (
  'wtimeout' => true,
)
Operación#7: E11000 duplicate key error index: databaseName.collectionName.$_id_ dup key: { : 3 } (11000)
Insertados 4 documento(s)
Actualizados  2 documento(s)

Si se ejecuta el ejemplo anterior, pero se permiten escrituras no ordenadas:

<?php

$bulk = new MongoDB\Driver\BulkWrite(['ordered' => false]);
/* ... */

?>

El ejemplo anterior mostrará:

Operación#7: E11000 duplicate key error index: db.collection.$_id_ dup key: { : 3 } (11000)
Operación#8: E11000 duplicate key error index: db.collection.$_id_ dup key: { : 4 } (11000)
Insertados 5 documento(s)
Actualizados  2 documento(s)

Ver también

Tabla de contenidos

MongoDB\Driver\BulkWrite::__construct — Crear un nuevo BulkWrite
MongoDB\Driver\BulkWrite::count — Cuenta el número de operaciones de escritura en el lote
MongoDB\Driver\BulkWrite::delete — Añade una operación de eliminación al lote
MongoDB\Driver\BulkWrite::insert — Añade una operación de inserción al lote
MongoDB\Driver\BulkWrite::update — Añade una operación de actualización al lote