mongo-driver: go.mongodb.org/mongo-driver/mongo Index | Examples | Files | Directories

package mongo

import "go.mongodb.org/mongo-driver/mongo"

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()) {
   raw, err := cur.DecodeBytes()
   if err != nil { log.Fatal(err) }
   // do something with elem....
}
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.

Index

Examples

Package Files

batch_cursor.go bulk_write.go change_stream.go client.go collection.go cursor.go database.go doc.go errors.go index_options_builder.go index_view.go mongo.go results.go session.go single_result.go util.go

Variables

var ErrClientDisconnected = errors.New("client is disconnected")

ErrClientDisconnected is returned when a user attempts to call a method on a disconnected client

var ErrEmptySlice = errors.New("must provide at least one element in input slice")

ErrEmptySlice is returned when a user attempts to pass an empty slice as input to a function wehere the field is required.

var ErrInvalidIndexValue = errors.New("invalid index value")

ErrInvalidIndexValue indicates that the index Keys document has a value that isn't either a number or a string.

var ErrMissingResumeToken = errors.New("cannot provide resume functionality when the resume token is missing")

ErrMissingResumeToken indicates that a change stream notification from the server did not contain a resume token.

var ErrMultipleIndexDrop = errors.New("multiple indexes would be dropped")

ErrMultipleIndexDrop indicates that multiple indexes would be dropped from a call to IndexView.DropOne.

var ErrNilCursor = errors.New("cursor is nil")

ErrNilCursor indicates that the cursor for the change stream is nil.

var ErrNilDocument = errors.New("document is nil")

ErrNilDocument is returned when a user attempts to pass a nil document or filter to a function where the field is required.

var ErrNoDocuments = errors.New("mongo: no documents in result")

ErrNoDocuments is returned by Decode when an operation that returns a SingleResult doesn't return any documents.

var ErrNonStringIndexName = errors.New("index name must be a string")

ErrNonStringIndexName indicates that the index name specified in the options is not a string.

var ErrUnacknowledgedWrite = errors.New("unacknowledged write")

ErrUnacknowledgedWrite is returned from functions that have an unacknowledged write concern.

var ErrWrongClient = errors.New("session was not created by this client")

ErrWrongClient is returned when a user attempts to pass in a session created by a different client than the method call is using.

func WithSession Uses

func WithSession(ctx context.Context, sess Session, fn func(SessionContext) error) error

WithSession allows a user to start a session themselves and manage its lifetime. The only way to provide a session to a CRUD method is to invoke that CRUD method with the mongo.SessionContext within the closure. The mongo.SessionContext can be used as a regular context, so methods like context.WithDeadline and context.WithTimeout are supported.

If the context.Context already has a mongo.Session attached, that mongo.Session will be replaced with the one provided.

Errors returned from the closure are transparently returned from this function.

type BSONAppender Uses

type BSONAppender interface {
    AppendBSON([]byte, interface{}) ([]byte, error)
}

BSONAppender is an interface implemented by types that can marshal a provided type into BSON bytes and append those bytes to the provided []byte. The AppendBSON can return a non-nil error and non-nil []byte. The AppendBSON method may also write incomplete BSON to the []byte.

type BSONAppenderFunc Uses

type BSONAppenderFunc func([]byte, interface{}) ([]byte, error)

BSONAppenderFunc is an adapter function that allows any function that satisfies the AppendBSON method signature to be used where a BSONAppender is used.

func (BSONAppenderFunc) AppendBSON Uses

func (baf BSONAppenderFunc) AppendBSON(dst []byte, val interface{}) ([]byte, error)

AppendBSON implements the BSONAppender interface

type BulkWriteError Uses

type BulkWriteError struct {
    WriteError
    Request WriteModel
}

BulkWriteError is an error for one operation in a bulk write.

func (BulkWriteError) Error Uses

func (bwe BulkWriteError) Error() string

type BulkWriteException Uses

type BulkWriteException struct {
    WriteConcernError *WriteConcernError
    WriteErrors       []BulkWriteError
}

BulkWriteException is an error for a bulk write operation.

func (BulkWriteException) Error Uses

func (bwe BulkWriteException) Error() string

type BulkWriteResult Uses

type BulkWriteResult struct {
    InsertedCount int64
    MatchedCount  int64
    ModifiedCount int64
    DeletedCount  int64
    UpsertedCount int64
    UpsertedIDs   map[int64]interface{}
}

BulkWriteResult holds the result of a bulk write operation.

type ChangeStream Uses

type ChangeStream struct {
    // Current is the BSON bytes of the current change document. This property is only valid until
    // the next call to Next or Close. If continued access is required to the bson.Raw, you must
    // make a copy of it.
    Current bson.Raw
    // contains filtered or unexported fields
}

