Struct apalis::sqlite::SqliteStorage

pub struct SqliteStorage<T> { /* private fields */ }

Available on crate feature sqlite only.

Represents a Storage that persists to Sqlite

Implementations

impl SqliteStorage<()>

pub async fn setup(pool: &Pool<Sqlite>) -> Result<(), Error>

Perform migrations for storage

pub fn migrations() -> Migrator

Get sqlite migrations without running them

impl<T> SqliteStorage<T>

where T: Job + Serialize + DeserializeOwned,

pub fn new(pool: Pool<Sqlite>) -> SqliteStorage<T>

Construct a new Storage from a pool

pub fn new_with_config(pool: Pool<Sqlite>, config: Config) -> SqliteStorage<T>

Create a new instance with a custom config

pub async fn keep_alive_at<Service>( &mut self, worker_id: &WorkerId, last_seen: i64 ) -> Result<(), Error>

Keeps a storage notified that the worker is still alive manually

pub fn pool(&self) -> &Pool<Sqlite>

Expose the pool for other functionality, eg custom migrations

impl<T> SqliteStorage<T>

pub async fn retry( &mut self, worker_id: &WorkerId, job_id: &TaskId ) -> Result<(), Error>

Puts the job instantly back into the queue Another [Worker] may consume

pub async fn kill( &mut self, worker_id: &WorkerId, job_id: &TaskId ) -> Result<(), Error>

Kill a job

pub async fn reenqueue_failed(&self) -> Result<(), Error>

where T: Job,

Add jobs that failed back to the queue if there are still remaining attemps

pub async fn reenqueue_orphaned(&self, timeout: i64) -> Result<(), Error>

where T: Job,

Add jobs that workers have disappeared to the queue

Trait Implementations

impl<T> Ack<T> for SqliteStorage<T>

where T: Sync,

type Acknowledger = TaskId

The data to fetch from context to allow acknowledgement

type Error = Error

The error returned by the ack

async fn ack( &self, worker_id: &WorkerId, task_id: &<SqliteStorage<T> as Ack<T>>::Acknowledger ) -> Result<(), Error>

Acknowledges successful processing of the given request

impl<T> Backend<Request<T>> for SqliteStorage<T>

where T: Job + Serialize + DeserializeOwned + Sync + Send + Unpin + 'static,

type Stream = BackendStream<Pin<Box<dyn Stream<Item = Result<Option<Request<T>>, Error>> + Send>>>

The stream to be produced by the backend

type Layer = AckLayer<SqliteStorage<T>, T>

Returns the final decoration of layers

fn common_layer( &self, worker_id: WorkerId ) -> <SqliteStorage<T> as Backend<Request<T>>>::Layer

Allows the backend to decorate the service with Layer

fn poll( self, worker: WorkerId ) -> Poller<<SqliteStorage<T> as Backend<Request<T>>>::Stream>

Returns a poller that is ready for streaming

impl<T> Clone for SqliteStorage<T>

fn clone(&self) -> SqliteStorage<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for SqliteStorage<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> Storage for SqliteStorage<T>

where T: Job + Serialize + DeserializeOwned + Send + 'static + Unpin + Sync,

type Job = T

The type of job that can be persisted

type Error = Error

The error produced by the storage

type Identifier = TaskId

Jobs must have Ids.

async fn push( &mut self, job: <SqliteStorage<T> as Storage>::Job ) -> Result<TaskId, <SqliteStorage<T> as Storage>::Error>

Pushes a job to a storage

async fn schedule( &mut self, job: <SqliteStorage<T> as Storage>::Job, on: i64 ) -> Result<TaskId, <SqliteStorage<T> as Storage>::Error>

Push a job into the scheduled set

async fn fetch_by_id( &self, job_id: &TaskId ) -> Result<Option<Request<<SqliteStorage<T> as Storage>::Job>>, <SqliteStorage<T> as Storage>::Error>

Fetch a job given an id

async fn len(&self) -> Result<i64, <SqliteStorage<T> as Storage>::Error>

Return the number of pending jobs from the queue

async fn reschedule( &mut self, job: Request<T>, wait: Duration ) -> Result<(), <SqliteStorage<T> as Storage>::Error>

Reschedule a job

async fn update( &self, job: Request<<SqliteStorage<T> as Storage>::Job> ) -> Result<(), <SqliteStorage<T> as Storage>::Error>

Update a job details

async fn is_empty(&self) -> Result<bool, <SqliteStorage<T> as Storage>::Error>

Returns true if there is no jobs in the storage

async fn vacuum(&self) -> Result<usize, Error>

Vacuum the storage, removes done and killed jobs