DOCSP-24537 delete many usageex (#17)

* test

* DOCSP-24537 deleteMany usage example

* page added to tree

* PR comments 1

* fixed code comments for include

* PR comments 2

* namespace correction

Author: rustagir

source/includes/code-examples/delete-many/DeleteMany.cs

@@ -0,0 +1,58 @@
+using MongoDB.Bson;
+using MongoDB.Bson.Serialization.Attributes;
+using MongoDB.Bson.Serialization.Conventions;
+using MongoDB.Driver;
+using static System.Console;
+
+namespace CSharpExamples.UsageExamples;
+
+public class DeleteMany
+{
+    private static IMongoCollection<Restaurant> _restaurantsCollection;
+    private static string _mongoConnectionString = "<Your MongoDB URI>";
+    
+    public static void Main(string[] args)
+    {
+        Setup();
+        
+        var docs = _restaurantsCollection.Find(Builders<Restaurant>.Filter
+            .Regex("name", "Green")).ToList();
+
+        // Deleting documents using builders
+        WriteLine("Deleting documents...");
+        var result = DeleteMultipleRestaurantsBuilder();
+
+        WriteLine($"Deleted documents: {result.DeletedCount}");
+        
+        Restore(docs);
+    }
+
+    private static DeleteResult DeleteMultipleRestaurantsBuilder()
+    {
+        // start-delete-many-builders
+        var filter = Builders<Restaurant>.Filter
+            .Regex("name", "Green");
+
+        var result = _restaurantsCollection.DeleteMany(filter);
+        return result;
+        // end-delete-many-builders
+    }
+
+    private static void Restore(IEnumerable<Restaurant> docs)
+    {
+        _restaurantsCollection.InsertMany(docs);
+        WriteLine("Resetting sample data...done.");
+    }
+
+    private static void Setup()
+    {
+        // This allows automapping of the camelCase database fields to our models. 
+        var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
+        ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
+
+        // Establish the connection to MongoDB and get the restaurants database
+        var mongoClient = new MongoClient(_mongoConnectionString);
+        var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
+        _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");
+    }
+}

source/includes/code-examples/delete-many/DeleteManyAsync.cs

@@ -0,0 +1,58 @@
+using MongoDB.Bson;
+using MongoDB.Bson.Serialization.Attributes;
+using MongoDB.Bson.Serialization.Conventions;
+using MongoDB.Driver;
+using static System.Console;
+
+namespace CSharpExamples.UsageExamples;
+
+public class DeleteManyAsync
+{
+    private static IMongoCollection<Restaurant> _restaurantsCollection;
+    private static string _mongoConnectionString = "<Your MongoDB URI>";
+    
+    public static void Main(string[] args)
+    {
+        Setup();
+        
+        var docs = _restaurantsCollection.Find(Builders<Restaurant>.Filter
+            .Regex("name", "Green")).ToList();
+
+        // Deleting documents using builders
+        WriteLine("Deleting documents...");
+        var result = DeleteMultipleRestaurantsBuilderAsync();
+
+        WriteLine($"Deleted documents: {result.Result.DeletedCount}");
+        
+        Restore(docs);
+    }
+
+    private static async Task<DeleteResult> DeleteMultipleRestaurantsBuilderAsync()
+    {
+        // start-delete-many-async
+        var filter = Builders<Restaurant>.Filter
+            .Regex("name", "Green");
+
+        var result = await _restaurantsCollection.DeleteManyAsync(filter);
+        return result;
+        // end-delete-many-async
+    }
+
+    private static void Restore(IEnumerable<Restaurant> docs)
+    {
+        _restaurantsCollection.InsertMany(docs);
+        WriteLine("Resetting sample data...done.");
+    }
+
+    private static void Setup()
+    {
+        // This allows automapping of the camelCase database fields to our models. 
+        var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
+        ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
+
+        // Establish the connection to MongoDB and get the restaurants database
+        var mongoClient = new MongoClient(_mongoConnectionString);
+        var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
+        _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");
+    }
+}

source/includes/code-examples/delete-many/Restaurant.cs

@@ -0,0 +1,23 @@
+using MongoDB.Bson;
+using MongoDB.Bson.Serialization.Attributes;
+namespace UsageExamples.DeleteMany;
+
+// start-model
+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 object Address { get; set; }
+    
+    public string Borough { get; set; }
+    
+    public List<object> Grades { get; set; }
+}
+// end-model

source/usage-examples.txt

@@ -12,4 +12,5 @@ TODO: Write usage examples page
    /usage-examples/findMany
    /usage-examples/updateOne
    /usage-examples/updateMany
-   /usage-examples/deleteOne
+   /usage-examples/deleteOne
+   /usage-examples/deleteMany

source/usage-examples/deleteMany.txt

@@ -0,0 +1,86 @@
+.. _csharp-delete-many:
+
+=====================
+Delete Many Documents
+=====================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+You can delete more than one document using the ``DeleteMany()`` method on
+a collection object.
+
+Example
+-------
+
+These examples use the following ``Restaurant`` class as a model:
+
+.. literalinclude:: ../includes/code-examples/delete-many/Restaurant.cs
+   :start-after: start-model
+   :end-before: end-model
+   :language: csharp
+   :copyable:
+   :dedent:
+
+The following code deletes all documents in the ``restaurants`` collection whose 
+``name`` field value includes the word "Green".
+
+Select the :guilabel:`Asynchronous` or :guilabel:`Synchronous` tab to see the corresponding 
+code.
+
+.. tabs::
+
+   .. tab:: Asynchronous
+      :tabid: delete-many-async
+
+      .. literalinclude:: ../includes/code-examples/delete-many/DeleteManyAsync.cs
+         :start-after: start-delete-many-async
+         :end-before: end-delete-many-async
+         :language:  csharp
+         :copyable:
+         :dedent:
+
+      For a fully runnable example of the ``DeleteManyAsync()`` operation, see the
+      `DeleteManyAsync code sample <{+example+}/delete-many/DeleteManyAsync.cs>`__.
+
+   .. tab:: Synchronous
+      :tabid: delete-many-sync
+
+      .. literalinclude:: ../includes/code-examples/delete-many/DeleteMany.cs
+         :start-after: start-delete-many
+         :end-before: end-delete-many
+         :language:  csharp
+         :copyable:
+         :dedent:
+      
+      For a fully runnable example of the ``DeleteMany()`` operation, see the
+      `DeleteMany code sample <{+example+}/delete-many/DeleteMany.cs>`__.
+
+Expected Result
+~~~~~~~~~~~~~~~
+
+Running either of the preceding full examples prints the following results:
+
+.. code-block:: none
+
+   Deleting documents...
+   Deleted documents: 102
+   Resetting sample data...done.
+
+More Information
+----------------
+
+.. TODO: Add links to references once pages are done
+
+.. TODO: To learn more about builders, see <builders page>.
+
+API Documentation
+-----------------
+
+* `DeleteMany() <{+api-root+}/Overload_MongoDB_Driver_IMongoCollectionExtensions_DeleteMany.htm>`__
+* `DeleteManyAsync() <{+api-root+}/Overload_MongoDB_Driver_IMongoCollectionExtensions_DeleteManyAsync.htm>`__