redis4cats

https://profunktor.dev/redis4cats/

Admin

redis4cats is a Redis client built on top of Cats Effect, Fs2, and the async Java client Lettuce for...

Tokens:500

Snippets:8

Trust Score:7.2

Update:6 months ago

Show doc for...

Tokens:

Raw

### Quick Start with Redis4cats

Source: https://profunktor.dev/redis4cats

Basic usage example demonstrating setting and getting keys using the Redis client.

```scala
import cats.effect.*
import cats.implicits.*
import dev.profunktor.redis4cats.Redis
import dev.profunktor.redis4cats.effect.Log.Stdout.given

object QuickStart extends IOApp.Simple:

  val run: IO[Unit] =
    Redis[IO].utf8("redis://localhost").use: redis =>
      for
        _ <- redis.set("foo", "123")
        x <- redis.get("foo")
        _ <- redis.setNx("foo", "should not happen")
        y <- redis.get("foo")
        _ <- IO(assert(x === y))
      yield ()
```

--------------------------------

### Run Tests Locally

Source: https://profunktor.dev/redis4cats

Commands to start the Redis environment and execute tests.

```bash
> docker-compose up
> sbt +test
```

--------------------------------

### Add Redis4cats Dependencies

Source: https://profunktor.dev/redis4cats

Configuration for build.sbt to include Effects, Streams, and Log4cats support.

```sbt
libraryDependencies += "dev.profunktor" %% "redis4cats-effects" % Version
```

```sbt
libraryDependencies += "dev.profunktor" %% "redis4cats-streams" % Version
```

```sbt
libraryDependencies += "dev.profunktor" %% "redis4cats-log4cats" % Version
```

--------------------------------

### Configure RedisCluster Environment

Source: https://profunktor.dev/redis4cats

Environment variable configuration for docker-compose to resolve host issues on macOS.

```yaml
    environment:
      - INITIAL_PORT=30001
      - DEBUG=false
      - IP=0.0.0.0
```

Tokens:

Raw