MongoDB\Collection::findOneAndUpdate()

Definición

MongoDB\Collection::findOneAndUpdate()

Encuentra un solo documento que coincida con la consulta y lo actualiza.

function findOneAndUpdate(
    array|object $filter,
    array|object $update,
    array $options = []
): object|null

Parámetros

$filter : arreglo|objeto

El criterio de filtro que especifica los documentos a actualizar.

$update : arreglo|objeto

Especifica las combinaciones de campo y valor que se deben actualizar y cualquier operador de actualización relevante. $update utiliza MongoDB operadores de actualización. También puedes pasar una pipeline de agregación como este parámetro.

$options : arreglo

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
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.
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. Nueva en la versión 1.3.
intercalación	arreglo|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 la intercalación no está especificada pero la colección tiene una intercalación predeterminada, la operación utiliza la intercalación especificada para la colección. Si no se especifica una intercalación para la colección o para la operación, MongoDB utiliza la comparación binaria simple utilizada en versiones anteriores para comparar cadenas.
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, si se especifica para una versión de servidor anterior, dará lugar a una excepción en tiempo de ejecución. Novedades en la versión 1.13.
hint	cadena|arreglo|objeto	El índice a utilizar. Especifique el nombre del índice como una string o el patrón clave del índice como un documento. Si se especifica, el sistema de query solo considerará los planes que utilicen el índice sugerido. Esta opción está disponible desde MongoDB 4.4 y, si se especifica para una versión de servidor anterior, dará lugar a una excepción en tiempo de ejecución. Novedades en la versión 1.7.
maxTimeMS	entero	El límite de tiempo acumulado en milisegundos para las operaciones de procesamiento en el cursor. MongoDB aborta la operación en el siguiente punto de interrupción..
permitir	arreglo|objeto	Mapa de nombres de parámetros y valores. Los valores deben ser expresiones constantes o cerradas que no hagan referencia a los campos del documento. Posteriormente, se puede acceder a los parámetros como variables en el contexto de una expresión de agregación (por ejemplo, $$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. Novedades en la versión 1.13.
proyección	arreglo|objeto	La especificación de proyección para determinar qué campos se incluirán en los documentos devueltos.Consulte Campos de proyecto que se devolverán desde la consulta y Operadores de proyección en el manual de MongoDB.
returnDocument	entero	Especifica si se debe retornar el documento antes de que se aplique la actualización o después. returnDocument admite los siguientes valores: MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_BEFORE (por defecto) MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER
sesión	MongoDB\Driver\Session	Sesión de cliente para asociar a la operación. Nueva en la versión 1.3.
sort	arreglo|objeto	La especificación del orden para la clasificación de los resultados.
typeMap	arreglo	El mapa de tipos para aplicar a cursores, que determina cómo se convierten los documentos BSON en valores PHP. Por defecto, se utiliza el mapa de tipos de la colección. Esto se utilizará para el documento de resultados devuelto.
inserción	booleano	Si se configura en true, crea un nuevo documento cuando ningún documento coincide con los criterios de la query. El valor por defecto es false, que no inserta un nuevo documento cuando no se encuentra coincidencia.
writeConcern	MongoDB\Driver\WriteConcern	nivel de confirmación de escritura (write concern) a usar en la operación. Por defecto, se aplica el nivel de confirmación de escritura (write concern) 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

Una matriz u objeto para el documento original o actualizado, según el valor especificado en la opción returnDocument. De forma predeterminada, se devuelve el documento original. Si ningún documento coincide con la consulta, se devuelve null. El tipo de retorno dependerá de la opción typeMap.

Errores/Excepciones

MongoDB\Exception\UnexpectedValueException si la respuesta del comando del servidor era incorrecta.

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

MongoDB\Exception\InvalidArgumentException por 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).

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.

Ejemplos

La siguiente operación actualiza el restaurante con restaurant_id de "40361708" en la colección restaurants de la base de datos test configurando su número de edificio "761":

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$updatedRestaurant = $collection->findOneAndUpdate(
    [ 'restaurant_id' => '40361708' ],
    [ '$set' => [ 'address.building' => '761' ]],
    [
        'projection' => [ 'address' => 1 ],
        'returnDocument' => MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER,
    ]
);
var_dump($updatedRestaurant);

La vista de salida se ilustraría como sigue:

object(MongoDB\Model\BSONDocument)#20 (1) {
  ["storage":"ArrayObject":private]=>
  array(2) {
    ["_id"]=>
    object(MongoDB\BSON\ObjectId)#12 (1) {
      ["oid"]=>
      string(24) "594d5ef280a846852a4b3dee"
    }
    ["address"]=>
    object(MongoDB\Model\BSONDocument)#19 (1) {
      ["storage":"ArrayObject":private]=>
      array(4) {
        ["building"]=>
        string(3) "761"
        ["coord"]=>
        object(MongoDB\Model\BSONArray)#18 (1) {
          ["storage":"ArrayObject":private]=>
          array(2) {
            [0]=>
            float(-73.9925306)
            [1]=>
            float(40.7309346)
          }
        }
        ["street"]=>
        string(8) "Broadway"
        ["zipcode"]=>
        string(5) "10003"
      }
    }
  }
}

Ver también

• MongoDB\Collection::findOneAndDelete()

• MongoDB\Collection::findOneAndReplace()

• Referencia de comando findAndModify en el manual de MongoDB