/ /

Driver de Ruby

Update Documents

Docs Home

Librerías de clientes

Ruby

Driver de Ruby

Update Documents

Reemplazar Documentos

Overview

En esta guía, aprenderá a usar el controlador Ruby para reemplazar un documento de una colección MongoDB. Una operación de reemplazo elimina todos los campos y valores de un documento específico, excepto... _id campo y agrega los nuevos campos y valores que especifique. Esta operación difiere de una operación de actualización, que solo modifica los campos especificados en uno o más documentos.

Para obtener más información sobre las operaciones de actualización, consulta el Actualizar Documentos guía.

Datos de muestra

Los ejemplos de esta guía usan la colección restaurants en la base de datos sample_restaurants de la Conjuntos de datos de muestra de Atlas. Para acceder a esta colección desde su aplicación Ruby, cree un objeto Mongo::Client que se conecte a un clúster Atlas y asigne los siguientes valores a las variables database y collection:

database = client.use('sample_restaurants')
collection = database[:restaurants]

Para aprender cómo crear un clúster gratuito de MongoDB Atlas y cargar los conjuntos de datos de ejemplo, consulta la guía MongoDB Get Started.

Operación de reemplazo

Puede realizar una operación de reemplazo en MongoDB con el método replace_one. Este método elimina todos los campos excepto el campo _id del primer documento que coincida con el filtro de consulta especificado. A continuación, añade los campos y valores especificados al documento vacío.

Parámetros necesarios

Debes pasar los siguientes parámetros al método replace_one:

Filtro de consulta: Especifica los documentos que se actualizarán. Para obtener más información sobre los filtros de consulta, consulte la guía "Especificar una consulta".
Documento de reemplazo: Especifica los campos y valores que deseas reemplazar por los campos y valores existentes.

Ejemplo de reemplazo

El siguiente ejemplo utiliza el método replace_one para reemplazar los campos y valores de un documento en el que el valor del campo name es "Primola Restaurant":

filter = { name: 'Primola Restaurant' }
new_document = { name: 'Frutti Di Mare', cuisine: 'Seafood', borough: 'Queens' }
result = collection.replace_one(filter, new_document)
puts "Replaced #{result.modified_count} document(s)"

Replaced 1 document(s)

Importante

El valor del campo _id es inmutable. Si el documento de reemplazo especifica un valor para el campo _id, debe ser igual al valor _id del documento existente; de lo contrario, el controlador generará un error WriteError.

Personalizar la operación de reemplazo

Puede pasar un objeto Hash como parámetro al método replace_one para establecer opciones que configuren la operación de reemplazo. Si no especifica ninguna opción, el driver realiza la operación de reemplazo con la configuración por defecto.

La siguiente tabla describe las opciones que puedes usar para configurar la operación de reemplazo:

Opción	Descripción
`upsert`	Specifies whether the replace operation performs an upsert operation if no documents match the query filter. For more information, see upsert behavior in the MongoDB Server manual. Defaults to `false`.
`bypass_document_validation`	Specifies whether the update operation bypasses document validation. This lets you update documents that don't meet the schema validation requirements, if any exist. For more information about schema validation, see Schema Validation in the MongoDB Server manual. Defaults to `false`.
`collation`	Specifies the kind of language collation to use when sorting results. For more information, see Collation in the MongoDB Server manual.
`session`	Specifies the session to use for the operation. To learn more about sessions, see Client Sessions and Causal Consistency Guarantees in the MongoDB Server manual.
`hint`	Sets the index to use when matching documents. For more information, see the hint statement in the MongoDB Server manual.
`let`	Provides a map of parameter names and values to set top-level variables for the operation. Values must be constant or closed expressions that don't reference document fields.

El siguiente código realiza la misma operación de reemplazo que el ejemplo anterior, pero establece la opción upsert en true. Esto indica al controlador que inserte un nuevo documento que tenga los campos y valores especificados en el documento de reemplazo si el filtro de query no coincide con ningún documento existente:

options = { upsert: true }
result = collection.replace_one(filter, new_document, options)
puts "Replaced #{result.upserted_count} document(s)"

Replaced 1 document(s)

Valor de retorno

El método replace_one retorna un objeto Mongo::Operation::Update::Result. Se pueden utilizar los siguientes métodos para acceder a la información de una instancia Result:

Método	Descripción
`matched_count`	Returns the number of documents that matched the query filter.
`modified_count`	Returns the number of documents modified by the update operation. If an updated document is identical to the original, it is not included in this count.
`upserted_count`	Returns the number of documents upserted.
`upserted_id`	Returns the `_id` value of the document that the driver upserted into the database, if any.

Información Adicional

Para ver un ejemplo de código ejecutable que demuestra cómo reemplazar un documento, consulte Insertar documentos.

Documentación de la API

Para aprender más sobre cualquiera de los métodos o tipos analizados en esta guía, consulta la siguiente documentación de API:

Volver

Update Documents

Delete Documents