/ /

Substituir documentos

Visão geral

Neste guia, você pode aprender como usar o driver Scala 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 restaurants collection no sample_restaurants banco de dados dos conjuntos de dados de amostra do Atlas . Para acessar essa coleção a partir do seu aplicação Scala, crie um objeto MongoClient que se conecte a um Atlas cluster e atribua os seguintes valores às suas variáveis database e collection:

val database: MongoDatabase = mongoClient.getDatabase("sample_restaurants")
val collection: MongoCollection[Document] = database.getCollection("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 replaceOne(). 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 replaceOne() :

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

Substituir um documento

O exemplo a seguir usa o método replaceOne() para substituir os campos e valores de um documento no qual o valor do campo name é "Primola Restaurant":

val filter = equal("name", "Primola Restaurant")
val replacement = Document(
  "name" -> "Frutti Di Mare",
  "borough" -> "Queens",
  "cuisine" -> "Seafood",
  "owner" -> "Sal Thomas"
)
val observable: Observable[UpdateResult] = collection.replaceOne(filter, replacement)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit = println(s"Replaced document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Replaced document count: 1
Completed

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

O método replaceOne() aceita opcionalmente um parâmetro com o tipo de dados ReplaceOptions. A classe ReplaceOptions contém métodos de configuração que você pode utilizar para configurar a opçã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 os métodos de preparação na classe ReplaceOptions :

Método	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` é.
`sort()`	Define os critérios de classificação a serem aplicados à operação. Se vários documentos corresponderem ao filtro de query que você passa para o método `replaceOne()`, a operação substituirá o primeiro resultado. Você pode definir essa opção como para aplicar um pedido a documentos correspondentes para ter mais controle sobre qual documento é substituído.
`bypassDocumentValidation()`	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 .
`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 .
`comment()`	Define um comentário a ser anexado à operação.

O código a seguir define a opção upsert como true, que 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:

val options = ReplaceOptions().upsert(true)
val observable: Observable[UpdateResult] = collection.replaceOne(filter, replacement, options)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit = println(s"Replaced document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Replaced document count: 1
Completed

Valor de retorno

O método replaceOne() retorna um objeto UpdateResult . Você pode utilizar os seguintes métodos para acessar informações de uma instância do UpdateResult :

Método	Descrição
`getMatchedCount()`	Retorna o número de documentos que corresponderam ao filtro de query.
`getModifiedCount()`	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.
`wasAcknowledged()`	Retorna `true` se o servidor reconheceu o resultado.
`getUpsertedId()`	Retorna o valor `_id` do documento que o driver atualizou no banco de dados, se houver.

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

Insert

Update