Delete Documents

Datos de muestra

Los ejemplos de esta guía utilizan el restaurants colección de la base de datos sample_restaurants. Los documentos de esta colección utilizan las siguientes clases Restaurant, Address y 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 colección es de la conjuntos de datos de muestra proporcionados por Atlas. Consulta la Guía de inicio rápido para aprender a crear un clúster gratuito de MongoDB y cargar estos datos de ejemplo.

Borrar un documento

El siguiente código muestra cómo usar el método asincrónico DeleteOneAsync() o el método sincrónico DeleteOne() para borrar un documento.

var result = await _restaurantsCollection.DeleteOneAsync(filter);

var result = _restaurantsCollection.DeleteOne(filter);

Borra varios documentos

El siguiente código muestra cómo usar el método asíncrono DeleteManyAsync() o el método sincrónico DeleteMany() para borrar todos los documentos coincidentes.

var result = await _restaurantsCollection.DeleteManyAsync(filter);

var result = _restaurantsCollection.DeleteMany(filter);

Parámetros

Los métodos DeleteOne() y DeleteMany() requieren que pases un filtro de query especificando qué documentos deben coincidir. Más información sobre cómo construir un filtro de query está disponible en el tutorial documentos de query

Ambos métodos aceptan opcionalmente un tipo de DeleteOptions como parámetro adicional, el cual representa las opciones que se pueden utilizar para configurar la operación de borrado. Si no se especifica ninguna propiedad DeleteOptions, el driver no personaliza la operación de borrado.

El tipo DeleteOptions le permite configurar opciones con las siguientes propiedades:

Ejemplo

El siguiente código utiliza el método DeleteMany() para buscar en el índice "borough_1" y eliminar todos los documentos donde el valor del campo address.street incluye la 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

Los métodos DeleteOne() y DeleteMany() devuelven un tipo DeleteResult. Este tipo contiene la propiedad DeletedCount, que indica el número de documentos eliminados, y la propiedad IsAcknowledged, que indica si el resultado se reconoce. Si el filtro de query no coincide con ningún documento, no se borrarán documentos y DeletedCount será 0.

Documentación de la API

Para obtener más información sobre cualquiera de los métodos o tipos discutidos en esta guía, consultar la siguiente documentación de la API:

• deleteOne()

• DeleteOneAsync()

• deleteMany()

• DeleteManyAsync()

• DeleteOptions

• DeleteResult