README
¶
mongo-go-driver
MongoDB Driver for Go.
- Requirements
- Installation
- Bugs/Feature Reporting
- Testing / Development
- Continuous Integration
- License
Requirements
- Go 1.9 or higher. We aim to support the latest supported versions go.
- MongoDB 3.2 and higher.
Installation
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 github.com/mongodb/mongo-go-driver/mongo
Bugs / Feature Reporting
New Features and bugs can be reported on jira: https://jira.mongodb.org/browse/GODRIVER
Testing / Development
To run driver tests, make sure a MongoDB server instance is running at localhost:27017. Using make, you can run make (on windows, run nmake).
This will run coverage, run go-lint, run go-vet, and build the examples.
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.
License
The MongoDB Go Driver is licensed under the Apache License.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bson is a library for reading, writing, and manipulating BSON.
|
Package bson is a library for reading, writing, and manipulating BSON. |
|
elements
Package elements holds the logic to encode and decode the BSON element types from native Go to BSON binary and vice versa.
|
Package elements holds the logic to encode and decode the BSON element types from native Go to BSON binary and vice versa. |
|
internal/llbson
Package llbson contains functions that can be used to encode and decode BSON elements and values to or from a slice of bytes.
|
Package llbson contains functions that can be used to encode and decode BSON elements and values to or from a slice of bytes. |
|
cmd
|
|
|
Package core and all packages underneath it are not for public use.
|
Package core and all packages underneath it are not for public use. |
|
auth
Package auth is not for public use.
|
Package auth is not for public use. |
|
command
Package command contains abstractions for operations that can be performed against a MongoDB deployment.
|
Package command contains abstractions for operations that can be performed against a MongoDB deployment. |
|
connection
Package connection contains the types for building and pooling connections that can speak the MongoDB Wire Protocol.
|
Package connection contains the types for building and pooling connections that can speak the MongoDB Wire Protocol. |
|
integration/internal/israce
Package israce reports if the Go race detector is enabled.
|
Package israce reports if the Go race detector is enabled. |
|
result
Package result contains the results from various operations.
|
Package result contains the results from various operations. |
|
topology
Package topology contains types that handles the discovery, monitoring, and selection of servers.
|
Package topology contains types that handles the discovery, monitoring, and selection of servers. |
|
wiremessage
Package wiremessage contains types for speaking the MongoDB Wire Protocol.
|
Package wiremessage contains types for speaking the MongoDB Wire Protocol. |
|
examples
|
|
|
Package mongo provides a MongoDB Driver API for Go.
|
Package mongo provides a MongoDB Driver API for Go. |
Click to show internal directories.
Click to hide internal directories.