ChangeStream instances iterate a stream of change documents. Each document can be decoded via the Decode method. Resume tokens should be retrieved via the ResumeToken method and can be stored to resume the change stream at a specific point in time.

A typical usage of the ChangeStream type would be:

func (*ChangeStream) Close Uses

func (cs *ChangeStream) Close(ctx context.Context) error

Close closes this cursor.

func (*ChangeStream) Decode Uses

func (cs *ChangeStream) Decode(out interface{}) error

Decode will decode the current document into val.

func (*ChangeStream) Err Uses

func (cs *ChangeStream) Err() error

Err returns the current error.

func (*ChangeStream) ID Uses

func (cs *ChangeStream) ID() int64

ID returns the cursor ID for this change stream.

func (*ChangeStream) Next Uses

func (cs *ChangeStream) Next(ctx context.Context) bool

Next gets the next result from this change stream. Returns true if there were no errors and the next result is available for decoding.

type Client Uses

type Client struct {
    // contains filtered or unexported fields
}

Client performs operations on a given topology.

func Connect Uses

func Connect(ctx context.Context, opts ...*options.ClientOptions) (*Client, error)

Connect creates a new Client and then initializes it using the Connect method.

func NewClient Uses

func NewClient(opts ...*options.ClientOptions) (*Client, error)

NewClient creates a new client to connect to a cluster specified by the uri.

When creating an options.ClientOptions, the order the methods are called matters. Later Set* methods will overwrite the values from previous Set* method invocations. This includes the ApplyURI method. This allows callers to determine the order of precedence for option application. For instance, if ApplyURI is called before SetAuth, the Credential from SetAuth will overwrite the values from the connection string. If ApplyURI is called after SetAuth, then its values will overwrite those from SetAuth.

The opts parameter is processed using options.MergeClientOptions, which will overwrite entire option fields of previous options, there is no partial overwriting. For example, if Username is set in the Auth field for the first option, and Password is set for the second but with no Username, after the merge the Username field will be empty.

func (*Client) Connect Uses

func (c *Client) Connect(ctx context.Context) error

Connect initializes the Client by starting background monitoring goroutines. This method must be called before a Client can be used.

Code:

client, err := NewClient(options.Client().ApplyURI("mongodb://foo:bar@localhost:27017"))
if err != nil {
    return
}
ctx, cancel := context.WithTimeout(context.Background(), 20*time.Second)
defer cancel()
err = client.Connect(ctx)
if err != nil {
    return
}

return

func (*Client) Database Uses

func (c *Client) Database(name string, opts ...*options.DatabaseOptions) *Database

Database returns a handle for a given database.

func (*Client) Disconnect Uses

func (c *Client) Disconnect(ctx context.Context) error

Disconnect closes sockets to the topology referenced by this Client. It will shut down any monitoring goroutines, close the idle connection pool, and will wait until all the in use connections have been returned to the connection pool and closed before returning. If the context expires via cancellation, deadline, or timeout before the in use connections have returned, the in use connections will be closed, resulting in the failure of any in flight read or write operations. If this method returns with no errors, all connections associated with this Client have been closed.

func (*Client) ListDatabaseNames Uses

func (c *Client) ListDatabaseNames(ctx context.Context, filter interface{}, opts ...*options.ListDatabasesOptions) ([]string, error)

ListDatabaseNames returns a slice containing the names of all of the databases on the server.

func (*Client) ListDatabases Uses

func (c *Client) ListDatabases(ctx context.Context, filter interface{}, opts ...*options.ListDatabasesOptions) (ListDatabasesResult, error)

ListDatabases returns a ListDatabasesResult.

func (*Client) Ping Uses

func (c *Client) Ping(ctx context.Context, rp *readpref.ReadPref) error

Ping verifies that the client can connect to the topology. If readPreference is nil then will use the client's default read preference.

func (*Client) StartSession Uses

func (c *Client) StartSession(opts ...*options.SessionOptions) (Session, error)

StartSession starts a new session.

func (*Client) UseSession Uses

func (c *Client) UseSession(ctx context.Context, fn func(SessionContext) error) error

UseSession creates a default session, that is only valid for the lifetime of the closure. No cleanup outside of closing the session is done upon exiting the closure. This means that an outstanding transaction will be aborted, even if the closure returns an error.

If ctx already contains a mongo.Session, that mongo.Session will be replaced with the newly created mongo.Session.

Errors returned from the closure are transparently returned from this method.

func (*Client) UseSessionWithOptions Uses

func (c *Client) UseSessionWithOptions(ctx context.Context, opts *options.SessionOptions, fn func(SessionContext) error) error

