Merge pull request #7 from rustagir/DOCSP-13860-updatemany-usage-ex

DOCSP 13860: UpdateMany usage example

Author: rustagir

source/code-snippets/updateMany.go

@@ -0,0 +1,41 @@
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/mongo"
+	"go.mongodb.org/mongo-driver/mongo/options"
+)
+
+// Replace the uri string with your MongoDB deployment's connection string.
+const uri = "mongodb+srv://<username>:<password>@<cluster-address>/test?w=majority"
+
+func main() {
+	client, err := mongo.Connect(context.TODO(), options.Client().ApplyURI(uri))
+
+	if err != nil {
+		panic(err)
+	}
+	defer func() {
+		if err = client.Disconnect(context.TODO()); err != nil {
+			panic(err)
+		}
+	}()
+
+	// begin updatemany
+	myCollection := client.Database("sample_airbnb").Collection("listingsAndReviews")
+	filter := bson.D{{"address.market", "Sydney"}}
+	update := bson.D{{"$mul", bson.D{{"price", 1.15}}}}
+
+	result, err := myCollection.UpdateMany(context.TODO(), filter, update)
+	// end updatemany
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Printf("Documents updated: %v\n", result.ModifiedCount)
+
+}

source/includes/run-example-tip.rst

@@ -1,4 +1,4 @@
 .. tip::
 
    Read the :doc:`Usage Examples guide </usage-examples>` to learn how
-   to run this example.
+   to run this example.

source/usage-examples/updateMany.txt

@@ -3,3 +3,56 @@ Update Multiple Documents
 =========================
 
 .. default-domain:: mongodb
+
+You can update multiple documents in a collection by using the ``UpdateMany()``
+method.
+
+The following example passes a query filter and an update parameter to the
+``UpdateMany()`` method, which matches documents in the
+``listingsAndReviews`` collection where the value of the ``address.market``
+field is "Sydney" and multiplies the ``price`` field in the matching
+documents by a factor of *1.15*:
+
+.. include:: /includes/run-example-tip.rst
+
+.. literalinclude:: /code-snippets/updateMany.go
+   :start-after: begin updatemany
+   :end-before: end updatemany
+   :emphasize-lines: 5
+   :language: go
+   :dedent:
+
+Click here **<TODO: github link to file>** to see a fully runnable example.
+
+Expected Result
+---------------
+
+After you run the code example, the ``price`` field of the matched
+documents will reflect the multiplication. The updated documents will
+appear similar to these:
+
+.. code-block:: json
+   :copyable: false
+
+   // results truncated
+   ...
+   { "_id" : "10091713", ... , "name" : "Surry Hills Studio", ... , "price" : 181.00, ... },
+   { "_id" : "9908871", ... , "name" : "Family friendly beach house", ... , "price" : 751.00, ... },
+   { "_id" : "20989061", ... , "name" : "Big and sunny Narraben room", ... , "price" : 60.00, ... },
+   ...
+
+Additional Information
+----------------------
+
+For more information on updating documents, specifying query filters, and
+handling potential errors, see our guide on **<TODO: change a document
+fundamental page>**.
+
+For more information on update operators,
+see the :manual:`MongoDB update operator reference documentation
+</reference/operator/update/#update-operators>`.
+
+API Documentation
+~~~~~~~~~~~~~~~~~
+
+`UpdateMany() <https://pkg.go.dev/go.mongodb.org/[email protected]/mongo#Collection.UpdateMany>`_