Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mongodb-labs/mongo-rust-driver-prototype

This is superseded by the official MongoDB Rust Driver
https://github.com/mongodb-labs/mongo-rust-driver-prototype

mongodb-driver rust

Last synced: 7 days ago
JSON representation

This is superseded by the official MongoDB Rust Driver

Awesome Lists containing this project

README 

        
# This Repository is NOT a supported MongoDB product



[![Travis](https://travis-ci.org/mongodb-labs/mongo-rust-driver-prototype.svg)](https://travis-ci.org/mongodb-labs/mongo-rust-driver-prototype) [![Crates.io](https://img.shields.io/crates/v/mongodb.svg)](https://crates.io/crates/mongodb) [![docs.rs](https://docs.rs/mongodb/badge.svg)](https://docs.rs/mongodb) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)



MongoDB Rust Driver Prototype

=============================



**NOTE**: This driver is superseded by the [official MongoDB Rust driver](https://github.com/mongodb/mongo-rust-driver), and will no longer be updated.



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



-	[Rust 1.7+ with Cargo](http://rust-lang.org)



#### 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`:



```toml

[dependencies]

mongodb = "0.3.11"

```



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:



```toml

[dependencies]

# ...

mongodb = { version = "0.3.11", features = ["ssl"] }

```



Then, import the bson and driver libraries within your code.



```rust

#[macro_use(bson, doc)]

extern crate mongodb;

```



or with Rust 2018:



```rust

extern crate mongodb;

use mongodb::{bson, doc};

```



Examples

--------



Here's a basic example of driver usage:



```rust

use mongodb::{Bson, bson, doc};

use mongodb::{Client, ThreadedClient};

use mongodb::db::ThreadedDatabase;



fn main() {

    let client = Client::connect("localhost", 27017)

        .expect("Failed to initialize standalone client.");



    let coll = client.db("test").collection("movies");



    let doc = doc! {

        "title": "Jaws",

        "array": [ 1, 2, 3 ],

    };



    // Insert document into 'test.movies' collection

    coll.insert_one(doc.clone(), None)

        .ok().expect("Failed to insert document.");



    // Find the document and receive a cursor

    let mut cursor = coll.find(Some(doc.clone()), None)

        .ok().expect("Failed to execute find.");



    let item = cursor.next();



    // cursor.next() returns an Option>

    match item {

        Some(Ok(doc)) => match doc.get("title") {

            Some(&Bson::String(ref title)) => println!("{}", title),

            _ => panic!("Expected title to be a string!"),

        },

        Some(Err(_)) => panic!("Failed to get next from server!"),

        None => panic!("Server returned no results!"),

    }

}

```



To connect with SSL, use either `ClientOptions::with_ssl` or `ClientOptions::with_unauthenticated_ssl` and then `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):



```rust

use mongodb::{Bson, bson, doc};

use mongodb::{Client, ClientOptions, ThreadedClient};

use mongodb::db::ThreadedDatabase;



fn main() {

    // Path to file containing trusted server certificates.

    let ca_file = "path/to/ca.crt";

    // Path to file containing client certificate.

    let certificate = "path/to/client.crt";

    // Path to file containing the client private key.

    let key_file = "path/to/client.key";

    // Whether or not to verify that the server certificate is valid. Unless you're just testing out something locally, this should ALWAYS be true.

    let verify_peer = true;



    let options = ClientOptions::with_ssl(ca_file, certificate, key_file, verify_peer);



    let client = Client::connect_with_options("localhost", 27017, options)

        .expect("Failed to initialize standalone client.");



    let coll = client.db("test").collection("movies");



    let doc = doc! {

        "title": "Jaws",

        "array": [ 1, 2, 3 ],

    };



    // Insert document into 'test.movies' collection

    coll.insert_one(doc.clone(), None)

        .ok().expect("Failed to insert document.");



    ...

}

```



Testing

-------



The driver test suite is largely composed of integration tests and behavioral unit-tests, relying on the official [MongoDB specifications repo](https://github.com/mongodb/specifications). 



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](https://www.mongodb.com/download-center). You can see a full list of versions being tested on Travis in [the travis config](/.travis.yml).



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

```