UseSessionWithOptions works like UseSession but allows the caller to specify the options used to create the session.

func (*Client) Watch Uses

func (c *Client) Watch(ctx context.Context, pipeline interface{},
    opts ...*options.ChangeStreamOptions) (*ChangeStream, error)

Watch returns a change stream cursor used to receive information of changes to the client. This method is preferred to running a raw aggregation with a $changeStream stage because it supports resumability in the case of some errors. The client must have read concern majority or no read concern for a change stream to be created successfully.

type Collection Uses

type Collection struct {
    // contains filtered or unexported fields
}

Collection performs operations on a given collection.

func (*Collection) Aggregate Uses

func (coll *Collection) Aggregate(ctx context.Context, pipeline interface{},
    opts ...*options.AggregateOptions) (*Cursor, error)

Aggregate runs an aggregation framework pipeline.

See https://docs.mongodb.com/manual/aggregation/.

func (*Collection) BulkWrite Uses

func (coll *Collection) BulkWrite(ctx context.Context, models []WriteModel,
    opts ...*options.BulkWriteOptions) (*BulkWriteResult, error)

BulkWrite performs a bulk write operation.

See https://docs.mongodb.com/manual/core/bulk-write-operations/.

func (*Collection) Clone Uses

func (coll *Collection) Clone(opts ...*options.CollectionOptions) (*Collection, error)

Clone creates a copy of this collection with updated options, if any are given.

func (*Collection) CountDocuments Uses

func (coll *Collection) CountDocuments(ctx context.Context, filter interface{},
    opts ...*options.CountOptions) (int64, error)

CountDocuments gets the number of documents matching the filter.

func (*Collection) Database Uses

func (coll *Collection) Database() *Database

Database provides access to the database that contains the collection.

func (*Collection) DeleteMany Uses

func (coll *Collection) DeleteMany(ctx context.Context, filter interface{},
    opts ...*options.DeleteOptions) (*DeleteResult, error)

DeleteMany deletes multiple documents from the collection.

func (*Collection) DeleteOne Uses

func (coll *Collection) DeleteOne(ctx context.Context, filter interface{},
    opts ...*options.DeleteOptions) (*DeleteResult, error)

DeleteOne deletes a single document from the collection.

func (*Collection) Distinct Uses

func (coll *Collection) Distinct(ctx context.Context, fieldName string, filter interface{},
    opts ...*options.DistinctOptions) ([]interface{}, error)

Distinct finds the distinct values for a specified field across a single collection.

func (*Collection) Drop Uses

func (coll *Collection) Drop(ctx context.Context) error

Drop drops this collection from database.

func (*Collection) EstimatedDocumentCount Uses

func (coll *Collection) EstimatedDocumentCount(ctx context.Context,
    opts ...*options.EstimatedDocumentCountOptions) (int64, error)

EstimatedDocumentCount gets an estimate of the count of documents in a collection using collection metadata.

func (*Collection) Find Uses

func (coll *Collection) Find(ctx context.Context, filter interface{},
    opts ...*options.FindOptions) (*Cursor, error)

Find finds the documents matching a model.

func (*Collection) FindOne Uses

func (coll *Collection) FindOne(ctx context.Context, filter interface{},
    opts ...*options.FindOneOptions) *SingleResult

FindOne returns up to one document that matches the model.

func (*Collection) FindOneAndDelete Uses

func (coll *Collection) FindOneAndDelete(ctx context.Context, filter interface{},
    opts ...*options.FindOneAndDeleteOptions) *SingleResult

FindOneAndDelete find a single document and deletes it, returning the original in result.

func (*Collection) FindOneAndReplace Uses

func (coll *Collection) FindOneAndReplace(ctx context.Context, filter interface{},
    replacement interface{}, opts ...*options.FindOneAndReplaceOptions) *SingleResult

FindOneAndReplace finds a single document and replaces it, returning either the original or the replaced document.

func (*Collection) FindOneAndUpdate Uses

func (coll *Collection) FindOneAndUpdate(ctx context.Context, filter interface{},
    update interface{}, opts ...*options.FindOneAndUpdateOptions) *SingleResult

FindOneAndUpdate finds a single document and updates it, returning either the original or the updated.

func (*Collection) Indexes Uses

func (coll *Collection) Indexes() IndexView

Indexes returns the index view for this collection.

func (*Collection) InsertMany Uses

func (coll *Collection) InsertMany(ctx context.Context, documents []interface{},
    opts ...*options.InsertManyOptions) (*InsertManyResult, error)

InsertMany inserts the provided documents.

func (*Collection) InsertOne Uses

