/ /

Ruby Driver

Atualize documentos

Página inicial do Docs

Bibliotecas do cliente

Ruby

Ruby Driver

Atualize documentos

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 usam a collection restaurants no banco de dados sample_restaurants dos conjuntos 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 aprender a criar um cluster MongoDB Atlas gratuito e carregar os conjuntos de dados de amostra, consulte o Guia de Introdução do MongoDB.

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`	Especifica se a operação de substituição executará uma operação de upsert se nenhum documento corresponder ao filtro de consulta. Para obter mais informações, consulte comportamento upsert no manual do MongoDB Server . O padrão `false` é.
`bypass_document_validation`	Especifica se a operação de atualização ignora a validação do documento . Isso permite atualizar documentos que não atendam aos requisitos de validação de esquema , se houver. Para obter mais informações sobre validação de esquema, consulte Validação de esquema no manual do MongoDB Server . O padrão `false` é.
`collation`	Especifica o tipo de agrupamento de idiomas a ser usado ao classificar os resultados. Para obter mais informações, consulte Agrupamento no manual do MongoDB Server .
`session`	Especifica a sessão a ser usada para a operação. Para saber mais sobre sessões, consulte Sessões de cliente e garantias de consistência causal no manual do MongoDB Server .
`hint`	Define o índice a ser usado na correspondência de documentos. Para obter mais informações, consulte a declaração de dica no manual do MongoDB Server .
`let`	Fornece um mapa de nomes e valores de parâmetros para definir variáveis de nível superior para a operação. Os valores devem ser expressões constantes ou fechadas que não façam referência aos campos do documento .

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`	Retorna o número de documentos que corresponderam ao filtro de query.
`modified_count`	Retorna o número de documentos modificados pela operação de atualização. Se um documento atualizado for idêntico ao original, ele não será incluído nesta contagem.
`upserted_count`	Retorna o número de documentos atualizados.
`upserted_id`	Retorna o valor `_id` do documento que o driver atualizou no banco de dados, se houver.

Informações adicionais

Para visualizar um exemplo de código executável que demonstra como substituir um documento, consulte Inserir documentos.

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

Atualize documentos

Exclua documentos