redis-utils/com.pambrose.common.redis/RedisUtils

RedisUtils

Factory methods and extension functions for creating and using Redis connections via Jedis.

Pool sizing and wait time can be configured via system properties or method parameters. The default Redis URL is read from the REDIS_URL environment variable.

A URL without a port uses 6379. A URL that can never work (one that is malformed, has no host, or carries a non-numeric database index or an unknown protocol) is a configuration error: every function that takes a URL throws IllegalArgumentException for it, rather than treating it as a connection failure.

Properties

REDIS_MAX_IDLE_SIZE

const val REDIS_MAX_IDLE_SIZE: String

System property key for the maximum number of idle connections.

REDIS_MAX_POOL_SIZE

const val REDIS_MAX_POOL_SIZE: String

System property key for the maximum connection pool size.

REDIS_MAX_WAIT_SECS

const val REDIS_MAX_WAIT_SECS: String

System property key for the maximum wait time (in seconds) when borrowing a connection.

REDIS_MIN_IDLE_SIZE

const val REDIS_MIN_IDLE_SIZE: String

System property key for the minimum number of idle connections.

UNLIMITED_POOL_SIZE

const val UNLIMITED_POOL_SIZE: Int

Pool size meaning "no limit", as defined by commons-pool2.

Functions

newRedisClient

fun newRedisClient(redisUrl: String = defaultRedisUrl, maxPoolSize: Int = System.getProperty(REDIS_MAX_POOL_SIZE)?.toInt() ?: 10, maxIdleSize: Int = System.getProperty(REDIS_MAX_IDLE_SIZE)?.toInt() ?: 5, minIdleSize: Int = System.getProperty(REDIS_MIN_IDLE_SIZE)?.toInt() ?: 1, maxWaitSecs: Long = System.getProperty(REDIS_MAX_WAIT_SECS)?.toLong() ?: 1L): RedisClient

Creates a new pooled RedisClient with the given configuration.

scanKeys

fun UnifiedJedis.scanKeys(pattern: String, count: Int = 100): Sequence<String>

Lazily scans Redis keys matching the given pattern using the SCAN command.

withNonNullRedis

fun <T> withNonNullRedis(redisUrl: String = defaultRedisUrl, printStackTrace: Boolean = false, block: (RedisClient) -> T): T?

Creates a short-lived RedisClient connection, executes block with a non-null client, and closes it.

withNonNullRedisPool

fun <T> RedisClient.withNonNullRedisPool(printStackTrace: Boolean = false, block: (RedisClient) -> T): T?

Executes block with this RedisClient, returning null if the connection fails.

withRedis

fun <T> withRedis(redisUrl: String = defaultRedisUrl, printStackTrace: Boolean = false, block: (RedisClient?) -> T): T

Creates a short-lived RedisClient connection, executes block, and closes the client.

withRedisPool

fun <T> RedisClient.withRedisPool(printStackTrace: Boolean = false, block: (RedisClient?) -> T): T

Executes block with this RedisClient, passing null if the connection fails.

withSuspendingNonNullRedis

suspend fun <T> withSuspendingNonNullRedis(redisUrl: String = defaultRedisUrl, printStackTrace: Boolean = false, block: suspend (RedisClient) -> T): T?

Suspending variant of withNonNullRedis. Creates a short-lived connection, executes a suspending block, and closes it. Returns null if the connection fails. Connecting, pinging and closing run on Dispatchers.IO; block runs in the caller's context.

withSuspendingNonNullRedisPool

suspend fun <T> RedisClient.withSuspendingNonNullRedisPool(printStackTrace: Boolean = false, block: suspend (RedisClient) -> T): T?

Suspending variant of withNonNullRedisPool. Executes a suspending block with this RedisClient, returning null if the connection fails.

withSuspendingRedis

suspend fun <T> withSuspendingRedis(redisUrl: String = defaultRedisUrl, printStackTrace: Boolean = false, block: suspend (RedisClient?) -> T): T

Suspending variant of withRedis. Creates a short-lived connection, executes a suspending block, and closes it.

withSuspendingRedisPool

suspend fun <T> RedisClient.withSuspendingRedisPool(printStackTrace: Boolean = false, block: suspend (RedisClient?) -> T): T

Suspending variant of withRedisPool. Executes a suspending block with this RedisClient, passing null if the connection fails.