func (coll *Collection) InsertOne(ctx context.Context, document interface{},
    opts ...*options.InsertOneOptions) (*InsertOneResult, error)

InsertOne inserts a single document into the collection.

func (*Collection) Name Uses

func (coll *Collection) Name() string

Name provides access to the name of the collection.

func (*Collection) ReplaceOne Uses

func (coll *Collection) ReplaceOne(ctx context.Context, filter interface{},
    replacement interface{}, opts ...*options.ReplaceOptions) (*UpdateResult, error)

ReplaceOne replaces a single document in the collection.

func (*Collection) UpdateMany Uses

func (coll *Collection) UpdateMany(ctx context.Context, filter interface{}, update interface{},
    opts ...*options.UpdateOptions) (*UpdateResult, error)

UpdateMany updates multiple documents in the collection.

func (*Collection) UpdateOne Uses

func (coll *Collection) UpdateOne(ctx context.Context, filter interface{}, update interface{},
    opts ...*options.UpdateOptions) (*UpdateResult, error)

UpdateOne updates a single document in the collection.

func (*Collection) Watch Uses

func (coll *Collection) Watch(ctx context.Context, pipeline interface{},
    opts ...*options.ChangeStreamOptions) (*ChangeStream, error)

Watch returns a change stream cursor used to receive notifications of changes to the collection.

This method is preferred to running a raw aggregation with a $changeStream stage because it supports resumability in the case of some errors. The collection must have read concern majority or no read concern for a change stream to be created successfully.

type CommandError Uses

type CommandError struct {
    Code    int32
    Message string
    Labels  []string
    Name    string
}

CommandError represents an error in execution of a command against the database.

func (CommandError) Error Uses

func (e CommandError) Error() string

Error implements the error interface.

func (CommandError) HasErrorLabel Uses

func (e CommandError) HasErrorLabel(label string) bool

HasErrorLabel returns true if the error contains the specified label.

type Cursor Uses

type Cursor struct {
    // Current is the BSON bytes of the current document. This property is only valid until the next
    // call to Next or Close. If continued access is required to the bson.Raw, you must make a copy
    // of it.
    Current bson.Raw
    // contains filtered or unexported fields
}

Cursor is used to iterate a stream of documents. Each document is decoded into the result according to the rules of the bson package.

A typical usage of the Cursor type would be:

var cur *Cursor
ctx := context.Background()
defer cur.Close(ctx)

for cur.Next(ctx) {
	elem := &bson.D{}
	if err := cur.Decode(elem); err != nil {
		log.Fatal(err)
	}

	// do something with elem....
}

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

func (*Cursor) Close Uses

func (c *Cursor) Close(ctx context.Context) error

Close closes this cursor.

func (*Cursor) Decode Uses

func (c *Cursor) Decode(val interface{}) error

Decode will decode the current document into val.

func (*Cursor) Err Uses

func (c *Cursor) Err() error

Err returns the current error.

func (*Cursor) ID Uses

func (c *Cursor) ID() int64

ID returns the ID of this cursor.

func (*Cursor) Next Uses

func (c *Cursor) Next(ctx context.Context) bool

Next gets the next result from this cursor. Returns true if there were no errors and the next result is available for decoding.

type Database Uses

type Database struct {
    // contains filtered or unexported fields
}

Database performs operations on a given database.

func (*Database) Client Uses

func (db *Database) Client() *Client

Client returns the Client the database was created from.

func (*Database) Collection Uses

func (db *Database) Collection(name string, opts ...*options.CollectionOptions) *Collection

Collection gets a handle for a given collection in the database.

func (*Database) Drop Uses

func (db *Database) Drop(ctx context.Context) error

Drop drops this database from mongodb.

func (*Database) ListCollections Uses

func (db *Database) ListCollections(ctx context.Context, filter interface{}, opts ...*options.ListCollectionsOptions) (*Cursor, error)

ListCollections list collections from mongodb database.

func (*Database) Name Uses

func (db *Database) Name() string

Name returns the name of the database.

func (*Database) ReadConcern Uses

func (db *Database) ReadConcern() *readconcern.ReadConcern

ReadConcern returns the read concern of this database.

func (*Database) ReadPreference Uses

func (db *Database) ReadPreference() *readpref.ReadPref

ReadPreference returns the read preference of this database.

func (*Database) RunCommand Uses

func (db *Database) RunCommand(ctx context.Context, runCommand interface{}, opts ...*options.RunCmdOptions) *SingleResult

RunCommand runs a command on the database. A user can supply a custom context to this method, or nil to default to context.Background().

Individual commands can be sent to the server and response retrieved via run command.

Code:

var db *Database
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
err := db.RunCommand(ctx, bson.D{{"ping", 1}}).Err()
if err != nil {
    return
}
return

