# mongo-embedded
A Rust library that simplifies using MongoDB for local testing and development by automatically downloading, extracting, and running a MongoDB Community Edition binary.
It handles:
- **OS/Arch Detection**: Automatically selects the correct binary for Linux, macOS, and Windows.
- **Downloading**: Fetches the binary from the official MongoDB download center.
- **Extraction**: Unpacks `.tgz` or `.zip` archives.
- **Execution**: Starts the `mongod` process on a specified port.
## Usage
### Installation
Run the following command in your project directory:
```bash
cargo add mongo-embedded
```
Or add the following to your `Cargo.toml`:
```toml
[dependencies]
mongo-embedded = "0.1.3"
tokio = { version = "1.0", features = ["full"] } # Required for the example below
```
### Example
```rust
use mongo_embedded::MongoEmbedded;
use tokio::time::{sleep, Duration};
#[tokio::main]
async fn main() {
let mongo = MongoEmbedded::new("7.0.2").unwrap()
.set_port(12345);
let mut process = mongo.start().await.expect("Failed to start MongoDB");
// MongoDB is running at mongodb://127.0.0.1:12345/
sleep(Duration::from_secs(5)).await;
process.kill().expect("Failed to kill MongoDB process");
}
```
### With Download Progress
```rust
use mongo_embedded::{MongoEmbedded, DownloadProgress};
#[tokio::main]
async fn main() {
let mongo = MongoEmbedded::new("7.0.2").unwrap();
let mut process = mongo.start_with_progress(|progress: DownloadProgress| {
if let Some(pct) = progress.percentage {
println!("Downloading: {:.1}%", pct);
} else {
println!("Downloaded: {} bytes", progress.downloaded);
}
}).await.expect("Failed to start MongoDB");
process.kill().expect("Failed to kill MongoDB process");
}
process.kill().expect("Failed to kill MongoDB process");
}
```
### Check if Installed
You can check if the MongoDB binary for the specified version is already downloaded and extracted:
```rust
let mongo = MongoEmbedded::new("7.0.2").unwrap();
if mongo.is_installed() {
println!("MongoDB is ready to start");
}
```
### Unix Sockets / Custom Bind IP
You can configure the bind IP address. This is useful for security (binding only to localhost) or for using Unix domain sockets (on Unix-like systems) to avoid opening a TCP port.
```rust
// Use a Unix socket
let mongo = MongoEmbedded::new("7.0.2").unwrap()
.set_bind_ip("/tmp/mongodb-27017.sock");
// Or bind to a specific IP
// let mongo = mongo.set_bind_ip("127.0.0.1");
```
## Configuration
The library uses the `directories` crate to find suitable locations for:
- **Cache**: Stores downloaded archives (e.g., `~/.cache/mongo-embedded` on Linux).
- **Data**: Stores the database files (e.g., `~/.local/share/mongo-embedded` on Linux).
## License
MIT