Exclua documentos

Dados de amostra

Os exemplos neste guia utilizam a coleção do restaurants a partir do banco de dados do sample_restaurants . Os documentos nesta coleção usam as seguintes classes Restaurant , Address e GradeEntry como modelos:

public class Restaurant
{
    public ObjectId Id { get; set; }
    public string Name { get; set; }
    [BsonElement("restaurant_id")]
    public string RestaurantId { get; set; }
    public string Cuisine { get; set; }
    public Address Address { get; set; }
    public string Borough { get; set; }
    public List<GradeEntry> Grades { get; set; }
}

public class Address
{
    public string Building { get; set; }
    [BsonElement("coord")]
    public double[] Coordinates { get; set; }
    public string Street { get; set; }
    [BsonElement("zipcode")]
    public string ZipCode { get; set; }
}

public class GradeEntry
{
    public DateTime Date { get; set; }
    public string Grade { get; set; }
    public float? Score { get; set; }
}

Esta coleção é dosconjuntos de dados de amostra fornecidos pelo Atlas. Consulte a Introdução ao driver .NET/C# para saber como criar um cluster MongoDB gratuito e carregar esses dados de exemplo.

Excluir um documento

O código abaixo mostra como usar o método síncrono DeleteOne() ou o método assíncrono DeleteOneAsync() para excluir um documento.

var result = _restaurantsCollection.DeleteOne(filter);

var result = await _restaurantsCollection.DeleteOneAsync(filter);

Excluir vários documentos

O código abaixo mostra como usar o método síncrono DeleteMany() ou o método assíncrono DeleteManyAsync() para excluir todos os documentos correspondentes.

var result = _restaurantsCollection.DeleteMany(filter);

var result = await _restaurantsCollection.DeleteManyAsync(filter);

Parâmetros

Os métodos DeleteOne() e DeleteMany() exigem que você passe um filtro de query especificando quais documentos devem corresponder. Mais informações sobre como construir um filtro de query estão disponíveis no tutorial Documentos de query.

Ambos os métodos recebem opcionalmente um tipo DeleteOptions como parâmetro adicional, que representa opções que você pode usar para configurar a operação de exclusão. Se você não especificar nenhuma propriedade DeleteOptions , o driver não personalizará a operação de exclusão.

O tipo DeleteOptions permite a você configurar opções com as seguintes propriedades:

Agrupamentos

Para configurar o agrupamento para sua operação, crie uma instância da classe Agrupamento .

A tabela seguinte descreve os parâmetros que o construtor do Collation aceita. Ela também lista a propriedade de classe correspondente que você pode usar para ler o valor de cada configuração.

Para obter mais informações sobre agrupamento, consulte a página Agrupamento no manual do MongoDB Server.

Exemplo

O código a seguir utiliza o método DeleteMany() para pesquisar no índice " borough_1" e excluir todos os documentos em que o valor do campo address.street contenha a frase "Pearl Street":

var filter = Builders<Restaurant>.Filter
    .Regex("address.street", "Pearl Street");
DeleteOptions opts = new DeleteOptions { Hint = "borough_1" };
Console.WriteLine("Deleting documents...");
var result = _restaurantsCollection.DeleteMany(filter, opts);
Console.WriteLine($"Deleted documents: {result.DeletedCount}");
Console.WriteLine($"Result acknowledged? {result.IsAcknowledged}");

Deleting documents...
Deleted documents: 26
Result acknowledged? True

Valor de retorno

Os métodos DeleteOne() e DeleteMany() retornam um tipo DeleteResult . Este tipo contém a propriedade DeletedCount , que indica o número de documentos excluídos, e a propriedade IsAcknowledged , que indica se o resultado é reconhecido. Se o filtro de query não corresponder a nenhum documento, nenhum documento será excluído e DeletedCount será 0.

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:

• DeleteOne()

• DeleteOneAsync()

• DeleteMany()

• DeleteManyAsync()

• Excluir opções

• DeleteResult