yanguangshaonian
/
mongo-rust-driver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Mongo Rust driver built on top of the Mongo C driver
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
185 Commits
5 Branches
5 Tags
381 KiB
Rust 100%
 
main
snappy
mongoc_1_17_5
static
bson_11
0.2.0
0.2.1
0.2.2
0.2.3
0.2.4
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '561e5d737b'
${ noResults }
Go to file
Matrix 561e5d737b fix build fail with msvc 7 years ago
mongoc-sys use vcpkg to probe ligmongoc-1.0 under windows 7 years ago
src fix build fail with msvc 7 years ago
tests Bump bson to 0.11 and use lossy utf-8 decoding for responses 7 years ago
.gitignore Keep track of bindings semi-manually 9 years ago
.travis.yml Skip extended bulk operation test on Travis 9 years ago
CHANGELOG.md Bump to 0.12 7 years ago
Cargo.toml Bump to 0.12 7 years ago
LICENSE-APACHE Use dual Apache/MIT license 9 years ago
LICENSE-MIT Use dual Apache/MIT license 9 years ago
README.md Add note about ssl test to readme 7 years ago

README.md

Mongo Rust Driver

Build Status Crate

Mongo Rust driver built on top of the Mongo C driver. This driver is a thin wrapper around the production-ready C driver that provides a safe and ergonomic Rust interface which handles all the gnarly usage details of the C driver for you.

Bson encoding and decoding is handled by the bson crate, the bindings are based on generated bindings by bindgen.

The API should still be considered experimental, but I'm not expecting changes at the moment.

Documentation

Compatibility

The driver currently only builds on Unix, tested on Mac Os X and Linux so far. It's compatible with MongoDB 2.6 up to 3.4 and has full replica set and SSL support.

Installation

If you have any trouble installing the crate (linking openssl can be tricky) please check out the installation instructions for the C driver.

To build on Mac install OpenSSL 1.1:

brew install openssl@1.1

Export these env vars the before you make a clean build:

export LDFLAGS="-L/usr/local/opt/openssl@1.1/lib"
export CPPFLAGS="-I/usr/local/opt/openssl@1.1/include"

Logging

All internal logging by mongoc is redirected to the macros in the log crate. See the log docs to configure output in your application.

SSL test

There is a test included to connect to a replica set over SSL. To skip this test:

SKIP_SSL_CONNECTION_TESTS=true cargo test

To run this tests fill these environment variables with something appropiate to connect to a replica set:

MONGO_RUST_DRIVER_SSL_URI
MONGO_RUST_DRIVER_SSL_PEM_FILE
MONGO_RUST_DRIVER_SSL_CA_FILE

Examples

See the tests directory for examples of how to use the driver.

License

Licensed under either of

at your option.

Contribution

Contributions are very welcome, only the functionality we use has been wrapped so far. Please write a test for any behavior you add.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.