func (*Database) RunCommandCursor Uses

func (db *Database) RunCommandCursor(ctx context.Context, runCommand interface{}, opts ...*options.RunCmdOptions) (*Cursor, error)

RunCommandCursor runs a command on the database and returns a cursor over the resulting reader. A user can supply a custom context to this method, or nil to default to context.Background().

func (*Database) Watch Uses

func (db *Database) Watch(ctx context.Context, pipeline interface{},
    opts ...*options.ChangeStreamOptions) (*ChangeStream, error)

Watch returns a change stream cursor used to receive information of changes to the database. This method is preferred to running a raw aggregation with a $changeStream stage because it supports resumability in the case of some errors. The database must have read concern majority or no read concern for a change stream to be created successfully.

func (*Database) WriteConcern Uses

func (db *Database) WriteConcern() *writeconcern.WriteConcern

WriteConcern returns the write concern of this database.

type DatabaseSpecification Uses

type DatabaseSpecification struct {
    Name       string
    SizeOnDisk int64
    Empty      bool
}

DatabaseSpecification is the information for a single database returned from a ListDatabases operation.

type DeleteManyModel Uses

type DeleteManyModel struct {
    Filter    interface{}
    Collation *options.Collation
}

DeleteManyModel is the write model for deleteMany operations.

func NewDeleteManyModel Uses

func NewDeleteManyModel() *DeleteManyModel

NewDeleteManyModel creates a new DeleteManyModel.

func (*DeleteManyModel) SetCollation Uses

func (dmm *DeleteManyModel) SetCollation(collation *options.Collation) *DeleteManyModel

SetCollation sets the collation for the DeleteManyModel.

func (*DeleteManyModel) SetFilter Uses

func (dmm *DeleteManyModel) SetFilter(filter interface{}) *DeleteManyModel

SetFilter sets the filter for the DeleteManyModel.

type DeleteOneModel Uses

type DeleteOneModel struct {
    Filter    interface{}
    Collation *options.Collation
}

DeleteOneModel is the write model for delete operations.

func NewDeleteOneModel Uses

func NewDeleteOneModel() *DeleteOneModel

NewDeleteOneModel creates a new DeleteOneModel.

func (*DeleteOneModel) SetCollation Uses

func (dom *DeleteOneModel) SetCollation(collation *options.Collation) *DeleteOneModel

SetCollation sets the collation for the DeleteOneModel.

func (*DeleteOneModel) SetFilter Uses

func (dom *DeleteOneModel) SetFilter(filter interface{}) *DeleteOneModel

SetFilter sets the filter for the DeleteOneModel.

type DeleteResult Uses

type DeleteResult struct {
    // The number of documents that were deleted.
    DeletedCount int64 `bson:"n"`
}

DeleteResult is a result of an DeleteOne operation.

type Dialer Uses

type Dialer interface {
    DialContext(ctx context.Context, network, address string) (net.Conn, error)
}

Dialer is used to make network connections.

type IndexModel Uses

type IndexModel struct {
    Keys    interface{}
    Options *options.IndexOptions
}

IndexModel contains information about an index.

type IndexOptionsBuilder Uses

type IndexOptionsBuilder struct {
    // contains filtered or unexported fields
}

IndexOptionsBuilder constructs a BSON document for index options

func NewIndexOptionsBuilder Uses

func NewIndexOptionsBuilder() *IndexOptionsBuilder

NewIndexOptionsBuilder creates a new instance of IndexOptionsBuilder

func (*IndexOptionsBuilder) Background Uses

func (iob *IndexOptionsBuilder) Background(background bool) *IndexOptionsBuilder

Background sets the background option

func (*IndexOptionsBuilder) Bits Uses

func (iob *IndexOptionsBuilder) Bits(bits int32) *IndexOptionsBuilder

Bits sets the bits option

func (*IndexOptionsBuilder) BucketSize Uses

func (iob *IndexOptionsBuilder) BucketSize(bucketSize int32) *IndexOptionsBuilder

BucketSize sets the bucketSize option

func (*IndexOptionsBuilder) Build Uses

func (iob *IndexOptionsBuilder) Build() bson.D

Build returns the BSON document from the builder

func (*IndexOptionsBuilder) Collation Uses

func (iob *IndexOptionsBuilder) Collation(collation interface{}) *IndexOptionsBuilder

Collation sets the collation option

func (*IndexOptionsBuilder) DefaultLanguage Uses

func (iob *IndexOptionsBuilder) DefaultLanguage(defaultLanguage string) *IndexOptionsBuilder

DefaultLanguage sets the defaultLanguage option

