DOCSP-26414 Update "Replace a Document" Usage Example with Document Structs (#201)

* DOCSP-26414 add document struct and adjust replace page

* reduce number of fields

* reduce number of fields on insertMany example

* shorten insertOne example

* remove 'results truncated' comment

Author: ajhuh-mdb

source/includes/usage-examples/code-snippets/insertMany.go

@@ -14,10 +14,10 @@ import (
 // start-restaurant-struct
 type Restaurant struct {
 	Name         string
-	RestaurantId string `bson:"restaurant_id,omitempty"`
-	Cuisine      string
-	Address      interface{} `bson:"address,omitempty"`
-	Borough      string
+	RestaurantId string        `bson:"restaurant_id,omitempty"`
+	Cuisine      string        `bson:"cuisine,omitempty"`
+	Address      interface{}   `bson:"address,omitempty"`
+	Borough      string        `bson:"borough,omitempty"`
 	Grades       []interface{} `bson:"grades,omitempty"`
 }
 
@@ -46,9 +46,8 @@ func main() {
 	// begin insertMany
 	coll := client.Database("sample_restaurants").Collection("restaurants")
 	newRestaurants := []interface{}{
-		Restaurant{Name: "Rule of Thirds", Cuisine: "Japanese", Borough: "Brooklyn"},
-		Restaurant{Name: "Soothr", Cuisine: "Thai", Borough: "Manhattan"},
-		Restaurant{Name: "Madame Vo", Cuisine: "Vietnamese", Borough: "Manhattan"},
+		Restaurant{Name: "Rule of Thirds", Cuisine: "Japanese"},
+		Restaurant{Name: "Madame Vo", Cuisine: "Vietnamese"},
 	}
 
 	result, err := coll.InsertMany(context.TODO(), newRestaurants)
@@ -58,7 +57,7 @@ func main() {
 	// end insertMany
 
 	// When you run this file, it should print:
-	// 3 documents inserted with IDs: ObjectID("..."), ObjectID("...")
+	// 2 documents inserted with IDs: ObjectID("..."), ObjectID("...")
 	fmt.Printf("%d documents inserted with IDs:\n", len(result.InsertedIDs))
 	for _, id := range result.InsertedIDs {
 		fmt.Printf("\t%s\n", id)

source/includes/usage-examples/code-snippets/insertOne.go

@@ -14,10 +14,10 @@ import (
 // start-restaurant-struct
 type Restaurant struct {
 	Name         string
-	RestaurantId string `bson:"restaurant_id,omitempty"`
-	Cuisine      string
-	Address      interface{} `bson:"address,omitempty"`
-	Borough      string
+	RestaurantId string        `bson:"restaurant_id,omitempty"`
+	Cuisine      string        `bson:"cuisine,omitempty"`
+	Address      interface{}   `bson:"address,omitempty"`
+	Borough      string        `bson:"borough,omitempty"`
 	Grades       []interface{} `bson:"grades,omitempty"`
 }
 
@@ -45,7 +45,7 @@ func main() {
 
 	// begin insertOne
 	coll := client.Database("sample_restaurants").Collection("restaurants")
-	newRestaurant := Restaurant{Name: "8282", Cuisine: "Korean", Borough: "Manhattan"}
+	newRestaurant := Restaurant{Name: "8282", Cuisine: "Korean"}
 
 	result, err := coll.InsertOne(context.TODO(), newRestaurant)
 	if err != nil {

source/includes/usage-examples/code-snippets/replace.go

@@ -12,6 +12,18 @@ import (
 	"go.mongodb.org/mongo-driver/mongo/options"
 )
 
+// start-restaurant-struct
+type Restaurant struct {
+	Name         string
+	RestaurantId string        `bson:"restaurant_id,omitempty"`
+	Cuisine      string        `bson:"cuisine,omitempty"`
+	Address      interface{}   `bson:"address,omitempty"`
+	Borough      string        `bson:"borough,omitempty"`
+	Grades       []interface{} `bson:"grades,omitempty"`
+}
+
+// end-restaurant-struct
+
 func main() {
 	if err := godotenv.Load(); err != nil {
 		log.Println("No .env file found")
@@ -33,9 +45,9 @@ func main() {
 	}()
 
 	// begin replace
-	coll := client.Database("insertDB").Collection("haikus")
-	filter := bson.D{{"title", "Record of a Shriveled Datum"}}
-	replacement := bson.D{{"title", "Dodging Greys"}, {"text", "When there're no matches, no longer need to panic. You can use upsert"}}
+	coll := client.Database("sample_restaurants").Collection("restaurants")
+	filter := bson.D{{"name", "Madame Vo"}}
+	replacement := Restaurant{Name: "Monsieur Vo", Cuisine: "Asian Fusion"}
 
 	result, err := coll.ReplaceOne(context.TODO(), filter, replacement)
 	if err != nil {

source/usage-examples/insertMany.txt

@@ -27,15 +27,15 @@ in the ``restaurants`` collection:
 The ``omitempty`` :ref:`struct tag<golang-struct-tags>` omits the corresponding 
 field from the inserted document when left empty.
 
-The following example inserts three new documents to the ``restaurants`` 
+The following example inserts two new documents to the ``restaurants`` 
 collection:
 
 .. include:: /includes/fundamentals/automatic-db-coll-creation.rst
 
 .. literalinclude:: /includes/usage-examples/code-snippets/insertMany.go
    :start-after: begin insertMany
    :end-before: end insertMany
-   :emphasize-lines: 8
+   :emphasize-lines: 7
    :language: go
    :dedent:
 
@@ -48,26 +48,10 @@ After you run the full example, you can find the following inserted
 documents in the ``restaurants`` collection:
 
 .. code-block:: json
-   :copyable: false
-
-   {
-     "_id": ObjectId("..."),
-     "name": "Rule of Thirds",
-     "cuisine": "Japanese",
-     "borough": "Brooklyn"
-   },
-   {
-     "_id": ObjectId("..."),
-     "title": "Soothr",
-     "cuisine": "Thai",
-     "borough": "Manhattan"
-   },
-   {
-     "_id": ObjectId("..."),
-     "title": "Madame Vo",
-     "cuisine": "Vietnamese",
-     "borough": "Manhattan"
-   }
+  :copyable: false
+    
+    { "_id": ObjectID("..."), "name": "Rule of Thirds", "cuisine": "Japanese"},
+    { "_id": ObjectID("..."), "name": "Madame Vo", "cuisine": "Vietnamese"}
 
 For an example on how to find multiple documents, see the 
 :ref:`golang-find-multiple` usage example.

source/usage-examples/insertOne.txt

@@ -54,8 +54,7 @@ document in the ``restaurants`` collection:
    {
      "_id": ObjectId("..."),
      "name": "8282",
-     "cuisine": "Korean",
-     "borough": "Manhattan"
+     "cuisine": "Korean"
    }
 
 For an example on how to find a document, see the :ref:`golang-find-one` usage 

source/usage-examples/replaceOne.txt

@@ -14,10 +14,23 @@ Example
 
 .. include:: /includes/usage-examples/run-example-tip.rst
 
-The following example performs the following on the ``haikus``
+This example uses the following ``Restaurant`` struct as a model for documents
+in the ``restaurants`` collection:
+
+.. literalinclude:: /includes/usage-examples/code-snippets/replace.go
+   :start-after: start-restaurant-struct
+   :end-before: end-restaurant-struct
+   :language: go 
+   :copyable: 
+   :dedent:
+
+The ``omitempty`` :ref:`struct tag<golang-struct-tags>` omits the corresponding 
+field from the inserted document when left empty.
+
+This example performs the following actions on the ``restaurants``
 collection:
 
-- Matches a document in which the ``title`` is "Record of a Shriveled Datum"
+- Matches a document in which the ``name`` is "Madame Vo"
 - Replaces the matched document with a new document
 
 .. literalinclude:: /includes/usage-examples/code-snippets/replace.go
@@ -33,18 +46,19 @@ Expected Result
 ---------------
 
 After you run the full example, you can find the following replaced
-document in the ``haikus`` collection:
+document in the ``restaurants`` collection:
 
 .. code-block:: json
    :copyable: false
 
    {
       "_id" : ObjectId("..."),
-      "title" : "Dodging Greys",
-      "text" : "When there're no matches, no longer need to panic. You can use upsert."
+      "name" : "Monsieur Vo",
+      "cuisine" : "Asian Fusion"
    }
 
-For an example on how to find a document, see :ref:`golang-find-one`.
+For an example on how to find a document, see the :ref:`golang-find-one` usage 
+example.
 
 Additional Information
 ----------------------