Package org.jobrunr.storage.sql.common

Class DefaultSqlStorageProvider

java.lang.Object

org.jobrunr.storage.AbstractStorageProvider

org.jobrunr.storage.sql.common.DefaultSqlStorageProvider

All Implemented Interfaces:

AutoCloseable, SqlStorageProvider, StorageProvider

Direct Known Subclasses:

DB2StorageProvider, H2StorageProvider, MariaDbStorageProvider, MySqlStorageProvider, OracleStorageProvider, PostgresStorageProvider, SqLiteStorageProvider, SQLServerStorageProvider

public class DefaultSqlStorageProvider
extends AbstractStorageProvider
implements SqlStorageProvider

Nested Class Summary

Nested classes/interfaces inherited from interface org.jobrunr.storage.StorageProvider

StorageProvider.StorageProviderInfo

Field Summary

Fields

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

Fields inherited from interface org.jobrunr.storage.StorageProvider

BATCH_SIZE

Constructor Summary

Constructors

Constructor	Description
DefaultSqlStorageProvider(DataSource dataSource, Dialect dialect, String tablePrefix, StorageProviderUtils.DatabaseOptions databaseOptions)
DefaultSqlStorageProvider(DataSource dataSource, Dialect dialect, StorageProviderUtils.DatabaseOptions databaseOptions)
DefaultSqlStorageProvider(DataSource dataSource, Dialect dialect, StorageProviderUtils.DatabaseOptions databaseOptions, RateLimiter changeListenerNotificationRateLimit)

Method Summary

Modifier and Type	Method	Description
void	announceBackgroundJobServer(BackgroundJobServerStatus serverStatus)
protected BackgroundJobServerTable	backgroundJobServerTable(Connection connection)
long	countRecurringJobs()
int	deleteJobsPermanently(StateName state, Instant updatedBefore)
void	deleteMetadata(String name)
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.
boolean	exists(JobDetails jobDetails, StateName... states)
List<BackgroundJobServerStatus>	getBackgroundJobServers()
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
Page<Job>	getJobPage(StateName state, PageRequest pageRequest)
List<Job>	getJobs(StateName state, Instant updatedBefore, PageRequest pageRequest)
List<Job>	getJobs(StateName state, PageRequest pageRequest)
JobStats	getJobStats()	Returns the statistics of the jobs (amount enqueued, amount scheduled, ...) Important: in most cases, this results in a intensive query.

Methods inherited from class org.jobrunr.storage.AbstractStorageProvider

addJobStorageOnChangeListener, close, getStorageProviderInfo, notifyJobStatsOnChangeListeners, notifyJobStatsOnChangeListenersIf, notifyMetadataChangeListeners, notifyMetadataChangeListeners, removeJobStorageOnChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jobrunr.storage.StorageProvider

addJobStorageOnChangeListener, close, getJobById, getStorageProviderInfo, removeJobStorageOnChangeListener

Field Details

dataSource

protected final DataSource dataSource

dialect

protected final Dialect dialect

tablePrefix

protected final String tablePrefix

Constructor Details

DefaultSqlStorageProvider

public DefaultSqlStorageProvider(DataSource dataSource,
 Dialect dialect,
 StorageProviderUtils.DatabaseOptions databaseOptions)

DefaultSqlStorageProvider

public DefaultSqlStorageProvider(DataSource dataSource,
 Dialect dialect,
 String tablePrefix,
 StorageProviderUtils.DatabaseOptions databaseOptions)

DefaultSqlStorageProvider

public DefaultSqlStorageProvider(DataSource dataSource,
 Dialect dialect,
 StorageProviderUtils.DatabaseOptions databaseOptions,
 RateLimiter changeListenerNotificationRateLimit)

Method Details

setJobMapper

public void setJobMapper(JobMapper jobMapper)

Specified by:

setJobMapper in interface StorageProvider

setUpStorageProvider

public void setUpStorageProvider(StorageProviderUtils.DatabaseOptions databaseOptions)

Description copied from interface: StorageProvider

This method allows to reinitialize the StorageProvider. It can be used if you are using Flyway or Liquibase to setup your database manually.

By default, this method is automatically called on construction of the StorageProvider

Specified by:

setUpStorageProvider in interface StorageProvider

Parameters:

databaseOptions - defines whether to set up the StorageProvider or validate whether the StorageProvider is set up correctly.

announceBackgroundJobServer

public void announceBackgroundJobServer(BackgroundJobServerStatus serverStatus)

Specified by:

announceBackgroundJobServer in interface StorageProvider

signalBackgroundJobServerAlive

public boolean signalBackgroundJobServerAlive(BackgroundJobServerStatus serverStatus)

Specified by:

signalBackgroundJobServerAlive in interface StorageProvider

signalBackgroundJobServerStopped

public void signalBackgroundJobServerStopped(BackgroundJobServerStatus serverStatus)

Specified by:

signalBackgroundJobServerStopped in interface StorageProvider

getBackgroundJobServers

public List<BackgroundJobServerStatus> getBackgroundJobServers()

Specified by:

getBackgroundJobServers in interface StorageProvider

getLongestRunningBackgroundJobServerId

public UUID getLongestRunningBackgroundJobServerId()

Specified by:

getLongestRunningBackgroundJobServerId in interface StorageProvider

removeTimedOutBackgroundJobServers

public int removeTimedOutBackgroundJobServers(Instant heartbeatOlderThan)

Specified by:

removeTimedOutBackgroundJobServers in interface StorageProvider

saveMetadata

public void saveMetadata(JobRunrMetadata metadata)

