/ /

Exclua documentos

Visão geral

Neste guia, você pode aprender como usar o driver C++ 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 delete_one() ou delete_many() .

Dados de amostra

The examples in this guide use the restaurants collection in the sample_restaurants database from the Atlas sample datasets. To access this collection from your C++ application, instantiate a mongocxx::client that connects to an Atlas cluster and assign the following values to your db and collection variables:

auto db = client["sample_restaurants"];
auto collection = db["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.

Excluir operações

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

delete_one(), que exclui o primeiro documento que corresponde aos critérios do Atlas Search
delete_many(), que exclui todos os documentos que correspondem aos critérios do Atlas Search

Each delete method requires a query filter document, which specifies the search criteria to determine which documents to select for removal. For more information about query filters, see the Query Filter Documents section in the MongoDB Server manual.

Excluir um documento

O exemplo a seguir usa o método delete_one() para remover um documento na collection restaurants que tem um valor name de "Ready Penny Inn":

auto result = collection.delete_one(make_document(kvp("name", "Ready Penny Inn")));

Excluir vários documentos

O exemplo a seguir usa o método delete_many() para remover todos os documentos na collection restaurants que tenham um valor borough de "Brooklyn":

auto result = collection.delete_many(make_document(kvp("borough", "Brooklyn")));

Personalizar a operação de exclusão

Você pode modificar o comportamento dos métodos delete_one() e delete_many() passando uma instância da classe mongocxx::options::delete_options como parâmetro opcional. A tabela seguinte descreve os campos que você pode definir em uma instância do mongocxx::options::delete_options :

Campo	Descrição
`collation`	Specifies the kind of language collation to use when sorting results. For more information, see Collation in the MongoDB Server manual.
`write_concern`	Sets the write concern for the operation. For more information, see Write Concern in the MongoDB Server manual.
`hint`	Gets or sets the index to scan for documents. For more information, see the hint statement in the MongoDB Server manual.
`let`	Specifies a document with a list of values to improve operation readability. 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`	Attaches a comment to the operation. For more information, see the delete command fields guide in the MongoDB Server manual.

O exemplo seguinte chama o método delete_many() para excluir todos os documentos na coleção restaurants que têm um valor name contendo a string "Mongo". Ele também define o campo comment de uma instância mongocxx::options::delete_options para adicionar um comentário à operação:

mongocxx::options::delete_options opts{};
opts.comment(bsoncxx::types::bson_value::view_or_value{"Deleting Mongo restaurants"});
auto query_filter = make_document(kvp("name", make_document(kvp("$regex", "Mongo"))));
auto result = collection.delete_many(query_filter.view(), opts);

Dica

Se o exemplo anterior usasse o método delete_one() em vez de delete_many(), o driver excluiria apenas o primeiro documento que tivesse um valor name contendo "Mongo".

Valor de retorno

Os métodos delete_one() e delete_many() retornam uma instância da classe mongocxx::result::delete_result . Esta classe contém as seguintes funções de membro:

result(), que retorna o resultado bruto da gravação em massa
deleted_count(), que retorna o número de documentos excluídos

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

O exemplo a seguir chama o método delete_many() para excluir documentos que tenham um valor cuisine de "Greek". Em seguida, ele chama a função de membro deleted_count() para imprimir o número de documentos excluídos:

auto result = collection.delete_many(make_document(kvp("cuisine", "Greek")));
std::cout << result->deleted_count() << std::endl;

Deleted documents: 111

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

Gravação em massa