Atualize documentos

Nesta página

Visão geral

Dados de amostra
Atualizar operações
Atualizar um exemplo de documento
Exemplo de atualização de muitos documentos
Personalizar a operação de atualização
Valor de retorno
Informações adicionais
Documentação da API

Visão geral

Neste guia, você aprenderá a usar o driver Scala para atualizar documentos em uma coleção do MongoDB usando os métodos updateOne() e updateMany().

Dados de amostra

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

val database: MongoDatabase = mongoClient.getDatabase("sample_restaurants")
val collection: MongoCollection[Document] = database.getCollection("restaurants")

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

Atualizar operações

Você pode atualizar documentos no MongoDB com os seguintes métodos:

updateOne(), que atualiza o primeiro documento que corresponde aos critérios de pesquisa
updateMany(), que atualiza todos os documentos que correspondem aos critérios de pesquisa

Cada método de atualização exige os seguintes parâmetros:

Filtro de query, que corresponde aos documentos que você deseja atualizar. Para saber mais sobre filtros de query, consulte o guia Especificar uma query.
documento de atualização , que especifica o operador de atualização e os campos e valores a serem atualizados. O operador de atualização especifica o tipo de atualização a ser executada. Para visualizar uma lista de operadores de atualização e saber mais sobre seus usos, consulte a página do guia Operadores de atualização de campo no manual do MongoDB Server .

Atualizar um exemplo de documento

O exemplo seguinte utiliza o método updateOne() para atualizar o valor do campo name de um documento de "Happy Garden" para "Mountain House". O documento de atualização utiliza o método set() para atualizar o valor do campo name:

val filter = equal("name", "Happy Garden")
val update = set("name", "Mountain House")
val observable: Observable[UpdateResult] = collection.updateOne(filter, update)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit =
      println(s"Updated document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Updated document count: 1
Completed

Exemplo de atualização de muitos documentos

O exemplo a seguir usa o método updateMany() para atualizar todos os documentos nos quais o valor do campo name é "Starbucks". O documento de atualização utiliza o método rename() para alterar o nome do campo address para location:

val filter = equal("name", "Starbucks")
val update = rename("address", "location")
val observable: Observable[UpdateResult] = collection.updateMany(filter, update)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit =
      println(s"Updated document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Updated document count: 11
Completed

Personalizar a operação de atualização

Os métodos updateOne() e updateMany() aceitam opcionalmente um parâmetro que define opções para configurar a operação de atualização. Se você não especificar nenhuma opção, o driver executará operações de atualização com as configurações padrão.

A tabela a seguir descreve os métodos de configuração que você pode usar para configurar uma instância UpdateOptions :

Método	Descrição
`upsert()`	Specifies whether the update operation performs an upsert operation if no documents match the query filter. For more information, see the upsert statement in the MongoDB Server manual. Defaults to `false`
`sort()`	Sets the sort criteria to apply to the operation. If multiple documents match the query filter that you pass to the `updateOne()` method, the operation updates the first result. You can set this option to apply an order to matched documents to have more control over which document is updated.
`bypassDocumentValidation()`	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.
`arrayFilters()`	Provides a list of filters that you specify to select which array elements the update applies to.
`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. For more information, see the let statement in the MongoDB Server manual.
`comment()`	Sets a comment to attach to the operation. For more information, see the update command fields guide in the MongoDB Server manual for more information.

Exemplo de modificação de atualização

Este exemplo cria e passa opções para o método updateOne(). O exemplo usa o método assistente equal() para corresponder a documentos nos quais o valor do campo name é "Sunrise Pizzeria". Em seguida, ele usa o método set() para definir o valor do campo borough no primeiro documento correspondente como "Queens" e o valor do campo cuisine como "Italian". O código usa o método combine() para especificar várias atualizações em um documento de atualização.

Como a opção upsert está definida como true na instância UpdateOptions, o driver insere um novo documento que tenha os campos e valores especificados no filtro e documento de atualização se o filtro de query não corresponder a nenhum documento existente.

val filter = equal("name", "Sunrise Pizzeria")
val opts = UpdateOptions().upsert(true)
val update = combine(
  set("borough", "Queens"),
  set("cuisine", "Italian")
)
val observable: Observable[UpdateResult] = collection.updateOne(filter, update, opts)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit =
      println(s"Updated document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Updated document count: 1
Completed

Valor de retorno

Os métodos updateOne() e updateMany() retornam 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()`	Returns the number of documents that matched the query filter, regardless of how many updates were performed.
`getModifiedCount()`	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.
`wasAcknowledged()`	Returns `true` if the server acknowledged the result.
`getUpsertedId()`	Returns the `_id` value of the document that was upserted in the database, if the driver performed an upsert.

Observação

Se o método wasAcknowledged() retornar false, a tentativa de acessar outras informações da instância UpdateResult resultará em uma exceção InvalidOperation . O driver não pode determinar esses valores se o servidor não reconhecer a operação de gravação.

Informações adicionais

Para exibir exemplos de código executáveis que demonstram como atualizar documentos usando o driver Scala, 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

Substituir

Excluir