Merge pull request #164 from ajhuh-mdb/DOCSP-25874-struct-tagging-findone

DOCSP-25874 Add Restaurant Structs to FindOne Usage Example

Author: ajhuh-mdb

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

@@ -9,10 +9,24 @@ import (
 
 	"github.com/joho/godotenv"
 	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/bson/primitive"
 	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
 )
 
+// start-restaurant-struct
+type Restaurant struct {
+	ID           primitive.ObjectID `bson:"_id"`
+	Name         string
+	RestaurantId string `bson:"restaurant_id"`
+	Cuisine      string
+	Address      interface{}
+	Borough      string
+	Grades       []interface{}
+}
+
+// end-restaurant-struct
+
 func main() {
 	if err := godotenv.Load(); err != nil {
 		log.Println("No .env file found")
@@ -34,10 +48,12 @@ func main() {
 	}()
 
 	// begin findOne
-	coll := client.Database("sample_mflix").Collection("movies")
-	
-	var result bson.M
-	err = coll.FindOne(context.TODO(), bson.D{{"title", "The Room"}}).Decode(&result)
+	coll := client.Database("sample_restaurants").Collection("restaurants")
+	filter := bson.D{{"name", "Bagels N Buns"}}
+
+	var result Restaurant
+	err = coll.FindOne(context.TODO(), filter).Decode(&result)
+
 	if err != nil {
 		if err == mongo.ErrNoDocuments {
 			// This error means your query did not match any documents.

source/usage-examples/findOne.txt

@@ -14,35 +14,50 @@ Example
 
 .. include:: /includes/usage-examples/run-example-tip.rst
 
-The following example matches documents in the ``movies`` collection
-in which the ``title`` is "The Room", returning the first document
+This example uses the following ``Restaurant`` struct as a model for documents
+in the ``restaurants`` collection:
+
+.. literalinclude:: /includes/usage-examples/code-snippets/findOne.go
+   :start-after: start-restaurant-struct
+   :end-before: end-restaurant-struct
+   :language: go 
+   :copyable: 
+   :dedent:
+
+The following example matches documents in the ``restaurants`` collection
+in which the ``name`` is "Bagels N Buns", returning the first document
 matched:
 
 .. literalinclude:: /includes/usage-examples/code-snippets/findOne.go
    :start-after: begin findOne
    :end-before: end findOne
    :language: go
    :dedent:
-   :emphasize-lines: 4
+   :emphasize-lines: 5
 
 View a `fully runnable example <{+example+}/findOne.go>`__
 
 Expected Result
 ---------------
 
-After you run the full example, it returns a ``SingleResult``
-object that contains the following document:
+Running the full example prints the following document, which is stored in the 
+``result`` variable as a ``Restaurant`` struct:
 
 .. code-block:: json
    :copyable: False
 
+   // results truncated
    {
-     ...
-     "title": "The Room",
-     "year": 2003,
-     ...
+      "ID": "5eb3d668b31de5d588f42950",
+      "Name": "Bagels N Buns",
+      "RestaurantId": "40363427"
+      "Address": [...],
+      "Borough": "Staten Island",
+      "Cuisine": "Delicatessen",
+      "Grades": [...]
    }
 
+
 Additional Information
 ----------------------