/ /

Substituir documentos

Visão geral

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

Dados de amostra

Os exemplos neste guia usam a sample_restaurants.restaurants coleção dos conjuntos de dados de amostra do Atlas . Para aprender a criar uma implantação gratuita do MongoDB e carregar os conjuntos de dados de amostra, consulte o guia Começar do MongoDB.

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?,
)

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

Personalizar a operação de substituição

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

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 :

Propriedade	Descrição
`getMatchedCount()`	Retorna o número de documentos que corresponderam ao filtro de query, independentemente de quantas atualizações foram realizadas.
`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 de `_id` do documento que foi atualizado no banco de dados, se o driver executou um upsert.

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