func (*IndexOptionsBuilder) ExpireAfterSeconds Uses

func (iob *IndexOptionsBuilder) ExpireAfterSeconds(expireAfterSeconds int32) *IndexOptionsBuilder

ExpireAfterSeconds sets the expireAfterSeconds option

func (*IndexOptionsBuilder) LanguageOverride Uses

func (iob *IndexOptionsBuilder) LanguageOverride(languageOverride string) *IndexOptionsBuilder

LanguageOverride sets the languageOverride option

func (*IndexOptionsBuilder) Max Uses

func (iob *IndexOptionsBuilder) Max(max float64) *IndexOptionsBuilder

Max sets the max option

func (*IndexOptionsBuilder) Min Uses

func (iob *IndexOptionsBuilder) Min(min float64) *IndexOptionsBuilder

Min sets the min option

func (*IndexOptionsBuilder) Name Uses

func (iob *IndexOptionsBuilder) Name(name string) *IndexOptionsBuilder

Name sets the name option

func (*IndexOptionsBuilder) PartialFilterExpression Uses

func (iob *IndexOptionsBuilder) PartialFilterExpression(partialFilterExpression interface{}) *IndexOptionsBuilder

PartialFilterExpression sets the partialFilterExpression option

func (*IndexOptionsBuilder) Sparse Uses

func (iob *IndexOptionsBuilder) Sparse(sparse bool) *IndexOptionsBuilder

Sparse sets the sparse option

func (*IndexOptionsBuilder) SphereVersion Uses

func (iob *IndexOptionsBuilder) SphereVersion(sphereVersion int32) *IndexOptionsBuilder

SphereVersion sets the sphereVersion option

func (*IndexOptionsBuilder) StorageEngine Uses

func (iob *IndexOptionsBuilder) StorageEngine(storageEngine interface{}) *IndexOptionsBuilder

StorageEngine sets the storageEngine option

func (*IndexOptionsBuilder) TextVersion Uses

func (iob *IndexOptionsBuilder) TextVersion(textVersion int32) *IndexOptionsBuilder

TextVersion sets the textVersion option

func (*IndexOptionsBuilder) Unique Uses

func (iob *IndexOptionsBuilder) Unique(unique bool) *IndexOptionsBuilder

Unique sets the unique option

func (*IndexOptionsBuilder) Version Uses

func (iob *IndexOptionsBuilder) Version(version int32) *IndexOptionsBuilder

Version sets the version option

func (*IndexOptionsBuilder) Weights Uses

func (iob *IndexOptionsBuilder) Weights(weights interface{}) *IndexOptionsBuilder

Weights sets the weights option

type IndexView Uses

type IndexView struct {
    // contains filtered or unexported fields
}

IndexView is used to create, drop, and list indexes on a given collection.

func (IndexView) CreateMany Uses

func (iv IndexView) CreateMany(ctx context.Context, models []IndexModel, opts ...*options.CreateIndexesOptions) ([]string, error)

CreateMany creates multiple indexes in the collection specified by the models. The names of the created indexes are returned.

func (IndexView) CreateOne Uses

func (iv IndexView) CreateOne(ctx context.Context, model IndexModel, opts ...*options.CreateIndexesOptions) (string, error)

CreateOne creates a single index in the collection specified by the model.

func (IndexView) DropAll Uses

func (iv IndexView) DropAll(ctx context.Context, opts ...*options.DropIndexesOptions) (bson.Raw, error)

DropAll drops all indexes in the collection.

func (IndexView) DropOne Uses

func (iv IndexView) DropOne(ctx context.Context, name string, opts ...*options.DropIndexesOptions) (bson.Raw, error)

DropOne drops the index with the given name from the collection.

func (IndexView) List Uses

func (iv IndexView) List(ctx context.Context, opts ...*options.ListIndexesOptions) (*Cursor, error)

List returns a cursor iterating over all the indexes in the collection.

type InsertManyResult Uses

type InsertManyResult struct {
    // Maps the indexes of inserted documents to their _id fields.
    InsertedIDs []interface{}
}

InsertManyResult is a result of an InsertMany operation.

type InsertOneModel Uses

type InsertOneModel struct {
    Document interface{}
}

InsertOneModel is the write model for insert operations.

func NewInsertOneModel Uses

func NewInsertOneModel() *InsertOneModel

NewInsertOneModel creates a new InsertOneModel.

func (*InsertOneModel) SetDocument Uses

func (iom *InsertOneModel) SetDocument(doc interface{}) *InsertOneModel

SetDocument sets the BSON document for the InsertOneModel.

type InsertOneResult Uses

type InsertOneResult struct {
    // The identifier that was inserted.
    InsertedID interface{}
}

