MongoDB\ClientBulkWrite::createWithCollection()

Definición

MongoDB\ClientBulkWrite::createWithCollection()

Create an instance of the MongoDB\ClientBulkWrite builder from the provided MongoDB\Collection instance. You can add write operations to the ClientBulkWrite to create a new Comando de escritura masiva that the library sends to the server.

function createWithCollection(
    Collection $collection,
    array $options = []
): self

Parámetros

$collection : MongoDB\Collection

La instancia Collection que se establecerá como destino para operaciones de escritura masiva.

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
bypassDocumentValidation	booleano	Si true: la operación de escritura ignora la validación a nivel de documento. El valor es por defecto false.
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.
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, si se utiliza, generará una excepción en el momento de ejecución.
ordenado	booleano	Si true: cuando falla una sola escritura, la operación se detiene sin realizar las escrituras restantes y genera una excepción. Si false: cuando falla una sola escritura, la operación continúa con las escrituras restantes, si las hay, y genera una excepción. El valor es por defecto true.
verboseResults	booleano	Especifica si se deben devolver resultados detallados. El valor es por defecto false.

Return Values

Una nueva instancia ClientBulkWrite con una especificación BulkWriteCommand vacía.

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\RuntimeException para otros errores en el nivel de extensión (por ejemplo, errores de conexión).

Ver también

• Sección deescritura masiva del cliente de la guía de operaciones de escritura masiva