package
0.3.0
Repository: https://github.com/mongodb/mongo-go-driver.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

Connect creates a new Client and then initializes it using the Connect method.
NewClient creates a new client to connect to a cluster specified by the uri.
NewClientWithOptions creates a new client to connect to to a cluster specified by the connection string and the options manually passed in.
NewDeleteManyModel creates a new DeleteManyModel.
NewDeleteOneModel creates a new DeleteOneModel.
NewIndexOptionsBuilder creates a new instance of IndexOptionsBuilder.
NewInsertOneModel creates a new InsertOneModel.
NewReplaceOneModel creates a new ReplaceOneModel.
NewUpdateManyModel creates a new UpdateManyModel.
NewUpdateOneModel creates a new UpdateOneModel.
WithSession allows a user to start a session themselves and manage its lifetime.

# Constants

These constants represent valid change stream types.
These constants represent valid change stream types.
These constants represent valid change stream types.

# Variables

ErrClientDisconnected is returned when a user attempts to call a method on a disconnected client.
ErrEmptySlice is returned when a user attempts to pass an empty slice as input to a function wehere the field is required.
ErrInvalidIndexValue indicates that the index Keys document has a value that isn't either a number or a string.
ErrMissingResumeToken indicates that a change stream notification from the server did not contain a resume token.
ErrMultipleIndexDrop indicates that multiple indexes would be dropped from a call to IndexView.DropOne.
ErrNilCursor indicates that the cursor for the change stream is nil.
ErrNilDocument is returned when a user attempts to pass a nil document or filter to a function where the field is required.
ErrNoDocuments is returned by Decode when an operation that returns a SingleResult doesn't return any documents.
ErrNonStringIndexName indicates that the index name specified in the options is not a string.
ErrUnacknowledgedWrite is returned from functions that have an unacknowledged write concern.
ErrWrongClient is returned when a user attempts to pass in a session created by a different client than the method call is using.

# Structs

BulkWriteError is an error for one operation in a bulk write.
BulkWriteException is an error for a bulk write operation.
BulkWriteResult holds the result of a bulk write operation.
ChangeStream instances iterate a stream of change documents.
Client performs operations on a given topology.
Collection performs operations on a given collection.
Cursor is used to iterate a stream of documents.
Database performs operations on a given database.
DatabaseSpecification is the information for a single database returned from a ListDatabases operation.
DeleteManyModel is the write model for deleteMany operations.
DeleteOneModel is the write model for delete operations.
DeleteResult is a result of an DeleteOne operation.
IndexModel contains information about an index.
IndexOptionsBuilder constructs a BSON document for index options.
IndexView is used to create, drop, and list indexes on a given collection.
InsertManyResult is a result of an InsertMany operation.
InsertOneModel is the write model for insert operations.
InsertOneResult is a result of an InsertOne operation.
ListDatabasesResult is a result of a ListDatabases operation.
MarshalError is returned when attempting to transform a value into a document results in an error.
ReplaceOneModel is the write model for replace operations.
SingleResult represents a single document returned from an operation.
UpdateManyModel is the write model for updateMany operations.
UpdateOneModel is the write model for update operations.
UpdateResult is a result of an update operation.
WriteConcernError is a write concern failure that occurred as a result of a write operation.
WriteError is a non-write concern failure that occurred as a result of a write operation.
WriteException is an error for a non-bulk write operation.

# Interfaces

BSONAppender is an interface implemented by types that can marshal a provided type into BSON bytes and append those bytes to the provided []byte.
Dialer is used to make network connections.
Session is the interface that represents a sequential set of operations executed.
SessionContext is a hybrid interface.
WriteModel is the interface satisfied by all models for bulk writes.

# Type aliases

BSONAppenderFunc is an adapter function that allows any function that satisfies the AppendBSON method signature to be used where a BSONAppender is used.
Pipeline is a type that makes creating aggregation pipelines easier.
StreamType represents the type of a change stream.
WriteErrors is a group of non-write concern failures that occurred as a result of a write operation.