db.collection.findOneAndReplace() (método mongosh)

Documento

Los criterios de selección para actualizar. Los mismos selectores query que en el método find() están disponibles.

Para reemplazar el primer documento devuelto en la colección, especifique un documento vacío { }.

Si no se especifica, el valor es por defecto un documento vacío.

Si el argumento de la consulta no es un documento, la operación devuelve un error.

Documento

El documento de reemplazo.

No puede contener operadores de actualización.

El documento <replacement> no puede especificar un valor _id que sea diferente del documento reemplazado.

Documento

Opcional. Un documento que expresa el nivel de confirmación de escritura. Omite el uso del nivel de confirmación de escritura por defecto.

{ w: <value>, j: <boolean>, wtimeout: <number> }

No establezcas explícitamente el nivel de confirmación de escritura para la operación si se ejecuta en una transacción. Para usar el nivel de confirmación de escritura con transacciones, consulta Transacciones y nivel de confirmación de escritura.

Documento

Opcional. Un subconjunto de campos que se deben devolver.

Para devolver todos los campos del documento coincidente, omita este campo.

Si el argumento de proyección no es un documento, la operación genera un error.

Documento

Opcional. Especifica un orden de clasificación para los documentos que coinciden con el filtro.

Si el argumento de orden no es un documento, la operación genera un error.

Consulte cursor.sort().

Número

Opcional. Especifica un límite de tiempo en milisegundos para que la operación se complete. Devuelve un error si se supera el límite.

booleano

Opcional. Cuando true, findOneAndReplace() puede:

• Inserta el documento del parámetro replacement si ningún documento coincide con filter. Devuelve null después de insertar el nuevo documento, a menos que returnNewDocument sea true.

• Reemplaza el documento que corresponde a filter con el documento de replacement.

MongoDB añadirá el campo _id al documento de reemplazo si no está especificado en los documentos filter o replacement. Si _id está presente en ambos, los valores deben ser iguales.

Para evitar múltiples inserciones, asegúrate de que los campos de query estén indexados de forma única.

Se establece por defecto en false.

string

Opcional. A partir mongosh 0.13.2 de, returnDocument es una alternativa a returnNewDocument. Si se configuran ambas opciones, returnDocument tiene prioridad.

returnDocument: "before" devuelve el documento original. returnDocument: "after" devuelve el documento actualizado.

booleano

Opcional. Cuando true, devuelve el documento de reemplazo en lugar del documento original.

Se establece por defecto en false.

Documento

Opcional.

Especifica la intercalación a utilizar para la operación.

La intercalación permite a los usuarios especificar reglas propias del lenguaje para la comparación de strings, como reglas para el uso de mayúsculas y minúsculas y marcas de acento.

La opción de intercalación tiene la siguiente sintaxis:

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

Al especificar la intercalación, el campo locale es obligatorio; todos los demás campos de intercalación son opcionales. Para las descripciones de los campos, consulta Documento de intercalación.

Si no se especifica la intercalación, pero la colección tiene una intercalación por defecto (ver db.createCollection()), la operación utiliza la intercalación especificada para la colección.

Si no se especifica ninguna intercalación para la colección o para las operaciones, MongoDB utiliza la comparación binaria simple usada en versiones anteriores para las comparaciones de strings.

No puedes especificar varias intercalaciones para una operación. Por ejemplo, no puedes especificar diferentes intercalaciones por campo, o si realizas una búsqueda con un ordenamiento, no puedes usar una intercalación para la búsqueda y otra para el ordenamiento.

Especifica la inclusión de un campo. Si especificas un entero distinto de cero para el valor de proyección, la operación trata el valor como true.

Especifica la exclusión de un campo.

Utiliza el operador de proyección de arreglo $ para devolver el primer elemento que coincide con la condición de query en el campo de arreglo. Si especificas un entero distinto de cero para el valor de proyección, la operación trata el valor como true.

No disponible para las vistas.

Utiliza los operadores de proyección de arreglos ($elemMatch, $slice) para especificar los elementos del arreglo que se deben incluir.

No disponible para las vistas.

Especifica el valor del campo proyectado.

Con el uso de expresiones y sintaxis de agregación, incluido el uso de literales y variables de agregación, se pueden proyectar campos nuevos o proyectar campos existentes con valores nuevos.

• Si se especifica un literal no numérico, no booleano (como una cadena de caracteres, un arreglo o una expresión de operador) para el valor de proyección, el campo se proyecta con el nuevo valor, por ejemplo:

  • { field: [ 1, 2, 3, "$someExistingField" ] }

  • { field: "New String Value" }

  • { field: { status: "Active", total: { $sum: "$existingArray" } } }

• Para proyectar un valor literal para un campo, utiliza la expresión de agregación $literal, por ejemplo:

  • { field: { $literal: 5 } }

  • { field: { $literal: true } }

  • { field: { $literal: { fieldWithValue0: 0, fieldWithValue1: 1 } } }