MongoDB Rust Driver Prototype
This branch contains active development on a new driver written for Rust 1.x and MongoDB 3.0.x.
The API and implementation are currently subject to change at any time. You should not use this driver in production as it is still under development and is in no way supported by MongoDB Inc. We absolutely encourage you to experiment with it and provide us feedback on the API, design, and implementation. Bug reports and suggestions for improvements are welcomed, as are pull requests.
Note: This driver currently only supports MongoDB 3.0.x and 3.2.x. This driver is not expected to work with MongoDB 2.6 or any earlier versions. Do not use this driver if you need support for other versions of MongoDB.
Installation
Dependencies
Importing
The driver is available on crates.io. To use the MongoDB driver in your code, add the bson and mongodb packages to your Cargo.toml
:
[dependencies]
bson = "0.3.2"
mongodb = "0.2.0"
Alternately, you can use the MongoDB driver with SSL support. To do this, you must have OpenSSL installed on your system. Then, enable the ssl
feature for MongoDB in your Cargo.toml:
[dependencies]
...
mongodb = { version = "0.2.0", features = ["ssl"] }
Then, import the bson and driver libraries within your code.
extern crate bson;
extern crate mongodb;
Examples
Here's a basic example of driver usage:
use Bson;
use ;
use ThreadedDatabase;
To connect with SSL, use ClientOptions::with_ssl
and Client::connect_with_options
. Afterwards, the client can be used as above (note that the server will have to be configured to accept SSL connections and that you'll have to generate your own keys and certificates):
use Bson;
use ;
use ThreadedDatabase;
Testing
The driver test suite is largely composed of integration tests and behavioral unit-tests, relying on the official MongoDB specifications repo.
The easiest way to thoroughly test the driver is to set your fork up with TravisCI. However, if you'd rather test the driver locally, you'll need to setup integration and specification tests.
NOTE: Each integration test uses a unique database/collection to allow tests to be parallelized, and will drop their dependencies before running. However, effects are not cleaned up afterwards.
Setting up integration tests
All integration tests run on the default MongoDB port, 27017. Before running the tests, ensure that a test database is setup to listen on that port.
If you don't have mongodb installed, download and install a version from the MongoDB Download Center. You can see a full list of versions being tested on Travis in the travis config.
After installation, run a MongoDB server on 27017:
mkdir -p ./data/test_db
mongod --dbpath ./data/test_db
Setting up the specifications submodule
Pull in the specifications submodule at tests/json/data/specs
.
git submodule update --init
Running Tests
Run tests like a regular Rust program:
cargo test --verbose