MongoDB Go Driver

https://pkg.go.dev/go.mongodb.org/mongo-driver
Admin
The MongoDB Go Driver is the official MongoDB supported driver for Go that enables developers to...
Tokens:1,853
Snippets:50
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install MongoDB Go Driver with Dep

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

For older Go versions not supporting modules, use 'dep' to install the driver.

```bash
dep ensure -add "go.mongodb.org/mongo-driver/v2/mongo"

```

--------------------------------

### Install MongoDB Go Driver with Go Modules

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

Use this command to add the MongoDB Go driver as a dependency to your project using Go modules.

```bash
go get go.mongodb.org/mongo-driver/v2/mongo

```

--------------------------------

### Get Database and Collection

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

Retrieve Database and Collection instances from the mongo.Client to interact with your data.

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

```

--------------------------------

### Specify Compression via Client Options

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

Enable compression by setting the 'compressors' option directly on the ClientOptions. The driver will negotiate the first common compressor with the server.

```go
opts := options.Client().SetCompressors([]string{"snappy", "zlib", "zstd"})
client, _ := mongo.Connect(opts)
```

--------------------------------

### Connect to MongoDB Client

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

Import necessary packages and create a mongo.Client instance using the Connect function. Ensure to defer the Disconnect call.

```go
import (
    "context"
    "time"

    "go.mongodb.org/mongo-driver/v2/mongo"
    "go.mongodb.org/mongo-driver/v2/mongo/options"
    "go.mongodb.org/mongo-driver/v2/mongo/readpref"
)

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

defer func() {
    if err := client.Disconnect(ctx); err != nil {
        panic(err)
    }
}()

```

--------------------------------

### Specify Compression via Connection String

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

Enable compression by including the 'compressors' parameter in the MongoDB connection URI. The driver will negotiate the first common compressor with the server.

```go
opts := options.Client().ApplyURI("mongodb://localhost:27017/?compressors=snappy,zlib,zstd")
client, _ := mongo.Connect(opts)
```

--------------------------------

### Query Documents with Cursor

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

Use the Find method to retrieve multiple documents. Iterate over the returned cursor to process each document. Ensure to close the cursor and check for errors.

```go
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defuncel defer cancel()

cur, err := collection.Find(ctx, bson.D{})
if err != nil {
  log.Fatal(err)
}

defuncel defer cur.Close(ctx)
for cur.Next(ctx) {
    var result bson.D
    if err := cur.Decode(&result); err != nil {
      log.Fatal(err)
    }

    // do something with result....
}

if err := cur.Err(); err != nil {
    log.Fatal(err)
}

```

--------------------------------

### Update Imports for BSON Usage

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

If using bson.D or other BSON types, ensure the bson package is included in your import statements.

```go
import (
    "context"
    "log"
    "time"

    "go.mongodb.org/mongo-driver/v2/bson"
    "go.mongodb.org/mongo-driver/v2/mongo"
    "go.mongodb.org/mongo-driver/v2/mongo/options"
    "go.mongodb.org/mongo-driver/v2/mongo/readpref"
)

```

--------------------------------

### Ping MongoDB Server

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

Use the Ping method to verify if a MongoDB server has been found and connected to. A context with a timeout is recommended.

```go
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defuncel defer cancel()

_ = client.Ping(ctx, readpref.Primary())

```

--------------------------------

### Query Single Document

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

Use the FindOne method to retrieve a single document. Decode the result into a struct or map. Handle the mongo.ErrNoDocuments case specifically.

```go
var result struct {
    Value float64
}

filter := bson.D{{"name", "pi"}}
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defuncel defer cancel()

err := collection.FindOne(ctx, filter).Decode(&result)
if errors.Is(err, mongo.ErrNoDocuments) {
    // Do something when no record was found
} else if err != nil {
    log.Fatal(err)
}

// Do something with result...

```

--------------------------------

### Insert Document into Collection

Source: https://pkg.go.dev/go.mongodb.org/mongo-driver/v2

Use the InsertOne method on a Collection instance to insert a single document. The InsertedID is returned upon success. Ensure 'go.mongodb.org/mongo-driver/v2/bson' is imported for bson.D.

```go
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defuncel defer cancel()

res, _ := collection.InsertOne(ctx, bson.D{{"name", "pi"}, {"value", 3.14159}})
id := res.InsertedID

```
Tokens:
Raw