Delete Documents

样本数据

本指南中的示例使用sample_restaurants数据库中的restaurantscollection。此collection中的文档使用以下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提供的 示例数据集。请参阅.NET/ C#驱动程序入门，学习；了解如何创建免费的MongoDB 集群并加载此示例数据。

删除一个文档

以下代码演示如何使用同步 DeleteOne() 方法或异步 DeleteOneAsync() 方法删除一个文档。

var result = _restaurantsCollection.DeleteOne(filter);

var result = await _restaurantsCollection.DeleteOneAsync(filter);

删除多个文档

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

var result = _restaurantsCollection.DeleteMany(filter);

var result = await _restaurantsCollection.DeleteManyAsync(filter);

参数

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

这两种方法都可以选择采用DeleteOptions类型作为附加参数，该参数表示可用于配置删除操作的选项。 如果您不指定任何DeleteOptions属性，驾驶员将不会自定义删除操作。

DeleteOptions 类型允许您使用以下属性配置选项：

排序规则

要为操作配置排序规则，请创建排序规则 类的实例。

下表描述了 Collation 构造函数接受的参数。它还列出了相应的类属性，您可以使用这些属性读取每个设置的值。

有关排序规则的更多信息，请参阅MongoDB Server手册中的排序规则页面。

例子

以下代码使用 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