Delete Documents

サンプル データ

このガイドの例では、 sample_restaurantsデータベースの 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()メソッドを使用して 1 つのドキュメントを削除する方法を示しています。

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()メソッドでは、一致するドキュメントを指定するクエリフィルターを渡す必要があります。 クエリフィルターの作成方法について詳しくは、「 ドキュメントのクエリ 」のチュートリアルを参照してください。

Both methods optionally take a DeleteOptions type as an additional parameter, which represents options you can use to configure the delete operation. DeleteOptionsプロパティを指定しない場合、ドライバーは削除操作をカスタマイズしません。

DeleteOptionsタイプでは、次のプロパティを持つオプションを構成できます。

例

次のコードでは、 DeleteMany()メソッドを使用して「bool_ 1 」インデックスを検索し、 address.streetフィールド値に "Pearl Center" というフレーズが含まれるすべてのドキュメントを削除します。

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