Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/profunktor/redis4cats
:bookmark: Redis client built on top of Cats Effect, Fs2 and Lettuce
https://github.com/profunktor/redis4cats
cats-effect client effects fs2 lettuce redis scala stream streaming
Last synced: 3 months ago
JSON representation
:bookmark: Redis client built on top of Cats Effect, Fs2 and Lettuce
- Host: GitHub
- URL: https://github.com/profunktor/redis4cats
- Owner: profunktor
- License: apache-2.0
- Created: 2018-06-17T13:00:52.000Z (over 6 years ago)
- Default Branch: series/1.x
- Last Pushed: 2024-10-27T00:13:59.000Z (4 months ago)
- Last Synced: 2024-10-27T01:26:33.422Z (4 months ago)
- Topics: cats-effect, client, effects, fs2, lettuce, redis, scala, stream, streaming
- Language: Scala
- Homepage: https://redis4cats.profunktor.dev/
- Size: 8.36 MB
- Stars: 349
- Watchers: 15
- Forks: 83
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ccamel - profunktor/redis4cats - :bookmark: Redis client built on top of Cats Effect, Fs2 and Lettuce (Scala)
README
redis4cats
==========
[](https://github.com/profunktor/redis4cats/actions)
[](https://gitter.im/profunktor-dev/redis4cats)
[](http://search.maven.org/#search%7Cga%7C1%7Credis4cats-effects) 
[](https://scala-steward.org)
Redis client built on top of [Cats Effect](https://typelevel.org/cats-effect/), [Fs2](http://fs2.io/) and the async Java client [Lettuce](https://lettuce.io/).
### Quick Start
```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(println(x === y)) // true
yield ()
}
```
The API is quite stable and *heavily used in production*. However, binary compatibility is not guaranteed across versions for now.
If you like it, give it a ⭐ ! If you think we could do better, please [let us know](https://gitter.im/profunktor-dev/redis4cats)!
### Versions
The `1.x.x` series is built on Cats Effect 3 whereas the `0.x.x` series is built on Cats Effect 2.
### Dependencies
Add this to your `build.sbt` for the [Effects API](https://redis4cats.profunktor.dev/effects/) (depends on `cats-effect`):
```
libraryDependencies += "dev.profunktor" %% "redis4cats-effects" % Version
```
Add this for the [Streams API](https://redis4cats.profunktor.dev/streams/) (depends on `fs2` and `cats-effect`):
```
libraryDependencies += "dev.profunktor" %% "redis4cats-streams" % Version
```
### Log4cats support
`redis4cats` needs a logger for internal use and provides instances for `log4cats`. It is the recommended logging library:
```
libraryDependencies += "dev.profunktor" %% "redis4cats-log4cats" % Version
```
## Running the tests locally
Start both a single Redis node and a cluster using `docker-compose`:
```bash
> docker-compose up
> sbt +test
```
If you are trying to run cluster mode tests on macOS you might receive host not found errors. As a workaround add
new environment variable in `docker-compose.yml` for `RedisCluster`: `IP=0.0.0.0`
The environment section should look like this:
```
environment:
- INITIAL_PORT=30001
- DEBUG=false
- IP=0.0.0.0
```
## Code of Conduct
See the [Code of Conduct](https://redis4cats.profunktor.dev/CODE_OF_CONDUCT)
## LICENSE
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with
the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
language governing permissions and limitations under the License.