Class SqLiteStorageProvider

java.lang.Object

org.jobrunr.storage.AbstractStorageProvider

org.jobrunr.storage.sql.common.DefaultSqlStorageProvider

org.jobrunr.storage.sql.sqlite.SqLiteStorageProvider

All Implemented Interfaces:

AutoCloseable, SqlStorageProvider, StorageProvider

public class SqLiteStorageProvider
extends DefaultSqlStorageProvider

Nested Class Summary

Nested classes/interfaces inherited from interface StorageProvider

StorageProvider.StorageProviderInfo

Modifier and Type	Interface	Description
static class	StorageProvider.StorageProviderInfo

Field Summary

Fields inherited from class DefaultSqlStorageProvider

dataSource, dialect, tablePrefix

Modifier and Type	Field	Description
protected final DataSource	dataSource
protected final Dialect	dialect
protected final String	tablePrefix

Fields inherited from interface StorageProvider

BATCH_SIZE

Modifier and Type	Field	Description
static final int	BATCH_SIZE

Constructor Summary

Constructors

Constructor	Description
SqLiteStorageProvider(DataSource dataSource)
SqLiteStorageProvider(DataSource dataSource, String tablePrefix)
SqLiteStorageProvider(DataSource dataSource, String tablePrefix, StorageProviderUtils.DatabaseOptions databaseOptions)
SqLiteStorageProvider(DataSource dataSource, String tablePrefix, StorageProviderUtils.DatabaseOptions databaseOptions, RateLimiter changeListenerNotificationRateLimit)
SqLiteStorageProvider(DataSource dataSource, StorageProviderUtils.DatabaseOptions databaseOptions)

Method Summary

Methods inherited from class DefaultSqlStorageProvider

announceBackgroundJobServer, backgroundJobServerTable, countJobs, deleteJobsPermanently, deleteMetadata, deleteMetadata, deletePermanently, deleteRecurringJob, getBackgroundJobServers, getCarbonAwareJobList, getDatabaseCreator, getDistinctJobSignatures, getJobById, getJobList, getJobList, getJobStats, getJobsToProcess, getLongestRunningBackgroundJobServerId, getMetadata, getMetadata, getRecurringJobLatestScheduledInstant, getRecurringJobs, getScheduledJobs, jobStatsView, jobTable, metadataTable, publishTotalAmountOfSucceededJobs, recurringJobsUpdated, recurringJobTable, removeTimedOutBackgroundJobServers, save, save, saveMetadata, saveRecurringJob, setJobMapper, setUpStorageProvider, signalBackgroundJobServerAlive, signalBackgroundJobServerStopped

