Delete Documents

Sample Data

The examples in this guide use the restaurants collection from the sample_restaurants database. The documents in this collection use the following Restaurant, Address, and GradeEntry classes as models:

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; }
}

This collection is from the sample datasets provided by Atlas. See the Get Started with the .NET/C# Driver to learn how to create a free MongoDB cluster and load this sample data.

Delete One Document

The following code shows how to use the asynchronous DeleteOneAsync() method or the synchronous DeleteOne() method to delete one document.

var result = await _restaurantsCollection.DeleteOneAsync(filter);

var result = _restaurantsCollection.DeleteOne(filter);

Delete Multiple Documents

The following code shows how to use the asynchronous DeleteManyAsync() method or the synchronous DeleteMany() method to delete all matched documents.

var result = await _restaurantsCollection.DeleteManyAsync(filter);

var result = _restaurantsCollection.DeleteMany(filter);

Parameters

The DeleteOne() and DeleteMany() methods require you to pass a query filter specifying which documents to match. More information on how to construct a query filter is available in the Query Documents tutorial.

Both methods optionally take a DeleteOptions type as an additional parameter, which represents options you can use to configure the delete operation. If you don't specify any DeleteOptions properties, the driver does not customize the delete operation.

The DeleteOptions type allows you to configure options with the following properties:

Collation

To configure collation for your operation, create an instance of the Collation class.

The following table describes the parameters that the Collation constructor accepts. It also lists the corresponding class property that you can use to read each setting's value.

For more information about collation, see the Collation page in the MongoDB Server manual.

Example

The following code uses the DeleteMany() method to search on the "borough_1" index and delete all documents where the address.street field value includes the phrase "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

Return Value

The DeleteOne() and DeleteMany() methods return a DeleteResult type. This type contains the DeletedCount property, which indicates the number of documents deleted, and the IsAcknowledged property, which indicates if the result is acknowledged. If the query filter does not match any documents, no documents are deleted and DeletedCount is 0.

API Documentation

To learn more about any of the methods or types discussed in this guide, see the following API Documentation:

• DeleteOne()

• DeleteOneAsync()

• DeleteMany()

• DeleteManyAsync()

• DeleteOptions

• DeleteResult