Substituir documentos

Visão geral

Neste guia, você pode aprender como usar o driver Ruby para executar uma operação de substituição em um documento em uma coleção MongoDB. Uma operação de substituição remove todos os campos e valores de um documento especificado, exceto o campo _id, e adiciona novos campos e valores especificados por você. Esta operação difere de uma operação de atualização, que altera apenas campos especificados em um ou mais documentos.

Para saber mais sobre as operações de atualização, consulte o guia Atualizar documentos .

Dados de amostra

Os exemplos neste guia utilizam a coleção do restaurants no banco de dados do sample_restaurants a partir dosconjuntos de dados de amostra do Atlas. Para acessar essa coleção a partir do seu aplicação Ruby, crie um objeto Mongo::Client que se conecte a um Atlas cluster e atribua os seguintes valores às suas variáveis database e collection:

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

Para saber como criar um cluster MongoDB Atlas gratuito e carregar os conjuntos de dados de amostra, consulte o guia Iniciar com Atlas .

Operação de substituição

Você pode executar uma operação de substituição no MongoDB usando o método replace_one. Este método remove todos os campos, exceto o campo _id do primeiro documento que corresponde ao filtro de query especificado. Em seguida, ele adiciona os campos e valores especificados ao documento vazio.

Parâmetros necessários

Você deve passar os seguintes parâmetros para o método replace_one :

Filtro de query: especifica quais documentos atualizar. Para saber mais sobre filtros de query, consulte o guia Especificar uma query.
documento de substituição: especifica os campos e valores pelos quais você deseja substituir os campos e valores existentes.

Exemplo de substituição

O exemplo a seguir usa o método replace_one para substituir os campos e valores de um documento no qual o valor do campo name é "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

O valor do campo _id é imutável. Se o seu documento de substituição especificar um valor para o campo _id, ele deverá ser igual ao valor _id do documento existente ou o driver gerará uma WriteError.

Personalizar a operação de substituição

Você pode passar um objeto Hash como parâmetro para o método replace_one para definir opções para configurar a operação de substituição. Se você não especificar nenhuma opção, o driver executará a operação de substituição pelas configurações padrão.

A tabela a seguir descreve as opções que você pode usar para configurar a operação de substituição:

Opção	Descrição
`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.

O código a seguir executa a mesma operação de substituição do exemplo anterior, mas define a opção upsert como true. Isso instrui o driver a inserir um novo documento que tenha os campos e valores especificados no documento de substituição se o filtro de query não corresponder a nenhum 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

O método replace_one retorna um objeto Mongo::Operation::Update::Result. Você pode utilizar os seguintes métodos para acessar informações de uma instância do Result :

Método	Descrição
`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.

Informações adicionais

Para exibir um exemplo de código executável que demonstra como substituir um documento, consulte Gravar dados no MongoDB.

Documentação da API

Para saber mais sobre qualquer um dos métodos ou tipos discutidos neste guia, consulte a seguinte documentação da API:

Voltar

Insira documentos

Atualize documentos