Modifier and Type	Method	Description
void	announceBackgroundJobServer(BackgroundJobServerStatus serverStatus)
protected BackgroundJobServerTable	backgroundJobServerTable(Connection connection)
long	countJobs(StateName state)	Counts all the jobs matching the given StateName.
int	deleteJobsPermanently(StateName state, Instant updatedBefore)
void	deleteMetadata(String name)
void	deleteMetadata(String name, String owner)
int	deletePermanently(UUID id)	Deletes the Job with the given id and returns the amount of deleted jobs (either 0 or 1).
int	deleteRecurringJob(String id)	Deletes the RecurringJob with the given id.
List<BackgroundJobServerStatus>	getBackgroundJobServers()
List<Job>	getCarbonAwareJobList(Instant deadlineBefore, AmountRequest amountRequest)	Returns all carbon aware jobs with a deadline before the given Instant.
protected DatabaseCreator	getDatabaseCreator()
Set<String>	getDistinctJobSignatures(StateName... states)
Job	getJobById(UUID id)	Returns the Job with the given id or throws a JobNotFoundException if the job does not exist
List<Job>	getJobList(StateName state, Instant updatedBefore, AmountRequest amountRequest)	Returns all the jobs matching the given StateName, Instant and AmountRequest.
List<Job>	getJobList(StateName state, AmountRequest amountRequest)	Returns all the jobs matching the given StateName and AmountRequest.
JobStats	getJobStats()	Returns the statistics of the jobs (amount enqueued, amount scheduled, ...) Important: in most cases, this results in a intensive query.
List<Job>	getJobsToProcess(BackgroundJobServer backgroundJobServer, AmountRequest amountRequest)
UUID	getLongestRunningBackgroundJobServerId()
List<JobRunrMetadata>	getMetadata(String name)
JobRunrMetadata	getMetadata(String name, String owner)
Instant	getRecurringJobLatestScheduledInstant(String recurringJobId, StateName... states)	Returns the scheduled instant of the last Job, in one of the given states, created by the RecurringJob with the given recurringJobId.
RecurringJobsResult	getRecurringJobs()	Returns a list RecurringJobs.
List<Job>	getScheduledJobs(Instant scheduledBefore, AmountRequest amountRequest)
protected JobStatsView	jobStatsView(Connection connection)
protected JobTable	jobTable(Connection connection)
protected MetadataTable	metadataTable(Connection connection)
void	publishTotalAmountOfSucceededJobs(int amount)
boolean	recurringJobsUpdated(Long recurringJobsUpdatedHash)
protected RecurringJobTable	recurringJobTable(Connection connection)
int	removeTimedOutBackgroundJobServers(Instant heartbeatOlderThan)
List<Job>	save(List<Job> jobs)	Saves a list of Jobs and increases the version of each successfully saved Job.
Job	save(Job jobToSave)	Save the Job and increases the version if saving succeeded.
void	saveMetadata(JobRunrMetadata metadata)
RecurringJob	saveRecurringJob(RecurringJob recurringJob)	Saves a RecurringJob to the database.
void	setJobMapper(JobMapper jobMapper)
void	setUpStorageProvider(StorageProviderUtils.DatabaseOptions databaseOptions)	This method allows to reinitialize the StorageProvider.
boolean	signalBackgroundJobServerAlive(BackgroundJobServerStatus serverStatus)
void	signalBackgroundJobServerStopped(BackgroundJobServerStatus serverStatus)

Methods inherited from class AbstractStorageProvider

addJobStorageOnChangeListener, close, getStorageProviderInfo, notifyJobStatsOnChangeListeners, notifyJobStatsOnChangeListenersIf, notifyMetadataChangeListeners, notifyMetadataChangeListenersIf, notifyMetadataChangeListenersOnCurrentThread, removeJobStorageOnChangeListener, validatePollInterval, validateRecurringJobInterval

Modifier and Type	Method	Description
void	addJobStorageOnChangeListener(StorageProviderChangeListener listener)	Allows to listen for changes related to jobs.
void	close()
StorageProvider.StorageProviderInfo	getStorageProviderInfo()
protected void	notifyJobStatsOnChangeListeners()
protected void	notifyJobStatsOnChangeListenersIf(boolean mustNotify)
protected void	notifyMetadataChangeListeners()
protected void	notifyMetadataChangeListenersIf(boolean mustNotify)
protected void	notifyMetadataChangeListenersOnCurrentThread()
void	removeJobStorageOnChangeListener(StorageProviderChangeListener listener)	Remove the given listener that listens for changes to Jobs
final void	validatePollInterval(Duration pollInterval)
final void	validateRecurringJobInterval(Duration durationBetweenRecurringJobInstances)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface StorageProvider

getJobById, getJobs, getScheduledJobs

Modifier and Type	Method	Description
default Job	getJobById(JobId jobId)	Returns the Job with the given id or throws a JobNotFoundException if the job does not exist
default Page<Job>	getJobs(StateName state, PageRequest pageRequest)
default Page<Job>	getScheduledJobs(Instant scheduledBefore, PageRequest pageRequest)

Constructor Details

SqLiteStorageProvider

public SqLiteStorageProvider(DataSource dataSource)

SqLiteStorageProvider

public SqLiteStorageProvider(DataSource dataSource,
 String tablePrefix)

SqLiteStorageProvider

public SqLiteStorageProvider(DataSource dataSource,
 StorageProviderUtils.DatabaseOptions databaseOptions)

SqLiteStorageProvider

public SqLiteStorageProvider(DataSource dataSource,
 String tablePrefix,
 StorageProviderUtils.DatabaseOptions databaseOptions)

SqLiteStorageProvider

public SqLiteStorageProvider(DataSource dataSource,
 String tablePrefix,
 StorageProviderUtils.DatabaseOptions databaseOptions,
 RateLimiter changeListenerNotificationRateLimit)