Specified by:

saveMetadata in interface StorageProvider

getMetadata

public List<JobRunrMetadata> getMetadata(String name)

Specified by:

getMetadata in interface StorageProvider

getMetadata

public JobRunrMetadata getMetadata(String name,
 String owner)

Specified by:

getMetadata in interface StorageProvider

deleteMetadata

public void deleteMetadata(String name)

Specified by:

deleteMetadata in interface StorageProvider

save

public Job save(Job jobToSave)

Description copied from interface: StorageProvider

Save the Job and increases the version if saving succeeded.

Specified by:

save in interface StorageProvider

Parameters:

jobToSave - the job to save

Returns:

the same job with an increased version

save

public List<Job> save(List<Job> jobs)

Description copied from interface: StorageProvider

Saves a list of Jobs and increases the version of each successfully saved Job.

Specified by:

save in interface StorageProvider

Parameters:

jobs - the list of jobs to save

Returns:

the same list of jobs with an increased version

getJobById

public Job getJobById(UUID id)

Description copied from interface: StorageProvider

Returns the Job with the given id or throws a JobNotFoundException if the job does not exist

Specified by:

getJobById in interface StorageProvider

Parameters:

id - the id of the Job to fetch

Returns:

the requested Job

getScheduledJobs

public List<Job> getScheduledJobs(Instant scheduledBefore,
 PageRequest pageRequest)

Specified by:

getScheduledJobs in interface StorageProvider

getJobs

public List<Job> getJobs(StateName state,
 PageRequest pageRequest)

Specified by:

getJobs in interface StorageProvider

getJobs

public List<Job> getJobs(StateName state,
 Instant updatedBefore,
 PageRequest pageRequest)

Specified by:

getJobs in interface StorageProvider

getJobPage

public Page<Job> getJobPage(StateName state,
 PageRequest pageRequest)

Specified by:

getJobPage in interface StorageProvider

deletePermanently

public int deletePermanently(UUID id)

Description copied from interface: StorageProvider

Deletes the Job with the given id and returns the amount of deleted jobs (either 0 or 1).

Specified by:

deletePermanently in interface StorageProvider

Parameters:

id - the id of the Job to delete

Returns:

1 if the job with the given id was deleted, 0 otherwise

deleteJobsPermanently

public int deleteJobsPermanently(StateName state,
 Instant updatedBefore)

Specified by:

deleteJobsPermanently in interface StorageProvider

getDistinctJobSignatures

public Set<String> getDistinctJobSignatures(StateName... states)

Specified by:

getDistinctJobSignatures in interface StorageProvider

exists

public boolean exists(JobDetails jobDetails,
 StateName... states)

Specified by:

exists in interface StorageProvider

recurringJobExists

public boolean recurringJobExists(String recurringJobId,
 StateName... states)

Description copied from interface: StorageProvider

Returns true when a Job created by the RecurringJob with the given id exists with one of the given states.

Specified by:

recurringJobExists in interface StorageProvider

Parameters:

recurringJobId - the id of the RecurringJob for which the check whether a Job exists

states - the possible states for the Job (can be empty)

Returns:

true if a Job exists created by a RecurringJob with the given id.

saveRecurringJob

public RecurringJob saveRecurringJob(RecurringJob recurringJob)

Description copied from interface: StorageProvider

Saves a RecurringJob to the database. If a RecurringJob with the same id exists, it will be overwritten

Specified by:

saveRecurringJob in interface StorageProvider

Parameters:

recurringJob - the RecurringJob to save

Returns:

the same RecurringJob

getRecurringJobs

public RecurringJobsResult getRecurringJobs()

Description copied from interface: StorageProvider

Returns a list RecurringJobs.

Specified by:

getRecurringJobs in interface StorageProvider

Returns:

a list RecurringJobs.

recurringJobsUpdated

public boolean recurringJobsUpdated(Long recurringJobsUpdatedHash)

Specified by:

recurringJobsUpdated in interface StorageProvider

countRecurringJobs

public long countRecurringJobs()

Specified by:

countRecurringJobs in interface StorageProvider

deleteRecurringJob

public int deleteRecurringJob(String id)

Description copied from interface: StorageProvider

Deletes the RecurringJob with the given id.

Specified by:

deleteRecurringJob in interface StorageProvider

Parameters:

id - the id of the RecurringJob to delete

Returns:

1 if the RecurringJob with the given id was deleted, 0 otherwise

getJobStats

public JobStats getJobStats()

Description copied from interface: StorageProvider

Returns the statistics of the jobs (amount enqueued, amount scheduled, ...) Important: in most cases, this results in a intensive query. JobRunr is designed to not call this method too often to limit database CPU utilization. If you need access to this info, please use a JobStatsChangeListener and register it using the StorageProvider.addJobStorageOnChangeListener(StorageProviderChangeListener).

Specified by:

getJobStats in interface StorageProvider

Returns:

the JobStats

publishTotalAmountOfSucceededJobs

public void publishTotalAmountOfSucceededJobs(int amount)

Specified by:

publishTotalAmountOfSucceededJobs in interface StorageProvider

getDatabaseCreator

protected DatabaseCreator getDatabaseCreator()

jobTable

protected JobTable jobTable(Connection connection)

recurringJobTable

protected RecurringJobTable recurringJobTable(Connection connection)

backgroundJobServerTable

protected BackgroundJobServerTable backgroundJobServerTable(Connection connection)

metadataTable

protected MetadataTable metadataTable(Connection connection)

jobStatsView

protected JobStatsView jobStatsView(Connection connection)