MySQL

Use MySQL as the JobRunr StorageProvider - driver dependency, configuration, and table creation.

On this page

JobRunr stores all background jobs in MySQL through the MySqlStorageProvider. JobRunr is tested against MySQL 8.

Add the driver dependency

Add the MySQL JDBC driver (Connector/J) to your project. The latest version is on Maven Central.

<dependency>
  <groupId>com.mysql</groupId>
  <artifactId>mysql-connector-j</artifactId>
  <version><!-- latest version --></version>
</dependency>

implementation 'com.mysql:mysql-connector-j' // version omitted, use latest

Configuration

If you use a framework starter, JobRunr automatically detects your existing DataSource - configure your database the usual way and you are done.

HikariConfig config = new HikariConfig();
config.setJdbcUrl("jdbc:mysql://localhost:3306/mydb");
config.setUsername("myuser");
config.setPassword("mypassword");
DataSource dataSource = new HikariDataSource(config);

JobRunr.configure()
    .useStorageProvider(SqlStorageProviderFactory.using(dataSource))
    .useBackgroundJobServer()
    .initialize();

datasources:
  default:
    url: jdbc:mysql://localhost:3306/mydb
    username: myuser
    password: mypassword
    driver-class-name: com.mysql.cj.jdbc.Driver

quarkus.datasource.db-kind=mysql
quarkus.datasource.jdbc.url=jdbc:mysql://localhost:3306/mydb
quarkus.datasource.username=myuser
quarkus.datasource.password=mypassword

spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=myuser
spring.datasource.password=mypassword

By default JobRunr creates its tables automatically. If you want to create them yourself, use the DatabaseCreator or generate the SQL scripts with migration type mysql. See Setting up an SQL database.

Next steps

Keep the tables in their own schema: JobRunr can prefix every table it creates. See table prefix and schema.
Using more than one database? Tell JobRunr which one it should use. See multiple databases in one application.
Build the StorageProvider yourself: Useful for an explicit table prefix, DatabaseOptions, or a provider JobRunr does not pick up automatically. See configuring the StorageProvider yourself.

Looking for another database? Back to the Storage overview.

Add the driver dependency

Configuration

Creating the tables

Next steps