PostgreSQL

JobRunr stores all background jobs in PostgreSQL through the PostgresStorageProvider. JobRunr is tested against it on every release (container version 15). PostgreSQL is a great default: in doubt, just use postgres.

Add the driver dependency

Add the PostgreSQL JDBC driver to your project. The latest version is on Maven Central.

<dependency>
  <groupId>org.postgresql</groupId>
  <artifactId>postgresql</artifactId>
  <version><!-- latest version --></version>
</dependency>

implementation 'org.postgresql:postgresql' // 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:postgresql://localhost:5432/mydb");
config.setUsername("myuser");
config.setPassword("mypassword");
DataSource dataSource = new HikariDataSource(config);

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

datasources:
  default:
    url: jdbc:postgresql://localhost:5432/mydb
    username: myuser
    password: mypassword
    driver-class-name: org.postgresql.Driver

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

spring.datasource.url=jdbc:postgresql://localhost:5432/mydb
spring.datasource.username=myuser
spring.datasource.password=mypassword

Note

Does your application talk to more than one database, or to more than one DataSource? See Multiple databases in one application to tell JobRunr which one to use.

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