MongoDB\ClientBulkWrite::updateOne()

Definición

MongoDB\ClientBulkWrite::updateOne()

Especifique una operación de actualización en el comando de escritura masiva para el primer documento coincidente. Este método devuelve el MongoDB\ClientBulkWrite instancia en la que se llama.

function updateOne(
    array|object $filter,
    array|object $update,
    array $options = []
): self

Parámetros

$filter : matriz|objeto

El criterio de filtro que especifica los documentos a actualizar.

$update : matriz|objeto

Las combinaciones de campos y valores para actualizar y cualquier operador de actualización relevante. $update utiliza MongoDB Operadores de actualización. Puede pasar una canalización de agregación como parámetro.

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
filtrosDeArreglo	arreglo	Un arreglo de documentos de filtro que determina qué elementos del arreglo modificar para una operación de actualización en un campo de arreglo.
intercalación	matriz|objeto	Laintercalación permite a los usuarios especificar reglas específicas del idioma para la comparación de cadenas, como el uso de mayúsculas y minúsculas y tildes. Al especificar la intercalación, el locale campo es obligatorio; todos los demás campos son opcionales. Para obtener descripciones de los campos, consulte el documento de intercalación. Si no se especifica la intercalación, pero la colección tiene una predeterminada, la operación utiliza la intercalación especificada para la colección. Si no se especifica ninguna intercalación para la colección ni para la operación, MongoDB utiliza la comparación binaria simple utilizada en versiones anteriores para las comparaciones de cadenas.
hint	cadena|matriz|objeto	El índice a utilizar. Especifique el nombre del índice como una cadena o el patrón de clave del índice como un documento. Si se especifica, el sistema de consultas solo considerará los planes que utilicen el índice sugerido.
sort	matriz|objeto	La especificación de ordenación para los documentos coincidentes. Configure esta opción para aplicar un orden a los documentos coincidentes antes de que el servidor realice la actualización.
inserción	booleano	Si se establece en true, se crea un nuevo documento cuando ningún documento coincide con los criterios de consulta. El valor predeterminado es false, que no inserta un nuevo documento si no se encuentra ninguna coincidencia.

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\BulkWriteCommandExceptionPara errores relacionados con la operación de escritura. Puede inspeccionar el valor devuelto por getWriteErrors() 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

Al evaluar los criterios de búsqueda, MongoDB compara tipos y valores según sus propias reglas de comparación para tipos BSON, que difieren de las reglas de comparación y manejo de tipos de PHP. Cuando se coincida con un tipo BSON especial, los criterios de consulta deben utilizar la Clase BSON respectiva en la extensión (por ejemplo, usa MongoDB\BSON\ObjectId para hacer coincidir con un ObjectId.

Si se lanza una MongoDB\Driver\Exception\BulkWriteCommandException, puede llamar a getWriteErrors() e inspeccionar la información en la matriz devuelta para determinar la naturaleza del error.

Por ejemplo, es posible que una operación de escritura se haya aplicado correctamente al servidor principal, pero no haya solucionado el problema. Alternativamente, es posible que una operación de escritura haya fallado por completo, por ejemplo, por violar la restricción de clave única.

Ver también

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