Need help with redis4cats?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

profunktor
217 Stars 51 Forks Apache License 2.0 1.2K Commits 7 Opened issues

Description

:bookmark: Redis client built on top of Cats Effect, Fs2 and Lettuce

Services available

!
?

Need anything else?

Contributors list

redis4cats

CI Status Gitter Chat Maven Central Cats friendly MergifyStatus Scala Steward badge

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

Quick Start

import cats.effect._
import cats.implicits._
import dev.profunktor.redis4cats.Redis
import dev.profunktor.redis4cats.effect.Log.Stdout._

object QuickStart extends IOApp.Simple {

def run: IO[Unit] = Redis[IO].utf8("redis://localhost").use { redis => for { _

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!

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 (depends on
cats-effect
):
libraryDependencies += "dev.profunktor" %% "redis4cats-effects" % Version

Add this for the Streams API (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
:
> docker-compose up
> sbt +test

Code of Conduct

See the 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.