Struct SqliteStorage

pub struct SqliteStorage { /* private fields */ }

A storage implementation backed by sqlite.

Implementations

impl SqliteStorage

pub fn new(config: SqliteStorageConfig) -> Result<Self>

Create a new sqlite storage instance with the given connection.

pub async fn optimize(&self) -> Result<()>

Run optimize on the database.

This should be called periodically (e.g. hourly).

pub async fn vacuum(&self) -> Result<()>

Run vacuum on the database.

This should be called periodically depending on the amount of data generated and deleted (e.g. daily).

Trait Implementations

impl Clone for SqliteStorage

fn clone(&self) -> SqliteStorage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqliteStorage

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

Formats the value using the given formatter.

impl Storage for SqliteStorage

fn job_types_added<'life0, 'async_trait>( &'life0 self, job_types: Vec<JobType>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Add or update a job type.

fn jobs_added<'life0, 'async_trait>( &'life0 self, jobs: Vec<NewJob>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Persist the given new jobs.

fn job_added_conditionally<'life0, 'async_trait>( &'life0 self, job: NewJob, filters: JobQueryFilters, ) -> Pin<Box<dyn Future<Output = Result<ConditionalJobResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Persist the given job if no jobs match the filter.

fn jobs_cancelled<'life0, 'life1, 'async_trait>( &'life0 self, job_ids: &'life1 [Uuid], timestamp: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<Vec<CancelledJob>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Cancel the given jobs.

fn executions_added<'life0, 'async_trait>( &'life0 self, executions: Vec<NewExecution>, timestamp: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Add new executions.

fn executions_ready<'life0, 'life1, 'async_trait>( &'life0 self, execution_ids: &'life1 [Uuid], timestamp: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

An execution is ready to be executed.

fn execution_assigned<'life0, 'async_trait>( &'life0 self, execution_id: Uuid, executor_id: Uuid, timestamp: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

An execution was assigned to an executor.

fn execution_started<'life0, 'async_trait>( &'life0 self, execution_id: Uuid, timestamp: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set an execution as started.

fn execution_succeeded<'life0, 'async_trait>( &'life0 self, execution_id: Uuid, timestamp: SystemTime, output_payload_json: String, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set an execution as succeeded.

fn executions_failed<'life0, 'life1, 'async_trait>( &'life0 self, execution_ids: &'life1 [Uuid], timestamp: SystemTime, reason: String, mark_job_unschedulable: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Set an execution as failed, if mark_job_unschedulable is false the job is not marked as unschedulable, this happens when the job is retried.

fn orphan_execution_ids<'life0, 'life1, 'async_trait>( &'life0 self, executor_ids: &'life1 [Uuid], ) -> Pin<Box<dyn Future<Output = Result<Vec<Uuid>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Return assigned executions that are not assigned to any of the given executor IDs.

fn jobs_unschedulable<'life0, 'life1, 'async_trait>( &'life0 self, job_ids: &'life1 [Uuid], timestamp: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Mark a job as unschedulable.

fn pending_executions<'life0, 'async_trait>( &'life0 self, after: Option<Uuid>, ) -> Pin<Box<dyn Future<Output = Result<Vec<PendingExecution>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executions that are not yet ready to be executed.

fn ready_executions<'life0, 'async_trait>( &'life0 self, after: Option<Uuid>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ReadyExecution>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Unassigned executions that are ready at the time of the call.

fn pending_jobs<'life0, 'async_trait>( &'life0 self, after: Option<Uuid>, ) -> Pin<Box<dyn Future<Output = Result<Vec<PendingJob>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Jobs that satisfy the following conditions:

fn query_jobs<'life0, 'async_trait>( &'life0 self, cursor: Option<String>, limit: usize, order: JobQueryOrder, filters: JobQueryFilters, ) -> Pin<Box<dyn Future<Output = Result<JobQueryResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Query and return a list of jobs with the given parameters.

fn query_job_ids<'life0, 'async_trait>( &'life0 self, filters: JobQueryFilters, ) -> Pin<Box<dyn Future<Output = Result<Vec<Uuid>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Query and return a list of job IDs with the given parameters.

fn count_jobs<'life0, 'async_trait>( &'life0 self, filters: JobQueryFilters, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Count the number of jobs that satisfy the given filters.

fn query_job_types<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<JobType>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Query and return a list of job types with the given parameters.

fn delete_jobs<'life0, 'async_trait>( &'life0 self, filters: JobQueryFilters, ) -> Pin<Box<dyn Future<Output = Result<Vec<Uuid>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove jobs and all related data, returns the removed job IDs.

fn schedules_added<'life0, 'async_trait>( &'life0 self, schedules: Vec<NewSchedule>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Persist the given new schedules.

fn schedule_added_conditionally<'life0, 'async_trait>( &'life0 self, schedule: NewSchedule, filter: ScheduleQueryFilters, ) -> Pin<Box<dyn Future<Output = Result<ConditionalScheduleResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Persist the given schedule if no schedules match the filter.

fn schedules_cancelled<'life0, 'life1, 'async_trait>( &'life0 self, schedule_ids: &'life1 [Uuid], timestamp: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<Vec<CancelledSchedule>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Cancel the given schedules.

fn schedules_unschedulable<'life0, 'life1, 'async_trait>( &'life0 self, schedule_ids: &'life1 [Uuid], timestamp: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Mark the given schedules as unschedulable.

fn pending_schedules<'life0, 'async_trait>( &'life0 self, after: Option<Uuid>, ) -> Pin<Box<dyn Future<Output = Result<Vec<PendingSchedule>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return all pending schedules.

fn query_schedules<'life0, 'async_trait>( &'life0 self, cursor: Option<String>, limit: usize, filters: ScheduleQueryFilters, order: ScheduleQueryOrder, ) -> Pin<Box<dyn Future<Output = Result<ScheduleQueryResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Query and return a list of schedules with the given parameters.

fn query_schedule_ids<'life0, 'async_trait>( &'life0 self, filters: ScheduleQueryFilters, ) -> Pin<Box<dyn Future<Output = Result<Vec<Uuid>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Query and return a list of schedule IDs with the given parameters.

fn count_schedules<'life0, 'async_trait>( &'life0 self, filters: ScheduleQueryFilters, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Count the number of schedules that satisfy the given filters.

fn delete_schedules<'life0, 'async_trait>( &'life0 self, filters: ScheduleQueryFilters, ) -> Pin<Box<dyn Future<Output = Result<Vec<Uuid>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove schedules and all related data, returns the removed schedule IDs.