MongoDB Go Driver¶

Introduction¶

This is the official MongoDB Go Driver.

• Quick Start Tutorials
• Migration from Community Drivers
• API Reference
• Changelog
• Source Code

Installation¶

The recommended way to get started using the MongoDB Go driver is by using Go modules

mkdir goproj
cd goproj
go mod init goproj
go get go.mongodb.org/mongo-driver/mongo

See Installation for additional ways to add the driver to your project.

Connect to MongoDB Atlas¶

To connect to a MongoDB Atlas cluster, use the Atlas connection string for your cluster:

package main
import (
	"context"
	"fmt"
	"log"
	"time"
	"go.mongodb.org/mongo-driver/mongo"
	"go.mongodb.org/mongo-driver/mongo/options"
	"go.mongodb.org/mongo-driver/mongo/readpref"
)
func main() {
	// Replace the uri string with your MongoDB deployment's connection string.
	uri := "mongodb+srv://<username>:<password>@<cluster-address>/test?w=majority"
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
	defer cancel()
	client, err := mongo.Connect(ctx, options.Client().ApplyURI(uri))
	if err != nil {
		panic(err)
	}
	defer func() {
		if err = client.Disconnect(ctx); err != nil {
			panic(err)
		}
	}()
	// Ping the primary
	if err := client.Ping(ctx, readpref.Primary()); err != nil {
		panic(err)
	}
	fmt.Println("Successfully connected and pinged.")
}

See Usage for more detail.

Versioned API¶

You can use the Versioned API feature starting with MongoDB Server version 5.0 and Go Driver version 1.6. When you use the Versioned API feature, you can update your driver or server without worrying about backward compatibility issues with any commands covered by the Versioned API. To use this feature, construct a MongoDB client instance, specifying a version of the Versioned API:

// Replace <connection string> with your MongoDB deployment's connection string.
uri := "<connection string>"
ctx := context.TODO()
// Set the version of the Versioned API on the client.
serverAPIOptions := options.ServerAPI(options.ServerAPIVersion1)
clientOptions := options.Client().ApplyURI(uri).SetServerAPIOptions(serverAPIOptions)
client, err := mongo.Connect(ctx, clientOptions)

Connect to a MongoDB Server on Your Local Machine¶

If you need to run a MongoDB server on your local machine for development purposes instead of using an Atlas cluster, you need to complete the following:

1. Download the Community or Enterprise version of MongoDB Server.
2. Install and configure MongoDB Server.
3. Start the server.

After you successfully start your MongoDB server, specify your connection string in your driver connection code.

If your MongoDB Server is running locally, you can use the connection string "mongodb://localhost:<port>" where <port> is the port number you configured your server to listen for incoming connections.

If you need to specify a different hostname or IP address, see our Server Manual entry on Connection Strings.

To test whether you can connect to your server, replace the connection string in the Connect to MongoDB Atlas code example and run it.

Compatibility¶