Skip to content
The Go driver for MongoDB
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.evergreen GODRIVER-836 Fix zLib compression Mar 7, 2019
benchmark Update import path to Feb 22, 2019
bson GODRIVER-856 make chunks collection index _id_1_n_1 unique Mar 7, 2019
cmd Fix bug with docbuilder Feb 22, 2019
data resync transaction spec tests for bulk write error reporting change a… Mar 8, 2019
etc Improve documentation and make commands for tests Mar 12, 2019
event Update import path to Feb 22, 2019
examples/documentation_examples Update import path to Feb 22, 2019
internal Update import path to Feb 22, 2019
mongo GODRIVER-887 Properly set default registry when using UploadOptions Mar 19, 2019
tag Update import path to Feb 22, 2019
vendor Enable dep support Dec 4, 2018
version Update version to v1.0.0 Mar 13, 2019
x GODRIVER-881: Fix bsoncore.Value.String() ObjectID case Mar 15, 2019
.errcheck-excludes Update import path to Feb 22, 2019
.gitignore GODRIVER-115: driver benchmarks and bson benchmarks Jun 15, 2018
.gitmodules GODRIVER-33 Implement Extended JSON Dec 7, 2017
.lint-whitelist Update Makefile to run examples and fix bugs in examples Feb 12, 2019 Update and Feb 12, 2018
Gopkg.lock Enable dep support Dec 4, 2018
Gopkg.toml Enable dep support Dec 4, 2018
LICENSE Create LICENSE May 26, 2017
Makefile Improve documentation and make commands for tests Mar 12, 2019 Update version to v1.0.0 Mar 13, 2019
THIRD-PARTY-NOTICES Vendor and remove from internal JSON packages Jul 1, 2018

GoDoc GoDoc

MongoDB Go Driver

The MongoDB supported driver for Go.


  • Go 1.10 or higher. We aim to support the latest supported versions of go.
  • MongoDB 2.6 and higher.


The recommended way to get started using the MongoDB Go driver is by using dep to install the dependency in your project.

dep ensure -add ""


To get started with the driver, import the mongo package, create a mongo.Client:

import ""

client, err := mongo.NewClient(options.Client().ApplyURI("mongodb://localhost:27017"))

And connect it to your running MongoDB server:

ctx, _ := context.WithTimeout(context.Background(), 10*time.Second)
err = client.Connect(ctx)

To do this in a single step, you can use the Connect function:

ctx, _ := context.WithTimeout(context.Background(), 10*time.Second)
client, err := mongo.Connect(ctx, options.Client().ApplyURI("mongodb://localhost:27017"))

Calling Connect does not block for server discovery. If you wish to know if a MongoDB server has been found and connected to, use the Ping method:

ctx, _ = context.WithTimeout(context.Background(), 2*time.Second)
err = client.Ping(ctx, readpref.Primary())

To insert a document into a collection, first retrieve a Database and then Collection instance from the Client:

collection := client.Database("testing").Collection("numbers")

The Collection instance can then be used to insert documents:

ctx, _ = context.WithTimeout(context.Background(), 5*time.Second)
res, err := collection.InsertOne(ctx, bson.M{"name": "pi", "value": 3.14159})
id := res.InsertedID

Several query methods return a cursor, which can be used like this:

ctx, _ = context.WithTimeout(context.Background(), 30*time.Second)
cur, err := collection.Find(ctx, bson.D{})
if err != nil { log.Fatal(err) }
defer cur.Close(ctx)
for cur.Next(ctx) {
   var result bson.M
   err := cur.Decode(&result)
   if err != nil { log.Fatal(err) }
   // do something with result....
if err := cur.Err(); err != nil {

For methods that return a single item, a SingleResult instance is returned:

var result struct {
    Value float64
filter := bson.M{"name": "pi"}
ctx, _ = context.WithTimeout(context.Background(), 5*time.Second)
err = collection.FindOne(ctx, filter).Decode(&result)
if err != nil {
// Do something with result...

Additional examples and documentation can be found under the examples directory and on the MongoDB Documentation website.

Bugs / Feature Reporting

New Features and bugs can be reported on jira:

Testing / Development

The driver tests can be run against several database configurations. The most simple configuration is a standalone mongod with no auth, no ssl, and no compression. To run these basic driver tests, make sure a standalone MongoDB server instance is running at localhost:27017. To run the tests, you can run make (on Windows, run nmake) with the following:

TOPOLOGY=server make

The TOPOLOGYvariable must be set to run tests. This will run coverage, run go-lint, run go-vet, and build the examples.

Testing Different Topologies

To test a replica set, set MONGODB_URI="<connection-string>" and TOPOLOGY=replica_set for the make command. For example, for a local replica set named rs1 comprised of three nodes on ports 27017, 27018, and 27019:

MONGODB_URI="mongodb://localhost:27017,localhost:27018,localhost:27018/?replicaSet=rs1" TOPOLOGY=replica_set make

To test a sharded cluster, set MONGODB_URI="<connection-string>" and TOPOLOGY=sharded_cluster variables for the make command. For example, for a sharded cluster with a single mongos on port 27017:

MONGODB_URI="mongodb://localhost:27017/" TOPOLOGY=sharder_cluster make

Testing Auth and SSL

To test authentication and SSL, first set up a MongoDB cluster with auth and SSL configured. Testing authentication requires a user with the root role on the admin database. The Go Driver repository comes with example certificates in the data/certificates directory. These certs can be used for testing. Here is an example command that would run a mongod with SSL correctly configured for tests:

mongod \
--auth \
--sslMode requireSSL \
--sslPEMKeyFile $(pwd)/data/certificates/server.pem \
--sslCAFile $(pwd)/data/certificates/ca.pem \

To run the tests with make, set MONGO_GO_DRIVER_CA_FILE to the location of the CA file used by the database, set MONGODB_URI to the connection string of the server, set AUTH=auth, and set SSL=ssl. For example:

AUTH=auth SSL=ssl MONGO_GO_DRIVER_CA_FILE=$(pwd)/data/certificates/ca.pem  MONGODB_URI="mongodb://user:password@localhost:27017/?authSource=admin" make


  • The --sslWeakCertificateValidation flag is required on the server for the test suite to work correctly.
  • The test suite requires the auth database to be set with ?authSource=admin, not /admin.

Testing Compression

The MongoDB Go Driver supports wire protocol compression using Snappy or zLib. To run tests with wire protocol compression, set MONGO_GO_DRIVER_COMPRESSOR to snappy or zlib. For example:


Ensure the --networkMessageCompressors flag on mongod or mongos includes zlib if testing zLib compression.


The MongoDB Go Driver is not feature complete, so any help is appreciated. Check out the project page for tickets that need completing. See our contribution guidelines for details.

Continuous Integration

Commits to master are run automatically on evergreen.

Thanks and Acknowledgement

@ashleymcnamara - Mongo Gopher Artwork


The MongoDB Go Driver is licensed under the Apache License.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.