coil 0.4.0

An async and sync background job queue for Postgres
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
63
64
65
66
67
68
69
70
71
72

// Copyright 2018-2019 Parity Technologies (UK) Ltd.
// This file is part of coil.

// coil is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// coil is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with coil.  If not, see <http://www.gnu.org/licenses/>.

//! `coil` is a efficient background job queue for Postgres. The API is very
//! similiar and indeed based upon [swirl](https://github.com/sgrif/swirl).
//! In addition to the functionality `swirl` offers, however, `coil` can:
//! - Queue asynchronous tasks for execution on an executor, whether it be `smol`, `tokio` or `async-std`
//! - Queue functions with generics
//! - SQL queries in `coil` are ran asynchronously wherever possible
//! - Migrations are stored in the binary, and accessible via a `migrate()` fn. No more needing to copy-paste migration files!

#![forbid(unsafe_code)]
#![deny(dead_code)]

mod batch;
mod db;
mod error;
mod job;
mod registry;
mod runner;

#[doc(hidden)]
pub extern crate async_trait;
#[doc(hidden)]
pub extern crate inventory;
#[doc(hidden)]
pub extern crate serde;
#[doc(hidden)]
pub extern crate sqlx;
#[doc(hidden)]
pub use serde::{de::DeserializeOwned, Deserialize, Serialize};

#[doc(hidden)]
pub use registry::JobVTable;

pub use crate::db::migrate;
pub use crate::error::*;
pub use crate::job::*;
#[cfg(any(test, feature = "test_components"))]
pub use crate::runner::Event;
pub use crate::runner::{Builder, Runner};
pub use coil_proc_macro::*;

#[cfg(test)]
use sqlx::Connection;
#[cfg(test)]
use std::sync::Once;
#[cfg(test)]
static INIT: Once = Once::new();

#[cfg(test)]
pub fn initialize() {
    INIT.call_once(|| {
        pretty_env_logger::init();
        let url = dotenv::var("DATABASE_URL").unwrap();
        let mut conn = smol::block_on(sqlx::PgConnection::connect(url.as_str())).unwrap();
        smol::block_on(crate::migrate(&mut conn)).unwrap();
    });
}