删除文档

示例数据

本指南中的示例使用的是restaurants 集合，该集合来自 sample_restaurants 数据库。该集合中的文档使用以下 Restaurant、Address 和 GradeEntry 类作为模型

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

此集合来自 Atlas 提供的示例数据集。有关如何创建免费 MongoDB 集群并加载此示例数据的说明，请参阅快速入门。

删除单个文档

以下代码展示了如何使用异步的 DeleteOneAsync() 方法或同步的 DeleteOne() 方法来删除单个文档。

var result = await _restaurantsCollection.DeleteOneAsync(filter);

var result = _restaurantsCollection.DeleteOne(filter);

删除多个文档

以下代码展示了如何使用异步的 DeleteManyAsync() 方法或同步的 DeleteMany() 方法来删除所有匹配的文档。

var result = await _restaurantsCollection.DeleteManyAsync(filter);

var result = _restaurantsCollection.DeleteMany(filter);

参数

DeleteOne() 和 DeleteMany() 方法需要您传递一个查询过滤器，指定哪些文档需要匹配。有关如何构建查询过滤器的更多信息，请参阅查询文档教程。

这两种方法可以可选地接受一个 DeleteOptions 类型的附加参数，它表示您可以用来配置删除操作的选项。如果您未指定任何 DeleteOptions 属性，驱动程序不会自定义删除操作。

DeleteOptions 类型允许您通过以下属性配置选项

示例

以下代码使用DeleteMany()方法在"borough_1"索引上搜索，并删除所有address.street字段值包含"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

返回值

DeleteOne() 和 DeleteMany() 方法返回一个 DeleteResult 类型。此类型包含 DeletedCount 属性，指示被删除的文档数量，以及 IsAcknowledged 属性，指示结果是否被确认。如果查询过滤器没有匹配到任何文档，则不会删除任何文档，且 DeletedCount 为 0。

API 文档

要了解更多关于本指南中讨论的任何方法或类型的信息，请参阅以下 API 文档

• DeleteOne()

• DeleteOneAsync()

• DeleteMany()

• DeleteManyAsync()

• DeleteOptions

• DeleteResult