SQL Server

Use Microsoft SQL Server as the JobRunr StorageProvider - driver dependency, configuration, and table creation.

On this page

JobRunr stores all background jobs in Microsoft SQL Server through the SQLServerStorageProvider. JobRunr is tested against the latest mcr.microsoft.com/azure-sql-edge container (a drop-in replacement for mcr.microsoft.com/mssql/server).

Add the driver dependency

Add the Microsoft SQL Server JDBC driver to your project. The latest version is on Maven Central.

<dependency>
  <groupId>com.microsoft.sqlserver</groupId>
  <artifactId>mssql-jdbc</artifactId>
  <version><!-- latest version --></version>
</dependency>

implementation 'com.microsoft.sqlserver:mssql-jdbc' // 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:sqlserver://localhost:1433;databaseName=mydb");
config.setUsername("myuser");
config.setPassword("mypassword");
DataSource dataSource = new HikariDataSource(config);

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

datasources:
  default:
    url: jdbc:sqlserver://localhost:1433;databaseName=mydb
    username: myuser
    password: mypassword
    driver-class-name: com.microsoft.sqlserver.jdbc.SQLServerDriver

quarkus.datasource.db-kind=mssql
quarkus.datasource.jdbc.url=jdbc:sqlserver://localhost:1433;databaseName=mydb
quarkus.datasource.username=myuser
quarkus.datasource.password=mypassword

spring.datasource.url=jdbc:sqlserver://localhost:1433;databaseName=mydb
spring.datasource.username=myuser
spring.datasource.password=mypassword

Creating the tables

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 sqlserver. 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.