Menu Docs
Página inicial do Docs
/
Idiomas
/
Kotlin
/
Driver de Kotlin Sync
/
Gravar dados

Exclua documentos

Nesta página

  • Visão geral
  • Dados de amostra
  • Excluir operações
  • Excluir um documento
  • Excluir vários documentos
  • Personalizar a operação de exclusão
  • Valor de retorno
  • Documentação da API

Visão geral

Neste guia, você pode aprender como usar o driver Kotlin Sync para remover documentos de uma coleção MongoDB executando operações de exclusão.

Uma operação de exclusão remove um ou mais documentos de uma collection do MongoDB. Você pode executar uma operação de exclusão utilizando os métodos deleteOne() ou deleteMany() .

Dados de amostra

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)

Excluir operações

Você pode executar operações de exclusão no MongoDB usando os seguintes métodos:

  • deleteOne(), que exclui o primeiro documento que corresponde aos critérios do Atlas Search

  • deleteMany(), que exclui todos os documentos que correspondem aos critérios do Atlas Search

Cada método de exclusão requer um query filtro documento, que especifica os critérios de pesquisa que determinam quais documentos selecionar para remoção. Para saber mais sobre filtros de query, consulte o guia Especificar uma query .

Excluir um documento

O exemplo a seguir usa o método deleteOne() para remover um documento no qual o valor do campo name é "Happy Garden":

val filter = eq(Restaurant::name.name, "Happy Garden")
val result = collection.deleteOne(filter)

Excluir vários documentos

O exemplo a seguir usa o método deleteMany() para remover todos os documentos nos quais o valor do campo borough é "Brooklyn" e o valor do campo name é "Starbucks":

val filter = and(
    eq(Restaurant::borough.name, "Brooklyn"),
    eq(Restaurant::name.name, "Starbucks")
)
val result = collection.deleteMany(filter)

Personalizar a operação de exclusão

Os métodos deleteOne() e deleteMany() aceitam opcionalmente um parâmetro DeleteOptions , que representa as opções que você pode usar para configurar a operação de exclusão. Se você não especificar nenhuma opção, o driver executará a operação de exclusã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 DeleteOptions :

Método
Descrição
collation()
Specifies the kind of language collation to use when sorting results. For more information, see Collation in the MongoDB Server manual.
hint()
Specifies the index to use when matching documents. For more information, see the hint statement in the MongoDB Server manual.
hintString()
Specifies the index as a string 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 delete command fields guide in the MongoDB Server manual for more information.

Exemplo de modificação de exclusão

O código a seguir cria opções e usa o método comment() para adicionar um comentário à operação de exclusão. Em seguida, o exemplo usa o método deleteMany() para excluir todos os documentos na collection restaurants na qual o valor do campo name inclui a string "Red".

val opts = DeleteOptions().comment("sample comment")
val filter = regex(Restaurant::name.name, "Red")
val result = collection.deleteOne(filter, opts)

Dica

Se você usar o método deleteOne() no exemplo anterior, em vez do método deleteMany() , o driver excluirá apenas o primeiro documento que corresponde ao filtro de query.

Valor de retorno

Os métodos deleteOne() e deleteMany() retornam uma instância do DeleteResult . Você pode acessar as seguintes informações de uma instância do DeleteResult :

  • deletedCount, que indica o número de documentos excluídos

  • wasAcknowledged(), que retorna true se o servidor reconhecer o resultado

Se o filtro de query não corresponder a nenhum documento, o driver não excluirá nenhum documento e o valor de deletedCount será 0.

Observação

Se o método wasAcknowledged() retornar false, tentar acessar a propriedade deletedCount 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.

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

Próximo

Gravação em massa