Struct InMemoryJobState 

pub struct InMemoryJobState { /* private fields */ }

Implementation of JobState which keeps all state in memory. If using InMemoryJobState no job state will be shared between schedulers

Implementations

impl InMemoryJobState

pub fn new( scheduler: impl Into<String>, session_builder: fn(SessionConfig) -> SessionState, ) -> Self

Trait Implementations

impl JobState for InMemoryJobState

fn submit_job<'life0, 'life1, 'async_trait>( &'life0 self, job_id: String, graph: &'life1 ExecutionGraph, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Submit a new job to the JobState. It is assumed that the submitter owns the job. In local state the job should be save as JobStatus::Active and in shared state it should be saved as JobStatus::Running with scheduler set to the current scheduler

fn get_job_status<'life0, 'life1, 'async_trait>( &'life0 self, job_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<JobStatus>>> + Send + 'async_trait>>

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

Fetch the job status

fn get_execution_graph<'life0, 'life1, 'async_trait>( &'life0 self, job_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<ExecutionGraph>>> + Send + 'async_trait>>

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

Get the ExecutionGraph for job. The job may or may not belong to the caller and should return the ExecutionGraph for the given job (if it exists) at the time this method is called with no guarantees that the graph has not been subsequently updated by another scheduler.

fn try_acquire_job<'life0, 'life1, 'async_trait>( &'life0 self, _job_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<ExecutionGraph>>> + Send + 'async_trait>>

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

Attempt to acquire ownership of the given job. If the job is still in a running state and is successfully acquired by the caller, return the current ExecutionGraph, otherwise return None

fn save_job<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, job_id: &'life1 str, graph: &'life2 ExecutionGraph, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Persist the current state of an owned job to global state. This should fail if the job is not owned by the caller.

fn get_session<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Arc<SessionContext>>> + Send + 'async_trait>>

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

Get the SessionContext associated with session_id. Returns an error if the session does not exist

fn create_session<'life0, 'life1, 'async_trait>( &'life0 self, config: &'life1 KapotConfig, ) -> Pin<Box<dyn Future<Output = Result<Arc<SessionContext>>> + Send + 'async_trait>>

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

Create a new saved session

fn update_session<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session_id: &'life1 str, config: &'life2 KapotConfig, ) -> Pin<Box<dyn Future<Output = Result<Arc<SessionContext>>> + Send + 'async_trait>>

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

fn remove_session<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Arc<SessionContext>>>> + Send + 'async_trait>>

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

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

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

Get a stream of all JobState events. An event should be published any time that status of a job changes in state

fn remove_job<'life0, 'life1, 'async_trait>( &'life0 self, job_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Delete a job from the global state

fn get_jobs<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HashSet<String>>> + Send + 'async_trait>>

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

Return a Vec of all active job IDs in the JobState

fn accept_job(&self, job_id: &str, job_name: &str, queued_at: u64) -> Result<()>

Accept job into a scheduler’s job queue. This should be called when a job is received by the scheduler but before it is planned and may or may not be saved in global state

fn pending_job_number(&self) -> usize

Get the number of queued jobs. If it’s big, then it means the scheduler is too busy. In normal case, it’s better to be 0.

fn fail_unscheduled_job<'life0, 'life1, 'async_trait>( &'life0 self, job_id: &'life1 str, reason: String, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Mark a job which has not been submitted as failed. This should be called if a job fails during planning (and does not yet have an ExecutionGraph)