InsertOneResult is a result of an InsertOne operation.

InsertedID will be a Go type that corresponds to a BSON type.

type ListDatabasesResult Uses

type ListDatabasesResult struct {
    Databases []DatabaseSpecification
    TotalSize int64
}

ListDatabasesResult is a result of a ListDatabases operation. Each specification is a description of the datbases on the server.

type MarshalError Uses

type MarshalError struct {
    Value interface{}
    Err   error
}

MarshalError is returned when attempting to transform a value into a document results in an error.

func (MarshalError) Error Uses

func (me MarshalError) Error() string

Error implements the error interface.

type Pipeline Uses

type Pipeline []bson.D

Pipeline is a type that makes creating aggregation pipelines easier. It is a helper and is intended for serializing to BSON.

Example usage:

mongo.Pipeline{
	{{"$group", bson.D{{"_id", "$state"}, {"totalPop", bson.D{{"$sum", "$pop"}}}}}},
	{{"$match", bson.D{{"totalPop", bson.D{{"$gte", 10*1000*1000}}}}}},
}

type ReplaceOneModel Uses

type ReplaceOneModel struct {
    Collation   *options.Collation
    Upsert      *bool
    Filter      interface{}
    Replacement interface{}
}

ReplaceOneModel is the write model for replace operations.

func NewReplaceOneModel Uses

func NewReplaceOneModel() *ReplaceOneModel

NewReplaceOneModel creates a new ReplaceOneModel.

func (*ReplaceOneModel) SetCollation Uses

func (rom *ReplaceOneModel) SetCollation(collation *options.Collation) *ReplaceOneModel

SetCollation sets the collation for the ReplaceOneModel.

func (*ReplaceOneModel) SetFilter Uses

func (rom *ReplaceOneModel) SetFilter(filter interface{}) *ReplaceOneModel

SetFilter sets the filter for the ReplaceOneModel.

func (*ReplaceOneModel) SetReplacement Uses

func (rom *ReplaceOneModel) SetReplacement(rep interface{}) *ReplaceOneModel

SetReplacement sets the replacement document for the ReplaceOneModel.

func (*ReplaceOneModel) SetUpsert Uses

func (rom *ReplaceOneModel) SetUpsert(upsert bool) *ReplaceOneModel

SetUpsert specifies if a new document should be created if no document matches the query.

type Session Uses

type Session interface {
    EndSession(context.Context)
    StartTransaction(...*options.TransactionOptions) error
    AbortTransaction(context.Context) error
    CommitTransaction(context.Context) error
    ClusterTime() bson.Raw
    AdvanceClusterTime(bson.Raw) error
    OperationTime() *primitive.Timestamp
    AdvanceOperationTime(*primitive.Timestamp) error
    // contains filtered or unexported methods
}

Session is the interface that represents a sequential set of operations executed. Instances of this interface can be used to use transactions against the server and to enable causally consistent behavior for applications.

type SessionContext Uses

type SessionContext interface {
    context.Context
    Session
}

SessionContext is a hybrid interface. It combines a context.Context with a mongo.Session. This type can be used as a regular context.Context or Session type. It is not goroutine safe and should not be used in multiple goroutines concurrently.

type SingleResult Uses

type SingleResult struct {
    // contains filtered or unexported fields
}

SingleResult represents a single document returned from an operation. If the operation returned an error, the Err method of SingleResult will return that error.

func (*SingleResult) Decode Uses

func (sr *SingleResult) Decode(v interface{}) error

Decode will attempt to decode the first document into v. If there was an error from the operation that created this SingleResult then the error will be returned. If there were no returned documents, ErrNoDocuments is returned.

func (*SingleResult) DecodeBytes Uses

func (sr *SingleResult) DecodeBytes() (bson.Raw, error)

DecodeBytes will return a copy of the document as a bson.Raw. If there was an error from the operation that created this SingleResult then the error will be returned. If there were no returned documents, ErrNoDocuments is returned.

func (*SingleResult) Err Uses

func (sr *SingleResult) Err() error

Err will return the error from the operation that created this SingleResult. If there was no error, nil is returned.

type StreamType Uses

type StreamType uint8

StreamType represents the type of a change stream.

const (
    CollectionStream StreamType = iota
    DatabaseStream
    ClientStream
)

These constants represent valid change stream types. A change stream can be initialized over a collection, all collections in a database, or over a whole client.

type UpdateManyModel Uses

type UpdateManyModel struct {
    Collation    *options.Collation
    Upsert       *bool
    Filter       interface{}
    Update       interface{}
    ArrayFilters *options.ArrayFilters
}

UpdateManyModel is the write model for updateMany operations.

