https://github.com/gistia/aide-de-camp-mongodb

A MongoDB backed implementation of the job Queue for aide-de-camp.
https://github.com/gistia/aide-de-camp-mongodb

database document job mongodb queue rust scheduler

Last synced: 5 months ago
JSON representation

A MongoDB backed implementation of the job Queue for aide-de-camp.

• Host: GitHub
• URL: https://github.com/gistia/aide-de-camp-mongodb
• Owner: gistia
• License: apache-2.0
• Created: 2023-07-30T18:54:37.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2025-01-28T18:49:51.000Z (over 1 year ago)
• Last Synced: 2025-01-28T19:38:23.812Z (over 1 year ago)
• Topics: database, document, job, mongodb, queue, rust, scheduler
• Language: Rust
• Homepage:
• Size: 59.6 KB
• Stars: 1
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

          
# aide-de-camp-mongodb

[![crates.io](https://img.shields.io/crates/v/aide-de-camp-mongodb.svg)](https://crates.io/crates/aide-de-camp-mongodb)

[![docs.rs](https://img.shields.io/docsrs/aide-de-camp-mongodb)](https://docs.rs/crate/aide-de-camp-mongodb)

[![CI Tests](https://github.com/gistia/aide-de-camp-mongodb/actions/workflows/ci.yml/badge.svg)](https://github.com/gistia/aide-de-camp-mongodb/actions/workflows/ci.yml)

[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A MongoDB backed implementation of the job Queue for [aide-de-camp](https://github.com/ZeroAssumptions/aide-de-camp).

## Example

```rust

use aide_de_camp::prelude::{

    CancellationToken, Duration, JobProcessor, JobRunner, Queue, RunnerOptions, RunnerRouter, Xid,

};

use aide_de_camp_mongodb::MongoDbQueue;

use async_trait::async_trait;

struct MyJob;

#[async_trait]

impl JobProcessor for MyJob {

    type Payload = Vec;

    type Error = anyhow::Error;

    async fn handle(

        &self,

        _jid: Xid,

        payload: Self::Payload,

        _cancellation_token: CancellationToken,

    ) -> Result<(), Self::Error> {

        println!("payload: {:?}", payload);

        Ok(())

    }

    fn name() -> &'static str {

        "my_job"

    }

}

#[tokio::main]

async fn main() -> Result<(), Box> {

    let queue = MongoDbQueue::new("mongodb://localhost:27017/queues", None).await?;

    // Add job the queue to run next

    let _jid = queue.schedule::(vec![1, 2, 3], 0).await?;

    // First create a job processor and router

    let router = {

        let mut r = RunnerRouter::default();

        r.add_job_handler(MyJob);

        r

    };

    // Setup runner to at most 10 jobs concurrently

    let mut runner = JobRunner::new(queue, router, 10, RunnerOptions::default());

    // Poll the queue every second, this will block unless something went really wrong.

    // The future supplied as the second parameter will tell the server to shut down when it completes.

    runner

        .run_with_shutdown(Duration::seconds(1), async move {

            // To avoid blocking this doctest, run for 10 milliseconds, then initiate shutdown.

            tokio::time::sleep(std::time::Duration::from_millis(10)).await;

            // In a real application, you may want to wait for a CTRL+C event or something similar.

            // You could do this with tokio using the signal module: tokio::signal::ctrl_c().await.expect("failed to install CTRL+C signal handler");

        })

        .await?;

    Ok(())

}

```

## License

I decided to follow the same licensing model as aide-de-camp, so be welcome to choose either of the following based on your use case:

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)