Quick Reference

This page shows the driver syntax for several MongoDB commands and links to their related reference and API documentation.

Command

Syntax

Find a Document

API Documentation
Usage Example
Fundamentals

err = coll.FindOne(context.TODO(), bson.D{{"firstName", Mike}}).Decode(&result)

[{firstName Mike}, {lastName Smith} ...]

Find Multiple Documents

API Documentation
Usage Example
Fundamentals

cursor, err := coll.Find(context.TODO(), bson.D{{"age", bson.D{{"$gte", 46}}}})

[{firstName Kyle}, {age 51}, ... ]
[{firstName Omar}, {age 47}, ... ]

Insert a Document

API Documentation
Usage Example
Fundamentals

result, err := coll.InsertOne(
    context.TODO(),
    bson.D{
        {"animal", "Dog"},
        {"breed", "Beagle"}
    }
)

Insert Multiple Documents

API Documentation
Usage Example
Fundamentals

docs := []interface{} {
    bson.D{{"firstName", "Erik"}, {"age", 27}},
    bson.D{{"firstName", "Mohammad"}, {"lastName", "Ahmad"}, {"age", 10}},
    bson.D{{"firstName", "Todd"}},
    bson.D{{"firstName", "Juan"}, {"lastName", "Pablo"}}
 }
result, err := coll.InsertMany(context.TODO(), docs)

Update a Document

API Documentation
Usage Example
Fundamentals

result, err := coll.UpdateOne(
    context.TODO(),
    bson.D{{"firstName", "Erik"}},
    bson.D{{"$set", bson.D{{"age", 28}}}}
)
fmt.Printf("The number of modified documents: %d\n", result.ModifiedCount)

The number of modified documents: 1

Update Multiple Documents

API Documentation
Usage Example
Fundamentals

result, err := coll.UpdateMany(
    context.TODO(),
    bson.D{{"age", bson.D{{"$gte", 58}}}},
    bson.D{{"$set", bson.D{{"description", "Senior"}}}}
)
fmt.Printf("The number of modified documents: %d\n", result.ModifiedCount)

The number of modified documents: 4

Update Arrays in Documents

API Documentation
Fundamentals

result, err := coll.UpdateMany(
    context.TODO(),
    bson.D{},
    bson.D{{"$push", bson.D{{family, "brother"}}}}
)

[{firstName Xiao}, {family ["brother"]}, ... ]
[{firstName Omar}, {family ["brother", "mother"]}, ... ]
...

Replace a Document

API Documentation
Usage Example
Fundamentals

result, err := coll.ReplaceOne(
    context.TODO(),
    bson.D{{"firstName", "Mick"}},
    bson.D{{"firstName", "Mike"}, {"lastName", "Doe"}}
)

[{{firstName Mike}, {lastName Doe} }]

Delete a Document

API Documentation
Usage Example
Fundamentals

result, err := coll.DeleteOne(
    context.TODO(),
    bson.D{{"firstName", "Xiao"}}
)

Delete Multiple Documents

API Documentation
Usage Example
Fundamentals

results, err := coll.DeleteMany(
    context.TODO(),
    bson.D{{"age", bson.D{{"$lte", 12}}}}
)

Bulk Write

API Documentation
Usage Example
Fundamentals

models := []mongo.WriteModel{
    mongo.NewInsertOneModel().SetDocument(bson.D{{"firstName", "John"}, {"age", 5}}),
    mongo.NewUpdateOneModel().SetFilter(bson.D{{"firstName", "Juan"}}).
        SetUpdate(bson.D{{"$set", bson.D{{"age", 12}}}}),
}
opts := options.BulkWrite().SetOrdered(true)
results, err := coll.BulkWrite(context.TODO(), models, opts)

[{firstName John}, {age 5} ... ]
[{firstName Juan}, {age 12} ... ]

Monitor Data Changes

API Documentation
Usage Example

pipeline := mongo.Pipeline{bson.D{{"$match", bson.D{{"operationType", "insert"}}}}}
cs, err := coll.Watch(context.TODO(), pipeline)

Access Data from a Cursor Iteratively

API Documentation
Fundamentals

cursor, err := coll.Find(context.TODO(), bson.D{})
for cursor.Next(context.TODO()) {
    var result bson.D
    if err := cursor.Decode(&result); err != nil {
        log.Fatal(err)
    }
    fmt.Println(result)
}

[{firstName Doug} ... ]
[{firstName Erik} ...]
[{lastName Chang} ...]
...

Access Data from a Cursor as an Array

API Documentation
Fundamentals

cursor, err := coll.Find(context.TODO(), bson.D{})
var results []bson.D
if err = cursor.All(context.TODO(), &results); err != nil {
    panic(err)
}

[{name Mike} ... ]
[{name Edgar} ...]
[{name Freddie} ...]
...

Count Documents

API Documentation
Usage Example
Fundamentals

count, err := coll.CountDocuments(context.TODO(), bson.D{})

List the Distinct Documents or Field Values
API Documentation
Usage Example
Fundamentals

results, err := coll.Distinct(context.TODO(), "firstName", bson.D{})

Limit the Number of Documents Retrieved

API Documentation
Fundamentals

cursor, err := coll.Find(context.TODO(), bson.D{}, options.Find().SetLimit(2))

[{breed Beagle} ... ]
[{breed German Shepard} ...]

Skip Retrieved Documents

API Documentation
Fundamentals

// the collection has 6 documents
cursor, err := coll.Find(context.TODO(), bson.D{}, options.Find().SetSkip(4))

[{item Pen} ... ]
[{item Chair} ...]

Sort the Documents When Retrieving Them

API Documentation
Fundamentals

cursor, err := coll.Find(context.TODO(), bson.D{}, options.Find().SetSort(bson.D{{"age", 1}}))

[{firstName Dev} {age 5} ... ]
[{firstName Jose} {age 7} ... ]
[{firstName Om} {age 8} ... ]

Project Document Fields When Retrieving Them

API Documentation
Fundamentals

cursor, err := coll.Find(
    context.TODO(),
    bson.D{},
    options.Find().SetProjection(
        bson.D{{"age", 0}, {"_id",0}}
    )
)

[{firstName Lester}]
[{firstName Wendall} {lastName Griffin}]
...

Create an Index

API Documentation
Fundamentals

model := mongo.IndexModel{Keys: bson.D{{"firstName", 1}, {"lastName", -1}}}
name, err := coll.Indexes().CreateOne(context.TODO(), model)

Search Text

API Documentation
Fundamentals

// only searches fields with text indexes
cursor, err := coll.Find(context.TODO(), bson.D{{"$text", bson.D{{"$search", "beagle"}}}})

[{"firstName": "Emily" , "Description": "I love to play sports and walk my beagle."} ... ]

Back

Quick Start

What's New