#reconnection #connection #multiplexing #notifications #kubernetes #command #mget

redis-swapplex

Redis multiplexing with reconnection notifications and MGET auto-batching

22 releases (11 breaking)

0.13.0 Nov 16, 2024
0.12.1 May 21, 2024
0.12.0 Mar 24, 2024
0.9.0 Jun 11, 2023
0.1.0 Nov 30, 2021

#517 in Database interfaces

Download history 24/week @ 2024-09-20 9/week @ 2024-09-27 1/week @ 2024-10-04 108/week @ 2024-11-15 7/week @ 2024-11-22 2/week @ 2024-11-29

117 downloads per month
Used in 3 crates

MIT license

26KB
555 lines

redis-swapplex

License Cargo Documentation

Redis multiplexing with reconnection notifications and MGET auto-batching

Why use this instead of redis::aio::ConnectionManager?

  • Error-free reconnection behavior: when a command would otherwise fail as a consequence of the connection being dropped, this library will immediately reconnect and retry when able without producing an otherwise avoidable IoError and with subsequent reconnections debounced 1500ms
  • ENV configuration simplifies kubernetes usage
  • Reconnects can be observed allowing for Redis server-assisted client-side caching using client tracking redirection
  • Integrated MGET auto-batching

ENV Configuration

Composible connection urls are provided by environment variables using env-url with the REDIS prefix:

REDIS_URL=redis://127.0.0.1:6379
# Override env mapping for easy kubernetes config
REDIS_HOST_ENV=MONOLITH_STAGE_REDIS_MASTER_PORT_6379_TCP_ADDR
REDIS_PORT_ENV=MONOLITH_STAGE_REDIS_MASTER_SERVICE_PORT_REDIS

Example

use redis::{AsyncCommands, RedisResult};
use redis_swapplex::get_connection;

async fn get_value(key: &str) -> RedisResult<String> {
  let mut conn = get_connection();
  conn.get(key).await
}

Runtime Configuration (optional)

For best performance, use the Tokio runtime as configured via the tokio::main or tokio::test macro with the crate attribute set to async_local while the barrier-protected-runtime feature is enabled on async-local. Doing so configures the Tokio runtime with a barrier that rendezvous runtime worker threads during shutdown in a way that ensures tasks never outlive thread local data owned by runtime worker threads and obviates the need for Box::leak as a means of lifetime extension.

Dependencies

~9–38MB
~574K SLoC