Menu Docs

Substituir documentos

Neste guia, você pode aprender como usar o driver Kotlin Sync 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 campo e valores especificados por você. Essas operações são diferentes 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 .

Os exemplos neste guia usam a collection sample_restaurants.restaurants dos conjuntos de dados de amostra do Atlas. Para saber como criar um cluster MongoDB Atlas gratuito e carregar os conjuntos de dados de amostra, consulte o guia Iniciar com Atlas .

Os documentos nesta coleção são modelados pela seguinte classe de dados Kotlin :

data class Restaurant(
val name: String,
val borough: String,
val cuisine: String,
val owner: String?,
)

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. Em seguida, ele adiciona os campos e valores especificados ao documento vazio.

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.

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 = Filters.eq(Restaurant::name.name, "Primola Restaurant")
val replacement = Restaurant(
"Frutti Di Mare",
"Queens",
"Seafood",
owner = "Sal Thomas"
)
val result = collection.replaceOne(filter, replacement)

Importante

Os valores de _id campos são imutáveis. 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á um WriteError.

O método replaceOne() aceita opcionalmente um parâmetro que define 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 os métodos de configuração que você pode usar para configurar uma instância ReplaceOptions :

Propriedade
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

sort(Bson sort)

Sets the sort criteria to apply to the operation. If multiple documents match the query filter that you pass to the replaceOne() method, the operation replaces the first result. You can set this option to apply an order to matched documents to have more control over which document is replaced.

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.

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.

comment()

Sets a comment to attach to the operation.

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 opts = ReplaceOptions().upsert(true)
val result = collection.replaceOne(filter, replacement, opts)

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 :

Propriedade
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.

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

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