func NewUpdateManyModel Uses

func NewUpdateManyModel() *UpdateManyModel

NewUpdateManyModel creates a new UpdateManyModel.

func (*UpdateManyModel) SetArrayFilters Uses

func (umm *UpdateManyModel) SetArrayFilters(filters options.ArrayFilters) *UpdateManyModel

SetArrayFilters specifies a set of filters specifying to which array elements an update should apply.

func (*UpdateManyModel) SetCollation Uses

func (umm *UpdateManyModel) SetCollation(collation *options.Collation) *UpdateManyModel

SetCollation sets the collation for the UpdateManyModel.

func (*UpdateManyModel) SetFilter Uses

func (umm *UpdateManyModel) SetFilter(filter interface{}) *UpdateManyModel

SetFilter sets the filter for the UpdateManyModel.

func (*UpdateManyModel) SetUpdate Uses

func (umm *UpdateManyModel) SetUpdate(update interface{}) *UpdateManyModel

SetUpdate sets the update document for the UpdateManyModel.

func (*UpdateManyModel) SetUpsert Uses

func (umm *UpdateManyModel) SetUpsert(upsert bool) *UpdateManyModel

SetUpsert specifies if a new document should be created if no document matches the query.

type UpdateOneModel Uses

type UpdateOneModel struct {
    Collation    *options.Collation
    Upsert       *bool
    Filter       interface{}
    Update       interface{}
    ArrayFilters *options.ArrayFilters
}

UpdateOneModel is the write model for update operations.

func NewUpdateOneModel Uses

func NewUpdateOneModel() *UpdateOneModel

NewUpdateOneModel creates a new UpdateOneModel.

func (*UpdateOneModel) SetArrayFilters Uses

func (uom *UpdateOneModel) SetArrayFilters(filters options.ArrayFilters) *UpdateOneModel

SetArrayFilters specifies a set of filters specifying to which array elements an update should apply.

func (*UpdateOneModel) SetCollation Uses

func (uom *UpdateOneModel) SetCollation(collation *options.Collation) *UpdateOneModel

SetCollation sets the collation for the UpdateOneModel.

func (*UpdateOneModel) SetFilter Uses

func (uom *UpdateOneModel) SetFilter(filter interface{}) *UpdateOneModel

SetFilter sets the filter for the UpdateOneModel.

func (*UpdateOneModel) SetUpdate Uses

func (uom *UpdateOneModel) SetUpdate(update interface{}) *UpdateOneModel

SetUpdate sets the update document for the UpdateOneModel.

func (*UpdateOneModel) SetUpsert Uses

func (uom *UpdateOneModel) SetUpsert(upsert bool) *UpdateOneModel

SetUpsert specifies if a new document should be created if no document matches the query.

type UpdateResult Uses

type UpdateResult struct {
    // The number of documents that matched the filter.
    MatchedCount int64
    // The number of documents that were modified.
    ModifiedCount int64
    // The number of documents that were upserted.
    UpsertedCount int64
    // The identifier of the inserted document if an upsert took place.
    UpsertedID interface{}
}

UpdateResult is a result of an update operation.

UpsertedID will be a Go type that corresponds to a BSON type.

func (*UpdateResult) UnmarshalBSON Uses

func (result *UpdateResult) UnmarshalBSON(b []byte) error

UnmarshalBSON implements the bson.Unmarshaler interface.

type WriteConcernError Uses

type WriteConcernError struct {
    Code    int
    Message string
    Details bson.Raw
}

WriteConcernError is a write concern failure that occurred as a result of a write operation.

func (WriteConcernError) Error Uses

func (wce WriteConcernError) Error() string

type WriteError Uses

type WriteError struct {
    Index   int
    Code    int
    Message string
}

WriteError is a non-write concern failure that occurred as a result of a write operation.

func (WriteError) Error Uses

func (we WriteError) Error() string

type WriteErrors Uses

type WriteErrors []WriteError

WriteErrors is a group of non-write concern failures that occurred as a result of a write operation.

func (WriteErrors) Error Uses

func (we WriteErrors) Error() string

type WriteException Uses

type WriteException struct {
    WriteConcernError *WriteConcernError
    WriteErrors       WriteErrors
}

WriteException is an error for a non-bulk write operation.

func (WriteException) Error Uses

func (mwe WriteException) Error() string

type WriteModel Uses

type WriteModel interface {
    // contains filtered or unexported methods
}

WriteModel is the interface satisfied by all models for bulk writes.

Directories

PathSynopsis
gridfs
options
readconcern
readpref
writeconcern

Package mongo imports 30 packages (graph) and is imported by 21 packages. Updated 2019-03-23. Refresh now. Tools for package owners.