archimedes 0.4.0

High performance Rust/PostgreSQL job queue (also suitable for getting jobs generated by PostgreSQL triggers/functions out into a different work queue)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

use archimedes_task_handler::TaskDefinition;
use serde::Serialize;
use sqlx::PgPool;

use crate::{errors::ArchimedesError, sql::add_job::add_job, JobSpec, WorkerContext};

/// The WorkerHelpers struct provides a set of methods to add jobs to the queue
pub struct WorkerHelpers {
    pg_pool: PgPool,
    escaped_schema: String,
}

impl WorkerHelpers {
    /// Create a new instance of WorkerHelpers
    pub fn new(pg_pool: PgPool, escaped_schema: String) -> Self {
        Self {
            pg_pool,
            escaped_schema,
        }
    }

    /// Add a job to the queue
    /// The payload must be exactly the same type as the one defined in the task definition
    pub async fn add_job<T: TaskDefinition<WorkerContext>>(
        &self,
        payload: T::Payload,
        spec: Option<JobSpec>,
    ) -> Result<(), ArchimedesError> {
        let identifier = T::identifier();
        let payload = serde_json::to_value(payload)?;
        add_job(
            &self.pg_pool,
            &self.escaped_schema,
            identifier,
            payload,
            spec.unwrap_or_default(),
        )
        .await
    }

    /// Add a job to the queue
    /// Contrary to add_job, this method does not require the task definition to be known
    pub async fn add_raw_job<P>(
        &self,
        identifier: &str,
        payload: P,
        spec: Option<JobSpec>,
    ) -> Result<(), ArchimedesError>
    where
        P: Serialize,
    {
        let payload = serde_json::to_value(payload)?;
        add_job(
            &self.pg_pool,
            &self.escaped_schema,
            identifier,
            payload,
            spec.unwrap_or_default(),
        )
        .await
    }
}