/ /

Biblioteca PHP

MongoDB\Colección

Docs Home

Librerías de clientes

PHP

Biblioteca PHP

MongoDB\Colección

MongoDB\Collection::bulkWrite()

Definición

MongoDB\Collection::bulkWrite()

Ejecuta múltiples operaciones de escritura.

function bulkWrite(
    array $operations,
    array $options = []
): MongoDB\BulkWriteResult

Parámetros

$operations : matriz

Una matriz que contiene las operaciones de escritura a realizar. MongoDB\Collection::bulkWrite() soportes MongoDB\Collection::deleteMany()MongoDB\Collection::deleteOne()MongoDB\Collection::insertOne()MongoDB\Collection::replaceOne()MongoDB\Collection::updateMany()Operaciones,,,, y en la siguiente estructura de MongoDB\Collection::updateOne() matriz:

[
    [ 'deleteMany' => [ $filter ] ],
    [ 'deleteOne'  => [ $filter ] ],
    [ 'insertOne'  => [ $document ] ],
    [ 'replaceOne' => [ $filter, $replacement, $options ] ],
    [ 'updateMany' => [ $filter, $update, $options ] ],
    [ 'updateOne'  => [ $filter, $update, $options ] ],
]

Los argumentos corresponden a los respectivos métodos de operación. Sin embargo, la writeConcern opción se especifica como opción de nivel superior para,MongoDB\Collection::bulkWrite() en lugar de cada operación individual.

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
constructorEncoder	MongoDB\Codec\Encoder	Codificador que se usará para los generadores de consultas y agregaciones. Si no se configura, esta opción toma como valor predeterminado una nueva instancia de la clase `MongoDB\Builder\BuilderEncoder`. Nuevo en la versión 1.21.
bypassDocumentValidation	booleano	Si es `true`, permite que la operación de escritura evite la validación a nivel de documento. El valor predeterminado es `false`.
codec	MongoDB\Códec\DocumentCodec	Codificar datos con códecs de tipo para codificar o decodificar documentos. Esta opción es mutuamente excluyente con la `typeMap` opción. El valor predeterminado es el códec de la colección. La herencia de la opción predeterminada `codec` prevalece sobre la de la opción `typeMap`. Las escrituras masivas utilizan el códec para las operaciones `insertOne` y `replaceOne`. Nuevo en la versión 1.17.
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través del generador de perfiles de base de datos, la salidacurrentOp y los registros. Esta opción está disponible desde MongoDB 4.4 y generará una excepción en el momento de ejecución si se especifica para una versión de servidor anterior. Novedades en la versión 1.13.
permitir	matriz\|objeto	Mapa de nombres y valores de parámetros. Los valores deben ser constantes o expresiones cerradas que no hagan referencia a campos del documento. Se puede acceder a los parámetros como variables en un contexto de expresión agregada (p. ej., `$$var`). Esto no es compatible con versiones de servidor anteriores a 5.0 y generará una excepción en el momento de ejecución si se utiliza. Novedades en la versión 1.13.
ordenado	booleano	Si `true`: cuando falla una sola escritura, la operación se detendrá sin realizar las escrituras restantes y lanzará una excepción. Si `false`: cuando falla una sola escritura, la operación continuará con las escrituras restantes, si las hay, y lanzará una excepción. El valor es por defecto `true`.
sesión	MongoDB\Controlador\Sesión	Sesión de cliente para asociar a la operación. Nuevo en la versión 1.3.
writeConcern	MongoDB\Driver\WriteConcern	Escriba la preocupación que se usará para la operación. El valor predeterminado es la preocupación de escritura de la colección. No es posible especificar una preocupación de escritura para operaciones individuales como parte de una transacción. En su lugar, configure la `writeConcern` opción al iniciar la transacción.

Return Values

Un objeto,MongoDB\BulkWriteResult que encapsula un objeto MongoDB\Driver\WriteResult.

Errores/Excepciones

MongoDB\Exception\UnsupportedException si se utilizan opciones que no son compatibles con el servidor seleccionado (porcollation readConcernwriteConcernejemplo,,,).

MongoDB\Exception\InvalidArgumentException para errores relacionados con el análisis de parámetros u opciones.

MongoDB\Driver\Exception\BulkWriteException para errores relacionados con la operación de escritura. Puede inspeccionar el valor devuelto por getWriteResult() para determinar la naturaleza del error.

MongoDB\Driver\Exception\RuntimeException para otros errores en el nivel de extensión (por ejemplo, errores de conexión).

Comportamiento

Si se lanza una MongoDB\Driver\Exception\BulkWriteException, puede llamar a getWriteResult() e inspeccionar el objeto MongoDB\Driver\WriteResult devuelto para determinar la naturaleza del error.

Por ejemplo, es posible que una operación de escritura se haya ejecutado correctamente en el servidor principal, pero no haya solucionado el problema (p. ej., la replicación tardó demasiado). También es posible que una operación de escritura haya fallado por completo (p. ej., violación de clave única).

En el caso de una escritura masiva, el resultado podría indicar múltiples operaciones de escritura exitosas o errores. Si la opción ordered es true, es posible que algunas operaciones se hayan realizado correctamente antes de que se encontrara el primer error y se lanzara la excepción. Si la opción ordered es false, es posible que se hayan encontrado múltiples errores.

Ver también

Volver

agregar()

count()