diff options
Diffstat (limited to 'src/mongo/gotools/src/github.com/mongodb/mongo-tools/vendor/go.mongodb.org/mongo-driver/mongo/doc.go')
| -rw-r--r-- | src/mongo/gotools/src/github.com/mongodb/mongo-tools/vendor/go.mongodb.org/mongo-driver/mongo/doc.go | 81 |
1 files changed, 0 insertions, 81 deletions
diff --git a/src/mongo/gotools/src/github.com/mongodb/mongo-tools/vendor/go.mongodb.org/mongo-driver/mongo/doc.go b/src/mongo/gotools/src/github.com/mongodb/mongo-tools/vendor/go.mongodb.org/mongo-driver/mongo/doc.go deleted file mode 100644 index 284e9616e08..00000000000 --- a/src/mongo/gotools/src/github.com/mongodb/mongo-tools/vendor/go.mongodb.org/mongo-driver/mongo/doc.go +++ /dev/null @@ -1,81 +0,0 @@ -// Copyright (C) MongoDB, Inc. 2017-present. -// -// Licensed under the Apache License, Version 2.0 (the "License"); you may -// not use this file except in compliance with the License. You may obtain -// a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 - -// NOTE: This documentation should be kept in line with the Example* test functions. - -// Package mongo provides a MongoDB Driver API for Go. -// -// Basic usage of the driver starts with creating a Client from a connection -// string. To do so, call the NewClient and Connect functions: -// -// client, err := NewClient(options.Client().ApplyURI("mongodb://foo:bar@localhost:27017")) -// if err != nil { return err } -// ctx, cancel := context.WithTimeout(context.Background(), 20*time.Second) -// defer cancel() -// err = client.Connect(ctx) -// if err != nil { return err } -// -// This will create a new client and start monitoring the MongoDB server on localhost. -// The Database and Collection types can be used to access the database: -// -// collection := client.Database("baz").Collection("qux") -// -// A Collection can be used to query the database or insert documents: -// -// res, err := collection.InsertOne(context.Background(), bson.M{"hello": "world"}) -// if err != nil { return err } -// id := res.InsertedID -// -// Several methods return a cursor, which can be used like this: -// -// cur, err := collection.Find(context.Background(), bson.D{}) -// if err != nil { log.Fatal(err) } -// defer cur.Close(context.Background()) -// for cur.Next(context.Background()) { -// // To decode into a struct, use cursor.Decode() -// result := struct{ -// Foo string -// Bar int32 -// }{} -// err := cur.Decode(&result) -// if err != nil { log.Fatal(err) } -// // do something with result... -// -// // To get the raw bson bytes use cursor.Current -// raw := cur.Current -// // do something with raw... -// } -// if err := cur.Err(); err != nil { -// return err -// } -// -// Methods that only return a single document will return a *SingleResult, which works -// like a *sql.Row: -// -// result := struct{ -// Foo string -// Bar int32 -// }{} -// filter := bson.D{{"hello", "world"}} -// err := collection.FindOne(context.Background(), filter).Decode(&result) -// if err != nil { return err } -// // do something with result... -// -// All Client, Collection, and Database methods that take parameters of type interface{} -// will return ErrNilDocument if nil is passed in for an interface{}. -// -// Additional examples can be found under the examples directory in the driver's repository and -// on the MongoDB website. -// -// Potential DNS Issues -// -// Building with Go 1.11+ and using connection strings with the "mongodb+srv"[1] scheme is -// incompatible with some DNS servers in the wild due to the change introduced in -// https://github.com/golang/go/issues/10622. If you receive an error with the message "cannot -// unmarshal DNS message" while running an operation, we suggest you use a different DNS server. -// -// [1] See https://docs.mongodb.com/manual/reference/connection-string/#dns-seedlist-connection-format -package mongo |